SHOGUN  v3.0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CSplittingStrategy Class Referenceabstract

Detailed Description

Abstract base class for all splitting types. Takes a CLabels instance and generates a desired number of subsets which are being accessed by their indices via the method generate_subset_indices(...).

When being extended, the abstract method build_subsets() has to be implemented. build_subsets implementations HAVE TO call reset_subsets before, in order to allow calling them from the outside. Also they HAVE to set the m_is_filled flag to true (otherwise there will be an error when accessing the index sets)

Implementations have to (re)fill the CDynamicArray<index_t> elements in the (inherited) m_subset_indices variable. Note that these elements are already created by the constructor of this class - they just have to be filled. Every element represents one index subset.

Calling the method agains means that the indices are rebuilt.

Definition at line 40 of file SplittingStrategy.h.

Inheritance diagram for CSplittingStrategy:
Inheritance graph
[legend]

Public Member Functions

 CSplittingStrategy ()
 
 CSplittingStrategy (CLabels *labels, index_t num_subsets)
 
virtual ~CSplittingStrategy ()
 
SGVector< index_t > generate_subset_indices (index_t subset_idx)
 
SGVector< index_t > generate_subset_inverse (index_t subset_idx)
 
index_t get_num_subsets () const
 
virtual void build_subsets ()=0
 
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 ()
 
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 ()
 
void unset_generic ()
 
virtual void print_serializable (const char *prefix="")
 
virtual bool save_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_version_parameter())
 
virtual bool load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_version_parameter())
 
DynArray< TParameter * > * load_file_parameters (const SGParamInfo *param_info, int32_t file_version, CSerializableFile *file, const char *prefix="")
 
DynArray< TParameter * > * load_all_file_parameters (int32_t file_version, int32_t current_version, CSerializableFile *file, const char *prefix="")
 
void map_parameters (DynArray< TParameter * > *param_base, int32_t &base_version, DynArray< const SGParamInfo * > *target_param_infos)
 
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 bool update_parameter_hash ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0)
 
virtual CSGObject * clone ()
 

Public Attributes

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

Protected Member Functions

void reset_subsets ()
 
virtual TParameter * migrate (DynArray< TParameter * > *param_base, const SGParamInfo *target)
 
virtual void one_to_one_migration_prepare (DynArray< TParameter * > *param_base, const SGParamInfo *target, TParameter *&replacement, TParameter *&to_migrate, char *old_name=NULL)
 
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)
 

Protected Attributes

CLabels * m_labels
 
CDynamicObjectArray * m_subset_indices
 
index_t m_num_subsets
 
bool m_is_filled
 

Constructor & Destructor Documentation

CSplittingStrategy ( )

constructor

Definition at line 16 of file SplittingStrategy.cpp.

CSplittingStrategy ( CLabels *  labels,
index_t  num_subsets 
)

constructor

Parameters
labelslabels to be (possibly) used for splitting
num_subsetsdesired number of subsets, the labels are split into

Definition at line 21 of file SplittingStrategy.cpp.

~CSplittingStrategy ( )
virtual

destructor

Definition at line 70 of file SplittingStrategy.cpp.

Member Function Documentation

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

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 1195 of file SGObject.cpp.

virtual void build_subsets ( )
pure virtual

Abstract method. Has to refill the elements of the m_subset_indices variable with concrete indices. Note that CDynamicArray<index_t> instances for every subset are created in the constructor of this class - they just have to be filled.

Implemented in CStratifiedCrossValidationSplitting, and CCrossValidationSplitting.

CSGObject * clone ( )
virtualinherited

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 1312 of file SGObject.cpp.

virtual CSGObject* deep_copy ( ) const
virtualinherited

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

Definition at line 159 of file SGObject.h.

bool equals ( CSGObject *  other,
float64_t  accuracy = 0.0 
)
virtualinherited

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)
Returns
true if all parameters were equal, false if not

Definition at line 1216 of file SGObject.cpp.

