Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes

CDistance Class Reference


Detailed Description

Class Distance, a base class for all the distances used in the Shogun toolbox.

The distance (or metric) is a function $ d: X \times X \to R $ satisfying (for all $ x,y,z \in X$) conditions below:

Currently distance inherited from the CDistance class should be symmetric.

The simpliest example of a distance function is the euclidean distance:

See also:
CEuclideanDistance

In the means of Shogun toolbox the distance function is defined on the 'space' of CFeatures.

Definition at line 79 of file Distance.h.

Inheritance diagram for CDistance:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CDistance ()
 CDistance (CFeatures *lhs, CFeatures *rhs)
virtual ~CDistance ()
virtual float64_t distance (int32_t idx_a, int32_t idx_b)
virtual float64_t distance_upper_bounded (int32_t idx_a, int32_t idx_b, float64_t upper_bound)
SGMatrix< float64_tget_distance_matrix ()
virtual float64_tget_distance_matrix_real (int32_t &m, int32_t &n, float64_t *target)
virtual float32_tget_distance_matrix_shortreal (int32_t &m, int32_t &n, float32_t *target)
virtual bool init (CFeatures *lhs, CFeatures *rhs)
virtual void cleanup ()=0
void load (CFile *loader)
void save (CFile *writer)
CFeaturesget_lhs ()
CFeaturesget_rhs ()
CFeaturesreplace_rhs (CFeatures *rhs)
CFeaturesreplace_lhs (CFeatures *lhs)
virtual void remove_lhs_and_rhs ()
virtual void remove_lhs ()
 takes all necessary steps if the lhs is removed from distance matrix
virtual void remove_rhs ()
 takes all necessary steps if the rhs is removed from distance matrix
virtual EDistanceType get_distance_type ()=0
virtual EFeatureType get_feature_type ()=0
virtual EFeatureClass get_feature_class ()=0
bool get_precompute_matrix ()
virtual void set_precompute_matrix (bool flag)
virtual int32_t get_num_vec_lhs ()
virtual int32_t get_num_vec_rhs ()
virtual bool has_features ()
bool lhs_equals_rhs ()
virtual CSGObjectshallow_copy () const
virtual CSGObjectdeep_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="", int32_t param_version=VERSION_PARAMETER)
virtual bool load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=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)
SGIOget_global_io ()
void set_global_parallel (Parallel *parallel)
Parallelget_global_parallel ()
void set_global_version (Version *version)
Versionget_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_parameter_dictionary (CMap< TParameter *, CSGObject * > &dict)

Public Attributes

SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
ParameterMapm_parameter_map
uint32_t m_hash

Protected Member Functions

virtual float64_t compute (int32_t x, int32_t y)=0
void do_precompute_matrix ()
 matrix precomputation
virtual TParametermigrate (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)
virtual bool update_parameter_hash ()

Static Protected Member Functions

static void * run_distance_thread (void *p)
 run distance thread

Protected Attributes

float32_tprecomputed_matrix
bool precompute_matrix
CFeatureslhs
 feature vectors to occur on the left hand side
CFeaturesrhs
 feature vectors to occur on the right hand side
int32_t num_lhs
int32_t num_rhs

Constructor & Destructor Documentation

CDistance (  ) 

default constructor

Definition at line 56 of file Distance.cpp.

CDistance ( CFeatures lhs,
CFeatures rhs 
)

init distance

Parameters:
lhs features of left-hand side
rhs features of right-hand side
Returns:
if init was successful

Definition at line 62 of file Distance.cpp.

~CDistance (  )  [virtual]

Definition at line 68 of file Distance.cpp.


Member Function Documentation

void build_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:
dict dictionary of parameters to be built.

Definition at line 1201 of file SGObject.cpp.

virtual void cleanup (  )  [pure virtual]
virtual float64_t compute ( int32_t  x,
int32_t  y 
) [protected, pure virtual]
virtual CSGObject* deep_copy (  )  const [virtual, inherited]

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

Definition at line 131 of file SGObject.h.

virtual float64_t distance ( int32_t  idx_a,
int32_t  idx_b 
) [virtual]

