SHOGUN v0.9.0
公有成员 | 公有属性 | 保护成员 | 保护属性
CSGObject类参考

详细描述

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)

在文件SGObject.h61行定义。

CArray< bool >CArray< char >CArray< CPlifBase * >CArray< float32_t >CArray< float64_t >CArray< int32_t >CCache< char >CCache< float64_t >CCache< KERNELCACHE_ELEM >CCache< ST >CCache< TSparseEntry< float64_t > >CCache< TSparseEntry< ST > >CCache< uint16_t >CCache< uint32_t >CCache< uint8_t >CDynamicArray< float64_t >CDynamicArray< int32_t >CDynamicArray< uint64_t >CMemoryMappedFile< ST >CTrie< DNATrie >CTrie< POIMTrie >CAlphabetCArray< T >CBinaryStream< T >CBitStringCCache< T >CClassifierCCompressorCCplexCDistanceCDistributionCDynamicArray< T >CDynamicArrayPtrCDynProgCFeaturesCFileCGCArray< T >CGMNPLibCGNPPLibCHashCIntronListCKernelCKernelNormalizerCLabelsCListCListElementCMathCMemoryMappedFile< T >CNodeCPerformanceMeasuresCPlifBaseCPlifMatrixCPreProcCQPBSVMLibCSegmentLossCSerializableFileCSerializableFile::TSerializableReaderCSet< T >CSignalCSignalModelCSimpleFile< T >CTaxonomyCTimeCTrainPredMasterCTrie< Trie >MKLMultiClassOptimizationBase继承.

所有成员的列表。

公有成员

 CSGObject ()
 CSGObject (const CSGObject &orig)
virtual ~CSGObject ()
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_io (IO *io)
IOget_io ()
void set_parallel (Parallel *parallel)
Parallelget_parallel ()
void set_version (Version *version)
Versionget_version ()

公有属性

IOio
Parallelparallel
Versionversion

保护成员

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)

保护属性

Parameterm_parameters

构造及析构函数文档

CSGObject ( )

default constructor

在文件SGObject.cpp103行定义。

CSGObject ( const CSGObject orig)

copy constructor

在文件SGObject.cpp112行定义。

~CSGObject ( ) [virtual]

destructor

在文件SGObject.cpp119行定义。


成员函数文档

IO * get_io ( )

get the io object

返回:
io object

在文件SGObject.cpp159行定义。

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

返回:
name of the SGSerializable

