SHOGUN  4.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions
CSGObject Class Referenceabstract

Detailed Description

Class SGObject is the base class of all shogun objects.

Apart from dealing with reference counting that is used to manage shogung objects in memory (erase unused object, avoid cleaning objects when they are still in use), it provides interfaces for:

  1. parallel - to determine the number of used CPUs for a method (cf. Parallel)
  2. io - to output messages and general i/o (cf. IO)
  3. version - to provide version information of the shogun version used (cf. Version)

All objects can be cloned and compared (deep copy, recursively)

Definition at line 112 of file SGObject.h.

Inherited by CCache< char >, CCache< float64_t >, CCache< KERNELCACHE_ELEM >, CCache< shogun::SGSparseVectorEntry< float64_t > >, CCache< shogun::SGSparseVectorEntry< ST > >, CCache< shogun::SGSparseVectorEntry< T > >, CCache< ST >, CCache< uint16_t >, CCache< uint32_t >, CCache< uint8_t >, CDynamicArray< bool >, CDynamicArray< char >, CDynamicArray< float32_t >, CDynamicArray< float64_t >, CDynamicArray< int32_t >, CEMBase< MixModelData >, CLinearOperator< complex128_t >, CLinearOperator< float64_t >, CLinearSolver< complex128_t, float64_t >, CLinearSolver< float64_t, float64_t >, CLinearSolver< T, T >, CMap< shogun::TParameter *, shogun::CSGObject * >, CMap< shogun::TParameter *, shogun::SGVector< float64_t > >, CMap< std::string, float64_t >, CMap< std::string, int32_t >, CMap< std::string, shogun::SGVector< float64_t > >, CMap< std::string, T >, CMemoryMappedFile< ST >, COperatorFunction< float64_t >, CTreeMachineNode< C45TreeNodeData >, CTreeMachineNode< CARTreeNodeData >, CTreeMachineNode< CHAIDTreeNodeData >, CTreeMachineNode< ConditionalProbabilityTreeNodeData >, CTreeMachineNode< id3TreeNodeData >, CTreeMachineNode< NbodyTreeNodeData >, CTreeMachineNode< RelaxedTreeNodeData >, CTreeMachineNode< VwConditionalProbabilityTreeNodeData >, CTrie< DNATrie >, CTrie< POIMTrie >, CAlphabet, CApproxJointDiagonalizer, CBinaryStream< T >, CBitString, CCache< T >, CCircularBuffer, CCombinationRule, CCompressor, CConverter, CCplex, CCrossValidationOutput, CData, CDataGenerator, CDeepBeliefNetwork, CDifferentiableFunction, CDisjointSet, CDistance, CDistribution, CDynamicArray< T >, CDynamicObjectArray, CDynProg, CECOCDecoder, CECOCEncoder, CEigenSolver, CEMBase< T >, CEvaluation, CEvaluationResult, CFactor, CFactorDataSource, CFactorGraph, CFactorGraphDataGenerator, CFactorType, CFeatures, CFile, CFunction, CGCArray< T >, CGMNPLib, CGNPPLib, CGUIClassifier, CGUIConverter, CGUIDistance, CGUIFeatures, CGUIHMM, CGUIKernel, CGUILabels, CGUIMath, CGUIPluginEstimate, CGUIPreprocessor, CGUIStructure, CGUITime, CHash, CHypothesisTest, CIndependentComputationEngine, CIndependentJob, CIndexBlock, CIndexBlockRelation, CIntegration, CIntronList, CIOBuffer, CJacobiEllipticFunctions, CJobResult, CJobResultAggregator, CKernel, CKernelMeanMatching, CKernelNormalizer, CKernelSelection, CLabels, CLabelsFactory, CLatentModel, CLikelihoodModel, CLinearOperator< T >, CLinearSolver< T, ST >, CLineReader, CList, CListElement, CLMNN, CLMNNStatistics, CLogDetEstimator, CLossFunction, CMachine, CMachineEvaluation, CMap< K, T >, CMAPInference, CMAPInferImpl, CMath, CMeanFunction, CMemoryMappedFile< T >, CMinimizerContext, CModelSelection, CModelSelectionParameters, CMulticlassStrategy, CNeuralLayer, CNeuralLayers, CNode, COperatorFunction< T >, CParameterCombination, CParser, CPlifBase, CPlifMatrix, CPreprocessor, CProbabilityDistribution, CQPBSVMLib, CRandom, CRBM, CRejectionStrategy, CResultSet, CSegmentLoss, CSerializableFile, CSerializableFile::TSerializableReader, CSet< T >, CSignal, CSimpleFile< T >, CSOSVMHelper, CSparseInverseCovariance, CSplittingStrategy, CStateModel, CStatistics, CStreamingFile, CStructuredData, CStructuredModel, CSubset, CSubsetStack, CTask, CTaskRelation, CTaxonomy, CTime, CTokenizer, CTraceSampler, CTreeMachineNode< T >, CTrie< Trie >, CVwCacheReader, CVwCacheWriter, CVwEnvironment, CVwLearner, CVwParser, CVwRegressor, and MKLMulticlassOptimizationBase.