get distance function for lhs feature vector a and rhs feature vector b

Parameters:
idx_a feature vector a at idx_a
idx_b feature vector b at idx_b
Returns:
distance value

Definition at line 101 of file Distance.h.

virtual float64_t distance_upper_bounded ( int32_t  idx_a,
int32_t  idx_b,
float64_t  upper_bound 
) [virtual]

get distance function for lhs feature vector a and rhs feature vector b. The computation of the distance stops if the intermediate result is larger than upper_bound. This is useful to use with John Langford's Cover Tree and it is ONLY implemented for Euclidean distance

Parameters:
idx_a feature vector a at idx_a
idx_b feature vector b at idx_b
upper_bound value above which the computation halts
Returns:
distance value or upper_bound

Reimplemented in CEuclideanDistance.

Definition at line 150 of file Distance.h.

void do_precompute_matrix (  )  [protected]

matrix precomputation

Definition at line 187 of file Distance.cpp.

SGMatrix< float64_t > get_distance_matrix (  ) 

get distance matrix

Returns:
computed distance matrix (needs to be cleaned up)

Definition at line 211 of file Distance.cpp.

float64_t * get_distance_matrix_real ( int32_t &  m,
int32_t &  n,
float64_t target 
) [virtual]

get distance matrix real

Parameters:
m dimension m
n dimension n
target target matrix
Returns:
target matrix

Definition at line 287 of file Distance.cpp.

float32_t * get_distance_matrix_shortreal ( int32_t &  m,
int32_t &  n,
float32_t target 
) [virtual]

get distance matrix short real

Parameters:
m dimension m
n dimension n
target target matrix
Returns:
target matrix

Definition at line 218 of file Distance.cpp.

virtual EDistanceType get_distance_type (  )  [pure virtual]
virtual EFeatureClass get_feature_class (  )  [pure virtual]

get feature class the distance can deal with

abstract base method

Returns:
feature class

Implemented in CCustomDistance, CDenseDistance< ST >, CKernelDistance, CSparseDistance< ST >, CStringDistance< ST >, CDenseDistance< float64_t >, CSparseDistance< float64_t >, and CStringDistance< uint16_t >.

virtual EFeatureType get_feature_type (  )  [pure virtual]
SGIO * get_global_io (  )  [inherited]

get the io object

Returns:
io object

Definition at line 224 of file SGObject.cpp.

Parallel * get_global_parallel (  )  [inherited]

get the parallel object

Returns:
parallel object

Definition at line 259 of file SGObject.cpp.

Version * get_global_version (  )  [inherited]

get the version object

Returns:
version object

Definition at line 272 of file SGObject.cpp.

CFeatures* get_lhs (  ) 

get left-hand side features used in distance matrix

Returns:
left-hand side features

Definition at line 215 of file Distance.h.

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

Definition at line 1108 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_name name of the parameter
Returns:
description of the parameter

Definition at line 1132 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_name name of model selection parameter
Returns:
index of model selection parameter with provided name, -1 if there is no such

Definition at line 1145 of file SGObject.cpp.

virtual const char* get_name (  )  const [pure virtual, inherited]

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

Returns:
name of the SGSerializable