SGVector< index_t > generate_subset_indices ( index_t  subset_idx)

generates a newly created SGVector<index_t> with indices of the subset with the desired index

Parameters
subset_idxsubset index of the to be generated vector indices
Returns
newly created vector of subset indices of the specified subset is written here.

Error if there are no index sets

Definition at line 76 of file SplittingStrategy.cpp.

SGVector< index_t > generate_subset_inverse ( index_t  subset_idx)

generates a newly created SGVector<index_t> with inverse indices of the subset with the desired index. inverse here means all other indices.

Parameters
subset_idxsubset index of the to be generated inverse indices
Returns
newly created vector of the subset's inverse indices is written here.

Error if there are no index sets

Definition at line 100 of file SplittingStrategy.cpp.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 213 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 248 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 261 of file SGObject.cpp.

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

Definition at line 1099 of file SGObject.cpp.

char * get_modsel_param_descr ( const char *  param_name)
inherited

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 1123 of file SGObject.cpp.

index_t get_modsel_param_index ( const char *  param_name)
inherited

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 1136 of file SGObject.cpp.

virtual const char* get_name ( ) const
pure virtualinherited

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

index_t get_num_subsets ( ) const
Returns
number of subsets.

Definition at line 128 of file SplittingStrategy.cpp.

bool is_generic ( EPrimitiveType *  generic) const
virtualinherited

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 267 of file SGObject.cpp.

DynArray< TParameter * > * load_all_file_parameters ( int32_t  file_version,
int32_t  current_version,
CSerializableFile *  file,
const char *  prefix = "" 
)
inherited

maps all parameters of this instance to the provided file version and loads all parameter data from the file into an array, which is sorted (basically calls load_file_parameter(...) for all parameters and puts all results into a sorted array)

Parameters
file_versionparameter version of the file
current_versionversion from which mapping begins (you want to use Version::get_version_parameter() for this in most cases)
filefile to load from
prefixprefix for members
Returns
(sorted) array of created TParameter instances with file data

Definition at line 672 of file SGObject.cpp.

DynArray< TParameter * > * load_file_parameters ( const SGParamInfo *  param_info,
int32_t  file_version,
CSerializableFile *  file,
const char *  prefix = "" 
)
inherited

loads some specified parameters from a file with a specified version The provided parameter info has a version which is recursively mapped until the file parameter version is reached. Note that there may be possibly multiple parameters in the mapping, therefore, a set of TParameter instances is returned

Parameters
param_infoinformation of parameter
file_versionparameter version of the file, must be <= provided parameter version
filefile to load from
prefixprefix for members
Returns
new array with TParameter instances with the attached data

Definition at line 513 of file SGObject.cpp.

bool load_serializable ( CSerializableFile *  file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
virtualinherited

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
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Definition at line 344 of file SGObject.cpp.

void load_serializable_post ( )
throw (ShogunException
)
protectedvirtualinherited

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 occurres.

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

Definition at line 1028 of file SGObject.cpp.

void load_serializable_pre ( )
throw (ShogunException
)
protectedvirtualinherited

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 occurres.

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

Definition at line 1023 of file SGObject.cpp.

void map_parameters ( DynArray< TParameter * > *  param_base,
int32_t &  base_version,
DynArray< const SGParamInfo * > *  target_param_infos 
)
inherited

Takes a set of TParameter instances (base) with a certain version and a set of target parameter infos and recursively maps the base level wise to the current version using CSGObject::migrate(...). The base is replaced. After this call, the base version containing parameters should be of same version/type as the initial target parameter infos. Note for this to work, the migrate methods and all the internal parameter mappings have to match

Parameters
param_baseset of TParameter instances that are mapped to the provided target parameter infos
base_versionversion of the parameter base
target_param_infosset of SGParamInfo instances that specify the target parameter base

Definition at line 710 of file SGObject.cpp.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo *  target 
)
protectedvirtualinherited