Public Member Functions

 CSGObject ()
 
 CSGObject (const CSGObject &orig)
 
virtual ~CSGObject ()
 
virtual CSGObject * shallow_copy () const
 
virtual CSGObject * deep_copy () const
 
virtual const char * get_name () const =0
 
virtual bool is_generic (EPrimitiveType *generic) const
 
template<class T >
void set_generic ()
 
void unset_generic ()
 
virtual void print_serializable (const char *prefix="")
 
virtual bool save_serializable (CSerializableFile *file, const char *prefix="")
 
virtual bool load_serializable (CSerializableFile *file, const char *prefix="")
 
void set_global_io (SGIO *io)
 
SGIO * get_global_io ()
 
void set_global_parallel (Parallel *parallel)
 
Parallel * get_global_parallel ()
 
void set_global_version (Version *version)
 
Version * get_global_version ()
 
SGStringList< char > get_modelsel_names ()
 
void print_modsel_params ()
 
char * get_modsel_param_descr (const char *param_name)
 
index_t get_modsel_param_index (const char *param_name)
 
void build_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict)
 
virtual void update_parameter_hash ()
 
virtual bool parameter_hash_changed ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)
 
virtual CSGObject * clone ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 

Public Attributes

SGIO * io
 
Parallel * parallel
 
Version * version
 
Parameter * m_parameters
 
Parameter * m_model_selection_parameters
 
Parameter * m_gradient_parameters
 
uint32_t m_hash
 

Protected Member Functions

virtual void load_serializable_pre () throw (ShogunException)
 
virtual void load_serializable_post () throw (ShogunException)
 
virtual void save_serializable_pre () throw (ShogunException)
 
virtual void save_serializable_post () throw (ShogunException)
 

Constructor & Destructor Documentation

CSGObject ( )

default constructor

Definition at line 120 of file SGObject.cpp.

CSGObject ( const CSGObject &  orig)

copy constructor

Definition at line 129 of file SGObject.cpp.

~CSGObject ( )
virtual

destructor

Definition at line 139 of file SGObject.cpp.

Member Function Documentation

void build_gradient_parameter_dictionary ( CMap< TParameter *, CSGObject * > *  dict)

Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.

Parameters
dictdictionary of parameters to be built.

Definition at line 597 of file SGObject.cpp.

CSGObject * clone ( )
virtual

Creates a clone of the current object. This is done via recursively traversing all parameters, which corresponds to a deep copy. Calling equals on the cloned object always returns true although none of the memory of both objects overlaps.

Returns
an identical copy of the given object, which is disjoint in memory. NULL if the clone fails. Note that the returned object is SG_REF'ed

Definition at line 714 of file SGObject.cpp.

CSGObject * deep_copy ( ) const
virtual

A deep copy. All the instance variables will also be copied.

Definition at line 198 of file SGObject.cpp.

bool equals ( CSGObject *  other,
float64_t  accuracy = 0.0,
bool  tolerant = false 
)
virtual

Recursively compares the current SGObject to another one. Compares all registered numerical parameters, recursion upon complex (SGObject) parameters. Does not compare pointers!

May be overwritten but please do with care! Should not be necessary in most cases.

Parameters
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
Returns
true if all parameters were equal, false if not

Definition at line 618 of file SGObject.cpp.