Implemented in CAveragedPerceptron, CFeatureBlockLogisticRegression, CLDA, CLPBoost, CLPM, CMKL, CMKLMulticlass, MKLMulticlassGLPK, MKLMulticlassGradient, MKLMulticlassOptimizationBase, CPerceptron, CPluginEstimate, CSubGradientLPM, CGNPPLib, CGNPPSVM, CGPBTSVM, CLibLinear, CLibSVM, CLibSVMOneClass, CMPDSVM, CNewtonSVM, COnlineLibLinear, COnlineSVMSGD, CQPBSVMLib, CSGDQN, CSubGradientSVM, CSVM, CSVMLight, CSVMLin, CSVMOcas, CSVMSGD, CWDSVMOcas, CVwCacheReader, CVwNativeCacheReader, CVwNativeCacheWriter, CVwAdaptiveLearner, CVwNonAdaptiveLearner, CVowpalWabbit, CVwEnvironment, CVwLearner, CVwParser, CVwRegressor, CGMM, CHierarchical, CKMeans, CConverter, CDiffusionMaps, CEmbeddingConverter, CHessianLocallyLinearEmbedding, CIsomap, CKernelLocallyLinearEmbedding, CKernelLocalTangentSpaceAlignment, CLaplacianEigenmaps, CLinearLocalTangentSpaceAlignment, CLocalityPreservingProjections, CLocallyLinearEmbedding, CLocalTangentSpaceAlignment, CMultidimensionalScaling, CNeighborhoodPreservingEmbedding, CStochasticProximityEmbedding, CAttenuatedEuclideanDistance, CBrayCurtisDistance, CCanberraMetric, CCanberraWordDistance, CChebyshewMetric, CChiSquareDistance, CCosineDistance, CCustomDistance, CDenseDistance< ST >, CEuclideanDistance, CGeodesicMetric, CHammingWordDistance, CJensenMetric, CKernelDistance, CMahalanobisDistance, CManhattanMetric, CManhattanWordDistance, CMinkowskiMetric, CRealDistance, CSparseDistance< ST >, CSparseEuclideanDistance, CStringDistance< ST >, CTanimotoDistance, CGaussian, CGHMM, CHistogram, CHMM, CLinearHMM, CPositionalPWM, CClusteringAccuracy, CClusteringMutualInformation, CContingencyTableEvaluation, CAccuracyMeasure, CErrorRateMeasure, CBALMeasure, CWRACCMeasure, CF1Measure, CCrossCorrelationMeasure, CRecallMeasure, CPrecisionMeasure, CSpecificityMeasure, CCrossValidationResult, CCrossValidation, CCrossValidationMKLStorage, CCrossValidationMulticlassStorage, CCrossValidationOutput, CCrossValidationPrintOutput, CCrossValidationSplitting, CGradientCriterion, CGradientEvaluation, CGradientResult, CMeanAbsoluteError, CMeanSquaredError, CMeanSquaredLogError, CMulticlassAccuracy, CMulticlassOVREvaluation, CPRCEvaluation, CROCEvaluation, CStratifiedCrossValidationSplitting, CStructuredAccuracy, CAlphabet, CAttributeFeatures, CBinnedDotFeatures, CCombinedDotFeatures, CCombinedFeatures, CDataGenerator, CDenseFeatures< ST >, CDenseSubsetFeatures< ST >, CDummyFeatures, CExplicitSpecFeatures, CFKFeatures, CHashedWDFeatures, CHashedWDFeaturesTransposed, CImplicitWeightedSpecFeatures, CLatentFeatures, CLBPPyrDotFeatures, CMatrixFeatures< ST >, CPolyFeatures, CRealFileFeatures, CSNPFeatures, CSparseFeatures< ST >, CSparsePolyFeatures, CMeanShiftDataGenerator< T >, CStreamingDenseFeatures< T >, CStreamingSparseFeatures< T >, CStreamingStringFeatures< T >, CStreamingVwFeatures, CStringFeatures< ST >, CSubset, CSubsetStack, CTOPFeatures, CWDFeatures, CAsciiFile, CBinaryFile, CBinaryStream< T >, CFile, CIOBuffer, CMemoryMappedFile< T >, CSerializableAsciiFile, SerializableAsciiReader00, CSimpleFile< T >, CParseBuffer< T >, CStreamingAsciiFile, CStreamingFile, CStreamingFileFromDenseFeatures< T >, CStreamingFileFromFeatures, CStreamingFileFromSparseFeatures< T >, CStreamingFileFromStringFeatures< T >, CStreamingVwCacheFile, CStreamingVwFile, CANOVAKernel, CAUCKernel, CBesselKernel, CCauchyKernel, CChi2Kernel, CCircularKernel, CCombinedKernel, CConstKernel, CCustomKernel, CDiagKernel, CDistanceKernel, CDotKernel, CExponentialKernel, CGaussianARDKernel, CGaussianKernel, CGaussianShiftKernel, CGaussianShortRealKernel, CHistogramIntersectionKernel, CInverseMultiQuadricKernel, CJensenShannonKernel, CLinearARDKernel, CLinearKernel, CLogKernel, CMultiquadricKernel, CAvgDiagKernelNormalizer, CDiceKernelNormalizer, CFirstElementKernelNormalizer, CIdentityKernelNormalizer, CRidgeKernelNormalizer, CScatterKernelNormalizer, CSqrtDiagKernelNormalizer, CTanimotoKernelNormalizer, CVarianceKernelNormalizer, CZeroMeanCenterKernelNormalizer, CPolyKernel, CPowerKernel, CProductKernel, CPyramidChi2, CRationalQuadraticKernel, CSigmoidKernel, CSparseKernel< ST >, CSphericalKernel, CSplineKernel, CCommUlongStringKernel, CCommWordStringKernel, CDistantSegmentsKernel, CFixedDegreeStringKernel, CGaussianMatchStringKernel, CHistogramWordStringKernel, CLinearStringKernel, CLocalAlignmentStringKernel, CLocalityImprovedStringKernel, CMatchWordStringKernel, COligoStringKernel, CPolyMatchStringKernel, CPolyMatchWordStringKernel, CRegulatoryModulesStringKernel, CSalzbergWordStringKernel, CSimpleLocalityImprovedStringKernel, CSNPStringKernel, CSparseSpatialSampleStringKernel, CSpectrumMismatchRBFKernel, CSpectrumRBFKernel, CStringKernel< ST >, CWeightedCommWordStringKernel, CWeightedDegreePositionStringKernel, CWeightedDegreeStringKernel, CTensorProductPairKernel, CTStudentKernel, CWaveKernel, CWaveletKernel, CWeightedDegreeRBFKernel, CBinaryLabels, CLatentLabels, CMulticlassLabels, CMulticlassMultipleOutputLabels, CRegressionLabels, CStructuredLabels, CLatentModel, CLatentSOSVM, CLatentSVM, CBitString, CCache< T >, CCompressor, CData, CDynamicArray< T >, CDynamicObjectArray, CGCArray< T >, CHash, CIndexBlock, CIndexBlockGroup, CIndexBlockRelation, CIndexBlockTree, CListElement, CList, CMap< K, T >, CSet< T >, CSignal, CStructuredData, CTime, CTrie< Trie >, CHingeLoss, CLogLoss, CLogLossMargin, CLossFunction, CSmoothHingeLoss, CSquaredHingeLoss, CSquaredLoss, CBaseMulticlassMachine, CDistanceMachine, CKernelMachine, CKernelMulticlassMachine, CKernelStructuredOutputMachine, CLinearLatentMachine, CLinearMachine, CLinearMulticlassMachine, CLinearStructuredOutputMachine, CMachine, CMulticlassMachine, CNativeMulticlassMachine, COnlineLinearMachine, CStructuredOutputMachine, CCplex, CMath, CSparseInverseCovariance, CStatistics, CGradientModelSelection, CGridSearchModelSelection, CModelSelectionParameters, CParameterCombination, CRandomSearchModelSelection, CConjugateIndex, CECOCAEDDecoder, CECOCDecoder, CECOCDiscriminantEncoder, CECOCEDDecoder, CECOCEncoder, CECOCForestEncoder, CECOCHDDecoder, CECOCIHDDecoder, CECOCLLBDecoder, CECOCOVOEncoder, CECOCOVREncoder, CECOCRandomDenseEncoder, CECOCRandomSparseEncoder, CECOCSimpleDecoder, CECOCStrategy, CGaussianNaiveBayes, CGMNPLib, CGMNPSVM, CKNN, CLaRank, CMulticlassLibLinear, CMulticlassLibSVM, CMulticlassLogisticRegression, CMulticlassOCAS, CMulticlassOneVsOneStrategy, CMulticlassOneVsRestStrategy, CMulticlassStrategy, CMulticlassTreeGuidedLogisticRegression, CQDA, CRejectionStrategy, CThresholdRejectionStrategy, CDixonQTestRejectionStrategy, CScatterSVM, CShareBoost, CBalancedConditionalProbabilityTree, CConditionalProbabilityTree, CRandomConditionalProbabilityTree, CRelaxedTree, CTreeMachine< T >, CTreeMachineNode< T >, CVwConditionalProbabilityTree, CDecompressString< ST >, CDimensionReductionPreprocessor, CHomogeneousKernelMap, CKernelPCA, CLogPlusOne, CNormOne, CPCA, CPNorm, CPruneVarSubMean, CRandomFourierGaussPreproc, CSortUlongString, CSortWordString, CSparsePreprocessor< ST >, CStringPreprocessor< ST >, CSumOne, CGaussianProcessRegression, CExactInferenceMethod, CFITCInferenceMethod, CGaussianLikelihood, CLaplacianInferenceMethod, CStudentsTLikelihood, CZeroMean, CKernelRidgeRegression, CLeastAngleRegression, CLeastSquaresRegression, CLinearRidgeRegression, CLibLinearRegression, CLibSVR, CSVRLight, CHSIC, CKernelIndependenceTestStatistic, CKernelMeanMatching, CKernelTwoSampleTestStatistic, CLinearTimeMMD, CQuadraticTimeMMD, CTestStatistic, CTwoDistributionsTestStatistic, CDualLibQPBMSOSVM, CDynProg, CSequence, CHMSVMLabels, CIntronList, CMulticlassModel, CRealNumber, CMulticlassSOLabels, CPlif, CPlifArray, CPlifMatrix, CSegmentLoss, CStateModel, CResultSet, CStructuredModel, CTwoStateModel, CDomainAdaptationMulticlassLibLinear, CDomainAdaptationSVM, CDomainAdaptationSVMLinear, CLibLinearMTL, CMultitaskClusteredLogisticRegression, CMultitaskCompositeMachine, CMultitaskKernelMaskNormalizer, CMultitaskKernelMaskPairNormalizer, CMultitaskKernelMklNormalizer, CMultitaskKernelNormalizer, CMultitaskKernelPlifNormalizer, CNode, CTaxonomy, CMultitaskKernelTreeNormalizer, CMultitaskL12LogisticRegression, CMultitaskLeastSquaresRegression, CMultitaskLinearMachine, CMultitaskLogisticRegression, CMultitaskROCEvaluation, CMultitaskTraceLogisticRegression, CTask, CTaskGroup, CTaskRelation, CTaskTree, CGUIClassifier, CGUIConverter, CGUIDistance, CGUIFeatures, CGUIHMM, CGUIKernel, CGUILabels, CGUIMath, CGUIPluginEstimate, CGUIPreprocessor, CGUIStructure, CGUITime, CDenseDistance< float64_t >, CSparseDistance< float64_t >, CStringDistance< uint16_t >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, CSparseFeatures< float64_t >, CSparseFeatures< T >, CStreamingDenseFeatures< float32_t >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, CStringFeatures< uint16_t >, CMemoryMappedFile< ST >, CParseBuffer< VwExample >, CParseBuffer< float32_t >, CParseBuffer< SGSparseVectorEntry< T > >, CStringKernel< uint16_t >, CStringKernel< char >, CStringKernel< uint64_t >, CCache< SGSparseVectorEntry< ST > >, CCache< uint32_t >, CCache< ST >, CCache< SGSparseVectorEntry< float64_t > >, CCache< float64_t >, CCache< uint8_t >, CCache< KERNELCACHE_ELEM >, CCache< char >, CCache< uint16_t >, CCache< SGSparseVectorEntry< T > >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CDynamicArray< uint64_t >, CMap< TParameter *, CSGObject * >, CMap< TParameter *, SGVector< float64_t > >, CTrie< DNATrie >, CTrie< POIMTrie >, CTreeMachine< ConditionalProbabilityTreeNodeData >, CTreeMachine< RelaxedTreeNodeData >, CTreeMachine< VwConditionalProbabilityTreeNodeData >, CTreeMachineNode< ConditionalProbabilityTreeNodeData >, CTreeMachineNode< RelaxedTreeNodeData >, CTreeMachineNode< VwConditionalProbabilityTreeNodeData >, CStringPreprocessor< uint16_t >, and CStringPreprocessor< uint64_t >.