creates a new TParameter instance, which contains migrated data from the version that is provided. The provided parameter data base is used for migration, this base is a collection of all parameter data of the previous version. Migration is done FROM the data in param_base TO the provided param info Migration is always one version step. Method has to be implemented in subclasses, if no match is found, base method has to be called.

If there is an element in the param_base which equals the target, a copy of the element is returned. This represents the case when nothing has changed and therefore, the migrate method is not overloaded in a subclass

Parameters
param_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
Returns
a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

Definition at line 917 of file SGObject.cpp.

void one_to_one_migration_prepare ( DynArray< TParameter * > *  param_base,
const SGParamInfo *  target,
TParameter *&  replacement,
TParameter *&  to_migrate,
char *  old_name = NULL 
)
protectedvirtualinherited

This method prepares everything for a one-to-one parameter migration. One to one here means that only ONE element of the parameter base is needed for the migration (the one with the same name as the target). Data is allocated for the target (in the type as provided in the target SGParamInfo), and a corresponding new TParameter instance is written to replacement. The to_migrate pointer points to the single needed TParameter instance needed for migration. If a name change happened, the old name may be specified by old_name. In addition, the m_delete_data flag of to_migrate is set to true. So if you want to migrate data, the only thing to do after this call is converting the data in the m_parameter fields. If unsure how to use - have a look into an example for this. (base_migration_type_conversion.cpp for example)

Parameters
param_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
replacement(used as output) here the TParameter instance which is returned by migration is created into
to_migratethe only source that is used for migration
old_namewith this parameter, a name change may be specified

Definition at line 857 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 1075 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 279 of file SGObject.cpp.

void reset_subsets ( )
protected

resets the current subsets, meaning that all the arrays of indices will be empty again. To be called before build_subsets.

Definition at line 40 of file SplittingStrategy.cpp.

bool save_serializable ( CSerializableFile *  file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
virtualinherited

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
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Definition at line 285 of file SGObject.cpp.

void save_serializable_post ( )
throw (ShogunException
)
protectedvirtualinherited

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 occurres.

Reimplemented in CKernel.

Definition at line 1038 of file SGObject.cpp.

void save_serializable_pre ( )
throw (ShogunException
)
protectedvirtualinherited

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 occurres.

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

Definition at line 1033 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 40 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 45 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 50 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 55 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 60 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 65 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 70 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 75 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 80 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 85 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 90 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 95 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 100 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 105 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 110 of file SGObject.cpp.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO *  io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 206 of file SGObject.cpp.

void set_global_parallel ( Parallel *  parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 219 of file SGObject.cpp.

void set_global_version ( Version *  version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 254 of file SGObject.cpp.

virtual CSGObject* shallow_copy ( ) const
virtualinherited

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

Reimplemented in CGaussianKernel.

Definition at line 150 of file SGObject.h.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 274 of file SGObject.cpp.

bool update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination.

Returns
bool if parameter combination has changed since last update.

Definition at line 226 of file SGObject.cpp.

Member Data Documentation

SGIO* io
inherited

io

Definition at line 513 of file SGObject.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 528 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 534 of file SGObject.h.

bool m_is_filled
protected

flag to check whether there is a set of index sets stored. If not, call build_subsets()

Definition at line 110 of file SplittingStrategy.h.

CLabels* m_labels
protected

labels

Definition at line 100 of file SplittingStrategy.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 525 of file SGObject.h.

index_t m_num_subsets
protected

additional variable to store number of index subsets

Definition at line 106 of file SplittingStrategy.h.

ParameterMap* m_parameter_map
inherited

map for different parameter versions

Definition at line 531 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 522 of file SGObject.h.

CDynamicObjectArray* m_subset_indices
protected

subset indices

Definition at line 103 of file SplittingStrategy.h.

Parallel* parallel
inherited

parallel

Definition at line 516 of file SGObject.h.

Version* version
inherited

version

Definition at line 519 of file SGObject.h.

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