CDistanceMachineCKernelMachineCKernelPerceptronCKNNCLDACLinearClassifierCLPBoostCLPMCMKLMKLMultiClassGLPKMKLMultiClassGradientMKLMultiClassOptimizationBaseCPerceptronCPluginEstimateCSubGradientLPMCDomainAdaptationSVMLinearCGMNPLibCGMNPSVMCGNPPLibCGNPPSVMCGPBTSVMCLaRankCLibLinearCLibSVMCLibSVMMultiClassCLibSVMOneClassCMPDSVMCQPBSVMLibCScatterSVMCSubGradientSVMCSVMCSVMLinCSVMOcasCSVMSGDCWDSVMOcasCHierarchicalCKMeansCBrayCurtisDistanceCCanberraMetricCCanberraWordDistanceCChebyshewMetricCChiSquareDistanceCCosineDistanceCCustomDistanceCEuclidianDistanceCGeodesicMetricCHammingWordDistanceCJensenMetricCKernelDistanceCManhattanMetricCManhattanWordDistanceCMinkowskiMetricCRealDistanceCSimpleDistance< ST >CSparseDistance< ST >CSparseEuclidianDistanceCStringDistance< ST >CTanimotoDistanceCGHMMCHistogramCHMMCLinearHMMCPerformanceMeasuresCAlphabetCAttributeFeaturesCCombinedDotFeaturesCCombinedFeaturesCDummyFeaturesCExplicitSpecFeaturesCFKFeaturesCHashedWDFeaturesCHashedWDFeaturesTransposedCImplicitWeightedSpecFeaturesCLabelsCLBPPyrDotFeaturesCPolyFeaturesCRealFileFeaturesCSimpleFeatures< ST >CSNPFeaturesCSparseFeatures< ST >CSparsePolyFeaturesCStringFeatures< ST >CTOPFeaturesCWDFeaturesCSignalModelCTrainPredMasterCAUCKernelCAvgDiagKernelNormalizerCChi2KernelCCombinedKernelCCommUlongStringKernelCCommWordStringKernelCConstKernelCCustomKernelCDiagKernelCDiceKernelNormalizerCDistanceKernelCDotKernelCFirstElementKernelNormalizerCFixedDegreeStringKernelCGaussianKernelCGaussianMatchStringKernelCGaussianShiftKernelCGaussianShortRealKernelCHistogramIntersectionKernelCHistogramWordStringKernelCIdentityKernelNormalizerCLinearKernelCLinearStringKernelCLocalAlignmentStringKernelCLocalityImprovedStringKernelCMatchWordStringKernelCMultitaskKernelMaskNormalizerCMultitaskKernelMaskPairNormalizerCMultitaskKernelMklNormalizerCMultitaskKernelNormalizerCMultitaskKernelPlifNormalizerCNodeCTaxonomyCMultitaskKernelTreeNormalizerCOligoStringKernelCPolyKernelCPolyMatchStringKernelCPolyMatchWordStringKernelCPyramidChi2CRegulatoryModulesStringKernelCRidgeKernelNormalizerCSalzbergWordStringKernelCScatterKernelNormalizerCSigmoidKernelCSimpleLocalityImprovedStringKernelCSNPStringKernelCSparseKernel< ST >CSparseSpatialSampleStringKernelCSpectrumMismatchRBFKernelCSpectrumRBFKernelCSqrtDiagKernelNormalizerCStringKernel< ST >CTanimotoKernelNormalizerCTensorProductPairKernelCVarianceKernelNormalizerCWeightedCommWordStringKernelCWeightedDegreePositionStringKernelCWeightedDegreeRBFKernelCWeightedDegreeStringKernelCZeroMeanCenterKernelNormalizerCArray< T >CArray2< T >CArray3< T >CAsciiFileCBinaryFileCBinaryStream< T >CBitStringCCache< T >CCompressorCCplexCDynamicArray< T >CDynamicArrayPtrCFileCGCArray< T >CHashCListElementCListCMathCMemoryMappedFile< T >CSerializableAsciiFileSerializableAsciiReader00CSet< T >CSignalCSimpleFile< T >CTimeCTrie< Trie >CLogPlusOneCNormOneCPCACutCPreProcCPruneVarSubMeanCSortUlongStringCSortWordStringCKRRCLibSVRCDynProgCIntronListCPlifCPlifArrayCPlifMatrixCSegmentLossCSimpleDistance< float64_t >CSparseDistance< float64_t >CStringDistance< uint16_t >CSimpleFeatures< uint32_t >CSimpleFeatures< float64_t >CSimpleFeatures< uint16_t >CSparseFeatures< float64_t >CStringFeatures< uint8_t >CStringFeatures< char >CStringFeatures< uint16_t >CStringKernel< char >CStringKernel< uint16_t >CStringKernel< uint64_t >CArray< CPlifBase * >CArray< float64_t >CArray< float32_t >CArray< int32_t >CArray< char >CArray< bool >CArray2< CPlifBase * >CArray2< float64_t >CArray2< float32_t >CArray2< int32_t >CArray3< float64_t >CCache< uint32_t >CCache< ST >CCache< float64_t >CCache< TSparseEntry< ST > >CCache< uint8_t >CCache< KERNELCACHE_ELEM >CCache< char >CCache< uint16_t >CCache< TSparseEntry< float64_t > >CDynamicArray< float64_t >CDynamicArray< int32_t >CDynamicArray< uint64_t >CMemoryMappedFile< ST >CTrie< DNATrie >CTrie< POIMTrie >内被实现。

Parallel * get_parallel ( )

get the parallel object

返回:
parallel object

在文件SGObject.cpp172行定义。

Version * get_version ( )

get the version object

返回:
version object

在文件SGObject.cpp185行定义。

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.

参数:
genericset to the type of the generic if returning TRUE
返回:
TRUE if a class template.

在文件SGObject.cpp191行定义。

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!

参数:
filewhere to load from
prefixprefix for members
返回:
TRUE if done, otherwise FALSE

在文件SGObject.cpp263行定义。

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

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.

异常:
ShogunExceptionWill be thrown if an error occurres.

CLinearHMMCAlphabetCGaussianKernelCKernelCWeightedDegreePositionStringKernelCList重载。

在文件SGObject.cpp318行定义。

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

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.

异常:
ShogunExceptionWill be thrown if an error occurres.

在文件SGObject.cpp313行定义。

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

prints registered parameters out

参数:
prefixprefix for members

在文件SGObject.cpp203行定义。

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

Save this object to file.

参数:
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
返回:
TRUE if done, otherwise FALSE

在文件SGObject.cpp209行定义。

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

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.

异常:
ShogunExceptionWill be thrown if an error occurres.

CKernel重载。

在文件SGObject.cpp328行定义。

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

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.

异常:
ShogunExceptionWill be thrown if an error occurres.

CKernel重载。

在文件SGObject.cpp323行定义。

void set_generic< floatmax_t > ( )

set generic type to T

在文件SGObject.cpp34行定义。

void set_io ( IO io)

set the io object

参数:
ioio object to use

在文件SGObject.cpp152行定义。

void set_parallel ( Parallel parallel)

set the parallel object

参数:
parallelparallel object to use

在文件SGObject.cpp165行定义。

void set_version ( Version version)

set the version object

参数:
versionversion object to use

在文件SGObject.cpp178行定义。

void unset_generic ( )

unset generic type

this has to be called in classes specializing a template class

在文件SGObject.cpp198行定义。


成员数据文档

IO* io

在文件SGObject.h264行定义。

Parameter* m_parameters [protected]

在文件SGObject.h269行定义。

在文件SGObject.h265行定义。

在文件SGObject.h266行定义。


该类的文档由以下文件生成:

SHOGUN Machine Learning Toolbox - Documentation