virtual int32_t get_num_vec_lhs (  )  [virtual]

get number of vectors of lhs features

Returns:
number of vectors of left-hand side

Reimplemented in CCustomDistance.

Definition at line 303 of file Distance.h.

virtual int32_t get_num_vec_rhs (  )  [virtual]

get number of vectors of rhs features

Returns:
number of vectors of right-hand side

Reimplemented in CCustomDistance.

Definition at line 312 of file Distance.h.

bool get_precompute_matrix (  ) 

FIXME: precompute matrix should be dropped, handling should be via customdistance

Returns:
if precompute_matrix

Definition at line 281 of file Distance.h.

CFeatures* get_rhs (  ) 

get right-hand side features used in distance matrix

Returns:
right-hand side features

Definition at line 221 of file Distance.h.

virtual bool has_features (  )  [virtual]

test whether features have been assigned to lhs and rhs

Returns:
true if features are assigned

Reimplemented in CCustomDistance.

Definition at line 321 of file Distance.h.

bool init ( CFeatures lhs,
CFeatures rhs 
) [virtual]
bool is_generic ( EPrimitiveType *  generic  )  const [virtual, inherited]

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

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

Definition at line 278 of file SGObject.cpp.

bool lhs_equals_rhs (  ) 

test whether features on lhs and rhs are the same