SGIO * get_global_io ( )

get the io object

Returns
io object

Definition at line 235 of file SGObject.cpp.

Parallel * get_global_parallel ( )

get the parallel object

Returns
parallel object

Definition at line 277 of file SGObject.cpp.

Version * get_global_version ( )

get the version object

Returns
version object

Definition at line 290 of file SGObject.cpp.

SGStringList< char > get_modelsel_names ( )
Returns
vector of names of all parameters which are registered for model selection

Definition at line 498 of file SGObject.cpp.

char * get_modsel_param_descr ( const char *  param_name)

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

Parameters
param_namename of the parameter
Returns
description of the parameter

Definition at line 522 of file SGObject.cpp.

index_t get_modsel_param_index ( const char *  param_name)

Returns index of model selection parameter with provided index

Parameters
param_namename of model selection parameter
Returns
index of model selection parameter with provided name, -1 if there is no such

Definition at line 535 of file SGObject.cpp.

virtual const char* get_name ( ) const
pure virtual

Returns the name of the SGSerializable instance. It MUST BE the CLASS NAME without the prefixed `C'.

Returns
name of the SGSerializable

Implemented in CMath, CHMM, CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, CStringFeatures< uint16_t >, CSVMLight, CTrie< Trie >, CTrie< DNATrie >, CTrie< POIMTrie >, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CMultitaskKernelTreeNormalizer, CList, CDynProg, CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, CStatistics, CFile, CSparseFeatures< ST >, CSparseFeatures< float64_t >, CSparseFeatures< T >, CSpecificityMeasure, CPrecisionMeasure, CPlif, CRecallMeasure, CDynamicObjectArray, CCrossCorrelationMeasure, CCSVFile, CF1Measure, CBinaryFile, CProtobufFile, CLaRank, CWRACCMeasure, CRBM, CTaxonomy, CBALMeasure, CBitString, CStreamingVwFeatures, CLibSVMFile, CStreamingSparseFeatures< T >, CErrorRateMeasure, CNeuralLayer, CMultitaskKernelPlifNormalizer, CWDSVMOcas, CMachine, CAccuracyMeasure, CStreamingFile, CQuadraticTimeMMD, CRandom, CStreamingMMD, CMemoryMappedFile< T >, CMultitaskKernelMaskNormalizer, CMemoryMappedFile< ST >, CAlphabet, CMKL, CLMNNStatistics, CStructuredModel, CStreamingDenseFeatures< T >, CStreamingDenseFeatures< float64_t >, CStreamingDenseFeatures< float32_t >, CCombinedDotFeatures, CFeatureSelection< ST >, CFeatureSelection< float64_t >, CGUIStructure, CCache< T >, CCache< uint32_t >, CCache< ST >, CCache< float64_t >, CCache< uint8_t >, CCache< KERNELCACHE_ELEM >, CCache< char >, CCache< uint16_t >, CCache< shogun::SGSparseVectorEntry< T > >, CCache< shogun::SGSparseVectorEntry< float64_t > >, CCache< shogun::SGSparseVectorEntry< ST > >, CMultitaskKernelMaskPairNormalizer, CSVM, CNeuralNetwork, CMultitaskKernelNormalizer, CGUIClassifier, CGaussian, CGUIFeatures, CGMM, CHashedWDFeaturesTransposed, CBinaryStream< T >, CLinearHMM, CSimpleFile< T >, CDeepBeliefNetwork, CStreamingStringFeatures< T >, CParameterCombination, CNeuralLinearLayer, CStateModel, CMulticlassSVM, CNeuralConvolutionalLayer, CRandomKitchenSinksDotFeatures, COnlineLinearMachine, CVwParser, CPluginEstimate, CVowpalWabbit, CBinnedDotFeatures, CSVMOcas, CSVRLight, CPlifMatrix, CHashedWDFeatures, CCrossValidation, CImplicitWeightedSpecFeatures, CCombinedFeatures, CSparseMatrixOperator< T >, CSNPFeatures, CWDFeatures, CKMeans, CCrossValidationMulticlassStorage, CHashedDenseFeatures< ST >, CIOBuffer, CUAIFile, CTwoStateModel, CLossFunction, CPCA, CHMSVMModel, CDeepAutoencoder, CLeastAngleRegression, CGUIKernel, CKNN, CHashedSparseFeatures< ST >, CRandomFourierGaussPreproc, CMKLMulticlass, CAutoencoder, CHypothesisTest, CExplicitSpecFeatures, CLibLinearMTL, CModelSelectionParameters, CNOCCO, CPositionalPWM, CHashedDocDotFeatures, CGUIHMM, COnlineSVMSGD, CIntegration, CLibLinear, CJacobiEllipticFunctions, CLDA, CZeroMeanCenterKernelNormalizer, CSparsePolyFeatures, CHashedMultilabelModel, CSqrtDiagKernelNormalizer, CHuberLoss, CCplex, CScatterKernelNormalizer, CFisherLDA, CHSIC, CStochasticProximityEmbedding, CLatentModel, CRationalApproximation, CTableFactorType, CSVMSGD, CMulticlassMachine, CDixonQTestRejectionStrategy, CGMNPLib, CVwCacheReader, CLBPPyrDotFeatures, CRidgeKernelNormalizer, CDependenceMaximization, CLinearMachine, CMulticlassSOLabels, CGraphCut, CSerializableAsciiFile, CSGDQN, CSNPStringKernel, CTime, CMatrixFeatures< ST >, CWeightedCommWordStringKernel, CHingeLoss, CNeuralLayers, CTwoSampleTest, CSquaredLoss, CAbsoluteDeviationLoss, CExponentialLoss, CCustomKernel, CMulticlassLabels, CHash, CFactor, CPlifArray, CLinearTimeMMD, CQPBSVMLib, CStreamingHashedDocDotFeatures, CStreamingVwFile, CKernelIndependenceTest, CCustomDistance, CWeightedDegreeStringKernel, CKernelRidgeRegression, CBaggingMachine, CQDA, CNeuralLogisticLayer, CNeuralRectifiedLinearLayer, CTOPFeatures, CDiceKernelNormalizer, CHierarchicalMultilabelModel, CMultitaskKernelMklNormalizer, CTask, CGaussianProcessClassification, CVwEnvironment, CBinaryLabels, CMultilabelModel, CMultilabelSOLabels, CDomainAdaptationSVMLinear, CDotKernel, CCHAIDTree, CKernelTwoSampleTest, CMAPInferImpl, CWeightedDegreePositionStringKernel, CGaussianDistribution, CTanimotoKernelNormalizer, CCircularBuffer, CMCLDA, CStreamingHashedDenseFeatures< ST >, CStreamingHashedSparseFeatures< ST >, CBesselKernel, CAvgDiagKernelNormalizer, CVarianceKernelNormalizer, CMulticlassModel, COnlineLibLinear, CIndexFeatures, CCARTree, CStreamingAsciiFile, CIndependenceTest, CHierarchical, CFKFeatures, CCombinedKernel, CSparseSpatialSampleStringKernel, CSpectrumMismatchRBFKernel, COperatorFunction< T >, CMultilabelCLRModel, COperatorFunction< float64_t >, CVwRegressor, CHashedDocConverter, CFactorGraphLabels, CKLInferenceMethod, CGaussianKernel, CCommWordStringKernel, CSubsequenceStringKernel, CSet< T >, CSparseInferenceBase, CDataGenerator, CNeuralInputLayer, CSequenceLabels, CPolyFeatures, CNode, CContingencyTableEvaluation, CChi2Kernel, CPyramidChi2, CSignal, CDenseMatrixOperator< T >, CLibSVR, CDenseMatrixOperator< float64_t >, CPeriodicKernel, CSalzbergWordStringKernel, CStructuredLabels, CSquaredHingeLoss, CNewtonSVM, CKLApproxDiagonalInferenceMethod, CLPBoost, CVwLearner, CIndexBlockTree, CExactInferenceMethod, CKLCholeskyInferenceMethod, CKLCovarianceInferenceMethod, CCommUlongStringKernel, CCompressor, CSingleFITCLaplacianBase, CIterativeLinearSolver< T, ST >, CIterativeLinearSolver< float64_t, float64_t >, CIterativeLinearSolver< complex128_t, float64_t >, CIterativeLinearSolver< T, T >, CSVMLin, CHistogram, CGaussianShiftKernel, CGCArray< T >, CMultiLaplacianInferenceMethod, CNeuralSoftmaxLayer, CHomogeneousKernelMap, CLocallyLinearEmbedding, CMahalanobisDistance, CAttributeFeatures, CRandomFourierDotFeatures, CFirstElementKernelNormalizer, CMap< K, T >, CLogLoss, CLogLossMargin, CSmoothHingeLoss, CSoftMaxLikelihood, CMap< shogun::TParameter *, shogun::SGVector< float64_t > >, CMap< shogun::TParameter *, shogun::CSGObject * >, CMap< std::string, int32_t >, CMap< std::string, shogun::SGVector< float64_t > >, CMap< std::string, T >, CMap< std::string, float64_t >, CVwNativeCacheReader, CDistanceKernel, CLatentLabels, CKLLowerTriangularInferenceMethod, CScatterSVM, CSpectrumRBFKernel, CMultilabelLabels, CSingleLaplacianInferenceMethodWithLBFGS, CMMDKernelSelection, CSegmentLoss, CKernelDistance, CLogDetEstimator, CLinearRidgeRegression, CGNPPLib, CStreamingFileFromFeatures, CPolyMatchStringKernel, CNeuralLeakyRectifiedLinearLayer, CDomainAdaptationSVM, COligoStringKernel, CSimpleLocalityImprovedStringKernel, CKLDualInferenceMethod, CKernelSelection, CStreamingVwCacheFile, CCircularKernel, CConstKernel, CDiagKernel, CExponentialARDKernel, CSphericalKernel, CLogitDVGLikelihood, CSingleFITCLaplacianInferenceMethod, CSingleFITCLaplacianInferenceMethodWithLBFGS, CEigenSolver, CC45ClassifierTree, CLPM, CEmbeddingConverter, CEuclideanDistance, CWeightedMajorityVote, CMulticlassOVREvaluation, CPolyKernel, CPolyMatchWordStringKernel, CID3ClassifierTree, CMultitaskClusteredLogisticRegression, CMultidimensionalScaling, CANOVAKernel, CProductKernel, CSparseKernel< ST >, CGaussianMatchStringKernel, CRandomForest, CLanczosEigenSolver, CKernelPCA, CNearestCentroid, CStreamingFileFromDenseFeatures< T >, CStreamingFileFromSparseFeatures< T >, CStreamingFileFromStringFeatures< T >, CFixedDegreeStringKernel, CStringKernel< ST >, CTensorProductPairKernel, CGaussianNaiveBayes, CStringKernel< uint16_t >, CStringKernel< char >, CStringKernel< uint64_t >, CKernelDensity, CParser, CTStudentKernel, CWaveletKernel, CTraceSampler, CMulticlassOneVsRestStrategy, CGaussianProcessRegression, CGEMPLP, CDiffusionMaps, CMinkowskiMetric, CExponentialKernel, CEPInferenceMethod, CLaplacianEigenmaps, CAttenuatedEuclideanDistance, CCauchyKernel, CLogKernel, CPowerKernel, CRationalQuadraticKernel, CWaveKernel, CLaplacianInferenceBase, CDistantSegmentsKernel, CLocalityImprovedStringKernel, CMatchWordStringKernel, CRegulatoryModulesStringKernel, CKernelMachine, CBAHSIC, MKLMulticlassGradient, CAUCKernel, CHistogramIntersectionKernel, CSigmoidKernel, CDistanceMachine, CGaussianProcessMachine, CFITCInferenceMethod, CSparseVGInferenceMethod, CStructuredOutputMachine, CKernelDependenceMaximization, CGaussianARDKernel, CInverseMultiQuadricKernel, CFFDiag, CJADiag, CJADiagOrth, CLabelsFactory, CStudentsTLikelihood, CJediDiag, CQDiag, CUWedge, CTreeMachineNode< T >, CLibLinearRegression, CMMDKernelSelectionCombOpt, CTreeMachineNode< ConditionalProbabilityTreeNodeData >, CTreeMachineNode< RelaxedTreeNodeData >, CTreeMachineNode< id3TreeNodeData >, CTreeMachineNode< VwConditionalProbabilityTreeNodeData >, CTreeMachineNode< CARTreeNodeData >, CTreeMachineNode< C45TreeNodeData >, CTreeMachineNode< CHAIDTreeNodeData >, CTreeMachineNode< NbodyTreeNodeData >, CMulticlassAccuracy, CGaussianShortRealKernel, CMultiquadricKernel, CLocalAlignmentStringKernel, CICAConverter, CSplineKernel, CDelimiterTokenizer, CDualVariationalGaussianLikelihood, CLogitVGPiecewiseBoundLikelihood, CDimensionReductionPreprocessor, CPerceptron, CHistogramWordStringKernel, CLogRationalApproximationIndividual, CMultitaskL12LogisticRegression, CTaskTree, CProbabilityDistribution, CConstMean, CGaussianLikelihood, CSingleSparseInferenceBase, CStochasticGBMachine, CMatrixOperator< T >, CTreeMachine< T >, CMultitaskROCEvaluation, CTreeMachine< ConditionalProbabilityTreeNodeData >, CTreeMachine< RelaxedTreeNodeData >, CTreeMachine< id3TreeNodeData >, CTreeMachine< VwConditionalProbabilityTreeNodeData >, CTreeMachine< CARTreeNodeData >, CTreeMachine< C45TreeNodeData >, CTreeMachine< CHAIDTreeNodeData >, CTreeMachine< NbodyTreeNodeData >, CCanberraMetric, CCosineDistance, CManhattanMetric, CJensenShannonKernel, CLinearKernel, CNumericalVGLikelihood, CCGMShiftedFamilySolver, CIterativeShiftedLinearFamilySolver< T, ST >, CLogRationalApproximationCGM, CMMDKernelSelectionCombMaxL2, CDualLibQPBMSOSVM, CIterativeShiftedLinearFamilySolver< float64_t, complex128_t >, CGeodesicMetric, CJensenMetric, CTanimotoDistance, CLineReader, CIdentityKernelNormalizer, CLinearStringKernel, CLinearStructuredOutputMachine, CDecompressString< ST >, CGUIConverter, CIsomap, CNGramTokenizer, CStudentsTVGLikelihood, CMMDKernelSelectionMedian, CChiSquareDistance, CHammingWordDistance, CLogitVGLikelihood, CProbitVGLikelihood, CRandomSearchModelSelection, CGUILabels, MKLMulticlassGLPK, CSOBI, CKernelLocallyLinearEmbedding, CSparseDistance< ST >, CCrossValidationResult, CLatentFeatures, CBinaryTreeMachineNode< T >, CMMDKernelSelectionOpt, CSparseDistance< float64_t >, CAveragedPerceptron, CFFSep, CBrayCurtisDistance, CChebyshewMetric, CFactorGraphFeatures, CRegressionLabels, CNbodyTree, CMinimizerContext, CSparsePreprocessor< ST >, CLeastSquaresRegression, MKLMulticlassOptimizationBase, CVwNativeCacheWriter, CJediSep, CUWedgeSep, CSparseEuclideanDistance, CRealFileFeatures, CJobResultAggregator, CGaussianARDSparseKernel, CSingleLaplacianInferenceMethod, CMulticlassOneVsOneStrategy, CGUIPluginEstimate, CVwAdaptiveLearner, CStringDistance< ST >, CLinearLatentMachine, CDenseMatrixExactLog, CPNorm, CRescaleFeatures, CSparseMultilabel, CStringDistance< uint16_t >, CVwNonAdaptiveLearner, CStructuredAccuracy, CWeightedDegreeRBFKernel, CProbitLikelihood, CECOCRandomSparseEncoder, CMulticlassStrategy, CGradientCriterion, CLatentSVM, CIndependentJob, CGMNPSVM, CLogPlusOne, CMAPInference, CMixtureModel, CFactorGraphObservation, CLogitLikelihood, CNormOne, CLibSVM, CFactorAnalysis, CDenseSubSamplesFeatures< ST >, CStringFileFeatures< ST >, CScalarResult< T >, CDirectLinearSolverComplex, CIndividualJobResultAggregator, CBallTree, CKDTree, CStringPreprocessor< ST >, CMultitaskTraceLogisticRegression, CStringPreprocessor< uint16_t >, CStringPreprocessor< uint64_t >, CFastICA, CCanberraWordDistance, CManhattanWordDistance, CCrossValidationOutput, CLinearMulticlassMachine, CRationalApproximationCGMJob, CECOCDiscriminantEncoder, CRandomCARTree, CSumOne, CResultSet, CTaskGroup, CGUIDistance, CRationalApproximationIndividualJob, CSortWordString, CCCSOSVM, CIntronList, CRealNumber, CJade, CStoreVectorAggregator< T >, CIndexBlock, CIndexBlockGroup, CZeroMean, CConjugateOrthogonalCGSolver, CGradientModelSelection, CPruneVarSubMean, CSequence, CMultitaskLogisticRegression, CGUIPreprocessor, CStoreVectorAggregator< complex128_t >, CMeanSquaredError, CMeanSquaredLogError, CLatentSOSVM, CSortUlongString, CFeatureBlockLogisticRegression, CMeanAbsoluteError, CDummyFeatures, CListElement, CDenseExactLogJob, CMulticlassLibLinear, CDenseDistance< ST >, CRealDistance, CStringMap< T >, CLMNN, CMMDKernelSelectionMax, CDenseDistance< float64_t >, CStringMap< float64_t >, CStringMap< shogun::SGVector< float64_t > >, CStringMap< int32_t >, CSVMLightOneClass, CLinearLocalTangentSpaceAlignment, CNeighborhoodPreservingEmbedding, CEMBase< T >, CEMMixtureModel, CIndependentComputationEngine, CVectorResult< T >, CKernelStructuredOutputMachine, CThresholdRejectionStrategy, CVwConditionalProbabilityTree, CEMBase< MixModelData >, CHessianLocallyLinearEmbedding, CCustomMahalanobisDistance, CCombinationRule, CClusteringAccuracy, CClusteringMutualInformation, CMultilabelAccuracy, CMeanShiftDataGenerator, CMMDKernelSelectionComb, CFactorGraphModel, CLocalTangentSpaceAlignment, CSubsetStack, CStoreScalarAggregator< T >, CConjugateGradientSolver, CGridSearchModelSelection, CStochasticSOSVM, CMultitaskLeastSquaresRegression, CMajorityVote, CLinearOperator< T >, CMultitaskLinearMachine, CLinearOperator< float64_t >, CLinearOperator< complex128_t >, CMeanRule, CLocalityPreservingProjections, CGradientEvaluation, CDirectEigenSolver, CLinearSolver< T, ST >, CMulticlassLibSVM, CMKLRegression, CFactorDataSource, CFactorGraph, CTaskRelation, CLinearSolver< float64_t, float64_t >, CLinearSolver< complex128_t, float64_t >, CLinearSolver< T, T >, CSerialComputationEngine, CIndexBlockRelation, CECOCEncoder, CKernelMeanMatching, CROCEvaluation, CGaussianBlobsDataGenerator, CBalancedConditionalProbabilityTree, CFactorType, CSOSVMHelper, CMKLOneClass, CLibSVMOneClass, CMPDSVM, CGradientResult, CKernelMulticlassMachine, CNormalSampler, CECOCIHDDecoder, CConditionalProbabilityTree, CRelaxedTree, CFWSOSVM, CDomainAdaptationMulticlassLibLinear, CMKLClassification, CGPBTSVM, CSubset, CECOCRandomDenseEncoder, CMulticlassTreeGuidedLogisticRegression, CShareBoost, CGNPPSVM, CDirectSparseLinearSolver, CMulticlassLogisticRegression, CMulticlassOCAS, CFactorGraphDataGenerator, CPRCEvaluation, CStratifiedCrossValidationSplitting, CSparseInverseCovariance, CDisjointSet, CCrossValidationSplitting, CDenseSubsetFeatures< ST >, CECOCForestEncoder, CGUIMath, CGUITime, CTDistributedStochasticNeighborEmbedding, CCrossValidationPrintOutput, CManifoldSculpting, CCrossValidationMKLStorage, SerializableAsciiReader00, CJobResult, CFunction, CECOCAEDDecoder, CECOCDecoder, CECOCEDDecoder, CData, CNativeMulticlassMachine, CECOCStrategy, CConverter, CBaseMulticlassMachine, CECOCSimpleDecoder, CLOOCrossValidationSplitting, CECOCLLBDecoder, CStructuredData, CECOCHDDecoder, CRandomConditionalProbabilityTree, CECOCOVOEncoder, CECOCOVREncoder, and CRejectionStrategy.

bool is_generic ( EPrimitiveType *  generic) const
virtual

If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.

Parameters
genericset to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 296 of file SGObject.cpp.

bool load_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
virtual

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

Parameters
filewhere to load from
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 369 of file SGObject.cpp.

void load_serializable_post ( )
throw (ShogunException
)
protectedvirtual

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.

Definition at line 426 of file SGObject.cpp.

void load_serializable_pre ( )
throw (ShogunException
)
protectedvirtual

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 421 of file SGObject.cpp.

bool parameter_hash_changed ( )
virtual
Returns
whether parameter combination has changed since last update

Definition at line 262 of file SGObject.cpp.

void print_modsel_params ( )

prints all parameter registered for model selection and their type

Definition at line 474 of file SGObject.cpp.

void print_serializable ( const char *  prefix = "")
virtual

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 308 of file SGObject.cpp.

bool save_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
virtual

Save this object to file.

Parameters
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 314 of file SGObject.cpp.

void save_serializable_post ( )
throw (ShogunException
)
protectedvirtual

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 436 of file SGObject.cpp.

void save_serializable_pre ( )
throw (ShogunException
)
protectedvirtual

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 431 of file SGObject.cpp.

void set_generic ( )

Definition at line 41 of file SGObject.cpp.

void set_generic ( )

Definition at line 46 of file SGObject.cpp.

void set_generic ( )

Definition at line 51 of file SGObject.cpp.

void set_generic ( )

Definition at line 56 of file SGObject.cpp.

void set_generic ( )

Definition at line 61 of file SGObject.cpp.

void set_generic ( )

Definition at line 66 of file SGObject.cpp.

void set_generic ( )

Definition at line 71 of file SGObject.cpp.

void set_generic ( )

Definition at line 76 of file SGObject.cpp.

void set_generic ( )

Definition at line 81 of file SGObject.cpp.

void set_generic ( )

Definition at line 86 of file SGObject.cpp.

void set_generic ( )

Definition at line 91 of file SGObject.cpp.

void set_generic ( )

Definition at line 96 of file SGObject.cpp.

void set_generic ( )

Definition at line 101 of file SGObject.cpp.

void set_generic ( )

Definition at line 106 of file SGObject.cpp.

void set_generic ( )

Definition at line 111 of file SGObject.cpp.

void set_generic ( )

set generic type to T

void set_global_io ( SGIO *  io)

set the io object

Parameters
ioio object to use

Definition at line 228 of file SGObject.cpp.

void set_global_parallel ( Parallel *  parallel)

set the parallel object

Parameters
parallelparallel object to use

Definition at line 241 of file SGObject.cpp.

void set_global_version ( Version *  version)

set the version object

Parameters
versionversion object to use

Definition at line 283 of file SGObject.cpp.

CSGObject * shallow_copy ( ) const
virtual

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

Reimplemented in CGaussianKernel.

Definition at line 192 of file SGObject.cpp.

void unset_generic ( )

unset generic type

this has to be called in classes specializing a template class

Definition at line 303 of file SGObject.cpp.

void update_parameter_hash ( )
virtual

Updates the hash of current parameter combination

Definition at line 248 of file SGObject.cpp.

Member Data Documentation

SGIO* io

io

Definition at line 369 of file SGObject.h.

Parameter* m_gradient_parameters

parameters wrt which we can compute gradients

Definition at line 384 of file SGObject.h.

uint32_t m_hash

Hash of parameter values

Definition at line 387 of file SGObject.h.

Parameter* m_model_selection_parameters

model selection parameters

Definition at line 381 of file SGObject.h.

Parameter* m_parameters

parameters

Definition at line 378 of file SGObject.h.

Parallel* parallel

parallel

Definition at line 372 of file SGObject.h.

Version* version

version

Definition at line 375 of file SGObject.h.

The documentation for this class was generated from the following files:
SHOGUN Machine Learning Toolbox - Documentation