Returns:
true if features are the same

Definition at line 330 of file Distance.h.

void load ( CFile loader  ) 

load the kernel matrix

Parameters:
loader File object via which to load data

Definition at line 105 of file Distance.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_version parameter version of the file
current_version version from which mapping begins (you want to use VERSION_PARAMETER for this in most cases)
file file to load from
prefix prefix for members
Returns:
(sorted) array of created TParameter instances with file data

Definition at line 679 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_info information of parameter
file_version parameter version of the file, must be <= provided parameter version
file file to load from
prefix prefix for members
Returns:
new array with TParameter instances with the attached data

Definition at line 523 of file SGObject.cpp.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
) [virtual, inherited]

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

Parameters:
file where to load from
prefix prefix 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

Reimplemented in CModelSelectionParameters.

Definition at line 354 of file SGObject.cpp.

void load_serializable_post (  )  throw (ShogunException) [protected, virtual, inherited]

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:
ShogunException Will be thrown if an error occurres.

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

Definition at line 1033 of file SGObject.cpp.

void load_serializable_pre (  )  throw (ShogunException) [protected, virtual, inherited]

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:
ShogunException Will be thrown if an error occurres.

Definition at line 1028 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_base set of TParameter instances that are mapped to the provided target parameter infos
base_version version of the parameter base
target_param_infos set of SGParamInfo instances that specify the target parameter base

Definition at line 717 of file SGObject.cpp.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo target 
) [protected, virtual, inherited]

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_base set of TParameter instances to use for migration
target parameter 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 923 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 
) [protected, virtual, inherited]

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_base set of TParameter instances to use for migration
target parameter info for the resulting TParameter
replacement (used as output) here the TParameter instance which is returned by migration is created into
to_migrate the only source that is used for migration
old_name with this parameter, a name change may be specified

Definition at line 864 of file SGObject.cpp.

void print_modsel_params (  )  [inherited]

prints all parameter registered for model selection and their type

Definition at line 1084 of file SGObject.cpp.

void print_serializable ( const char *  prefix = ""  )  [virtual, inherited]

prints registered parameters out

Parameters:
prefix prefix for members

Definition at line 290 of file SGObject.cpp.

void remove_lhs (  )  [virtual]

takes all necessary steps if the lhs is removed from distance matrix

Definition at line 128 of file Distance.cpp.

void remove_lhs_and_rhs (  )  [virtual]

remove lhs and rhs from distance

Definition at line 117 of file Distance.cpp.

void remove_rhs (  )  [virtual]

takes all necessary steps if the rhs is removed from distance matrix

takes all necessary steps if the rhs is removed from kernel

Definition at line 136 of file Distance.cpp.

CFeatures * replace_lhs ( CFeatures lhs  ) 

replace left-hand side features used in distance matrix

make sure to check that your distance can deal with the supplied features (!)

Parameters:
lhs features of right-hand side
Returns:
replaced left-hand side features

Definition at line 165 of file Distance.cpp.

CFeatures * replace_rhs ( CFeatures rhs  ) 

replace right-hand side features used in distance matrix

make sure to check that your distance can deal with the supplied features (!)

Parameters:
rhs features of right-hand side
Returns:
replaced right-hand side features

Definition at line 143 of file Distance.cpp.

void * run_distance_thread ( void *  p  )  [static, protected]

run distance thread

Definition at line 387 of file Distance.cpp.

void save ( CFile writer  ) 

save kernel matrix

Parameters:
writer File object via which to save data

Definition at line 111 of file Distance.cpp.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
) [virtual, inherited]

Save this object to file.

Parameters:
file where to save the object; will be closed during returning if PREFIX is an empty string.
prefix prefix 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

Reimplemented in CModelSelectionParameters.

Definition at line 296 of file SGObject.cpp.

void save_serializable_post (  )  throw (ShogunException) [protected, virtual, inherited]

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:
ShogunException Will be thrown if an error occurres.

Reimplemented in CKernel.

Definition at line 1043 of file SGObject.cpp.

void save_serializable_pre (  )  throw (ShogunException) [protected, virtual, inherited]

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:
ShogunException Will be thrown if an error occurres.

Reimplemented in CKernel.

Definition at line 1038 of file SGObject.cpp.

void set_generic< floatmax_t > (  )  [inherited]

set generic type to T

void set_global_io ( SGIO io  )  [inherited]

set the io object

Parameters:
io io object to use

Definition at line 217 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel  )  [inherited]

set the parallel object

Parameters:
parallel parallel object to use

Definition at line 230 of file SGObject.cpp.

void set_global_version ( Version version  )  [inherited]

set the version object

Parameters:
version version object to use

Definition at line 265 of file SGObject.cpp.

virtual void set_precompute_matrix ( bool  flag  )  [virtual]

FIXME: precompute matrix should be dropped, handling should be via customdistance

Parameters:
flag if precompute_matrix

Definition at line 288 of file Distance.h.

virtual CSGObject* shallow_copy (  )  const [virtual, inherited]

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

Reimplemented in CGaussianKernel.

Definition at line 122 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 285 of file SGObject.cpp.

bool update_parameter_hash (  )  [protected, virtual, inherited]

Updates the hash of current parameter combination.

Returns:
bool if parameter combination has changed since last update.

Definition at line 237 of file SGObject.cpp.


Member Data Documentation

SGIO* io [inherited]

io

Definition at line 462 of file SGObject.h.

CFeatures* lhs [protected]

feature vectors to occur on the left hand side

Definition at line 363 of file Distance.h.

uint32_t m_hash [inherited]

Hash of parameter values

Definition at line 480 of file SGObject.h.

model selection parameters

Definition at line 474 of file SGObject.h.

map for different parameter versions

Definition at line 477 of file SGObject.h.

Parameter* m_parameters [inherited]

parameters

Definition at line 471 of file SGObject.h.

int32_t num_lhs [protected]

number of feature vectors on the left hand side

Definition at line 368 of file Distance.h.

int32_t num_rhs [protected]

number of feature vectors on the right hand side

Definition at line 370 of file Distance.h.

Parallel* parallel [inherited]

parallel

Definition at line 465 of file SGObject.h.

bool precompute_matrix [protected]

FIXME: precompute matrix should be dropped, handling should be via customdistance

Definition at line 360 of file Distance.h.

FIXME: precompute matrix should be dropped, handling should be via customdistance

Definition at line 355 of file Distance.h.

CFeatures* rhs [protected]

feature vectors to occur on the right hand side

Definition at line 365 of file Distance.h.

Version* version [inherited]

version

Definition at line 468 of file SGObject.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

SHOGUN Machine Learning Toolbox - Documentation