Public Member Functions | Public Attributes

CSGObject Class Reference


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. CParallel)
  2. io - to output messages and general i/o (cf. CIO)
  3. version - to provide version information of the shogun version used (cf. CVersion)

Definition at line 81 of file SGObject.h.

Inherited by 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< uint8_t >, CDynamicArray< CPlifBase * >, CDynamicArray< float64_t >, CDynamicArray< int32_t >, CDynamicArray< T_ATTRIBUTE >, CDynamicArray< TParameter * >, CDynamicArray< uint64_t >, CList< CDotFeatures * >, CList< CFeatures * >, CList< CKernel * >, CMemoryMappedFile< ST >, CTrie< DNATrie >, CTrie< POIMTrie >, CAlphabet, CArray< T >, CBinaryStream< T >, CBitString, CCache< T >, CClassifier, CCompressor, CCplex, CDistance, CDistribution, CDynamicArray< T >, CDynProg, CFeatures, CFile, CGCArray< T >, CGMNPLib, CGNPPLib, CHash, CIntronList, CKernel, CKernelNormalizer, CLabels, CList< T >, CMath, CMemoryMappedFile< T >, CNode, CParameter, CPerformanceMeasures, CPlifBase, CPlifMatrix, CPreProc, CQPBSVMLib, CSegmentLoss, CSet< T >, CSignal, CSignalModel, CSimpleFile< T >, CTaxonomy, CTime, CTrainPredMaster, CTrie< Trie >, and MKLMultiClassOptimizationBase.

List of all members.

Public Member Functions

 CSGObject ()
 CSGObject (const CSGObject &orig)
virtual ~CSGObject ()
virtual const char * get_name () const =0
void set_io (CIO *io)
CIOget_io ()
void set_parallel (CParallel *parallel)
CParallelget_parallel ()
void set_version (CVersion *version)
CVersionget_version ()

Public Attributes

CIOio
CParallelparallel
CVersionversion

Constructor & Destructor Documentation

CSGObject (  ) 

Definition at line 84 of file SGObject.h.

CSGObject ( const CSGObject orig  ) 

Definition at line 90 of file SGObject.h.

virtual ~CSGObject (  )  [virtual]

Definition at line 96 of file SGObject.h.


Member Function Documentation

CIO * get_io (  ) 

get the io object

Returns:
io object

Definition at line 67 of file SGObject.cpp.

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

get the name of the object

Returns:
name of object

Implemented in CKernelPerceptron, CKNN, CLDA, CLPBoost, CLPM, CMKL, MKLMultiClassGLPK, MKLMultiClassGradient, MKLMultiClassOptimizationBase, CPerceptron, CPluginEstimate, CSubGradientLPM, CGMNPLib, CGMNPSVM, CGNPPLib, CGNPPSVM, CGPBTSVM, CLaRank, CLibLinear, CLibSVM, CLibSVMMultiClass, CLibSVMOneClass, CMPDSVM, CQPBSVMLib, CScatterSVM, CSubGradientSVM, CSVM, CSVMLin, CSVMOcas, CSVMSGD, CWDSVMOcas, CHierarchical, CKMeans, CBrayCurtisDistance, CCanberraMetric, CCanberraWordDistance, CChebyshewMetric, CChiSquareDistance, CCosineDistance, CEuclidianDistance, CGeodesicMetric, CHammingWordDistance, CJensenMetric, CManhattanMetric, CManhattanWordDistance, CMinkowskiMetric, CSparseEuclidianDistance, CTanimotoDistance, CHistogram, CHMM, CLinearHMM, CPerformanceMeasures, CAlphabet, CAttributeFeatures, CCombinedDotFeatures, CCombinedFeatures, CDummyFeatures, CExplicitSpecFeatures, CFKFeatures, CHashedWDFeatures, CHashedWDFeaturesTransposed, CImplicitWeightedSpecFeatures, CLabels, CPolyFeatures, CRealFileFeatures, CSimpleFeatures< ST >, CSNPFeatures, CSparseFeatures< ST >, CSparsePolyFeatures, CStringFeatures< ST >, CTOPFeatures, CWDFeatures, CSignalModel, CTrainPredMaster, CAUCKernel, CAvgDiagKernelNormalizer, CChi2Kernel, CCombinedKernel, CCommUlongStringKernel, CCommWordStringKernel, CConstKernel, CCustomKernel, CDiagKernel, CDistanceKernel, CFirstElementKernelNormalizer, CFixedDegreeStringKernel, CGaussianKernel, CGaussianMatchStringKernel, CGaussianShiftKernel, CGaussianShortRealKernel, CHistogramWordStringKernel, CIdentityKernelNormalizer, CLinearByteKernel, CLinearKernel, CLinearStringKernel, CLinearWordKernel, CLocalAlignmentStringKernel, CLocalityImprovedStringKernel, CMatchWordStringKernel, CMultitaskKernelMaskNormalizer, CMultitaskKernelMaskPairNormalizer, CMultitaskKernelMklNormalizer, CMultitaskKernelNormalizer, CMultitaskKernelPlifNormalizer, CNode, CTaxonomy, CMultitaskKernelTreeNormalizer, COligoStringKernel, CPolyKernel, CPolyMatchStringKernel, CPolyMatchWordStringKernel, CPyramidChi2, CRegulatoryModulesStringKernel, CRidgeKernelNormalizer, CSalzbergWordStringKernel, CScatterKernelNormalizer, CSigmoidKernel, CSimpleLocalityImprovedStringKernel, CSNPStringKernel, CSparseGaussianKernel, CSparseLinearKernel, CSparsePolyKernel, CSpectrumMismatchRBFKernel, CSpectrumRBFKernel, CSqrtDiagKernelNormalizer, CTensorProductPairKernel, CVarianceKernelNormalizer, CWeightedCommWordStringKernel, CWeightedDegreePositionStringKernel, CWeightedDegreeRBFKernel, CWeightedDegreeStringKernel, CArray< T >, CAsciiFile, CBinaryFile, CBinaryStream< T >, CBitString, CCache< T >, CCompressor, CCplex, CDynamicArray< T >, CFile, CGCArray< T >, CHash, CHDF5File, CList< T >, CMath, CMemoryMappedFile< T >, CParameter, CSet< T >, CSignal, CSimpleFile< T >, CTime, CTrie< Trie >, CPreProc, CKRR, CLibSVR, CDynProg, CIntronList, CPlif, CPlifArray, CPlifMatrix, CSegmentLoss, CSimpleFeatures< float64_t >, CSimpleFeatures< uint16_t >, CSparseFeatures< float64_t >, CStringFeatures< uint8_t >, CStringFeatures< char >, CStringFeatures< uint16_t >, CArray< CPlifBase * >, CArray< float64_t >, CArray< float32_t >, CArray< int32_t >, CArray< char >, CArray< bool >, CCache< ST >, CCache< float64_t >, CCache< TSparseEntry< ST > >, CCache< uint8_t >, CCache< KERNELCACHE_ELEM >, CCache< char >, CCache< uint16_t >, CCache< TSparseEntry< float64_t > >, CDynamicArray< CPlifBase * >, CDynamicArray< float64_t >, CDynamicArray< int32_t >, CDynamicArray< T_ATTRIBUTE >, CDynamicArray< TParameter * >, CDynamicArray< uint64_t >, CList< CDotFeatures * >, CList< CKernel * >, CList< CFeatures * >, CMemoryMappedFile< ST >, CTrie< DNATrie >, and CTrie< POIMTrie >.

CParallel * get_parallel (  ) 

get the parallel object

Returns:
parallel object

Definition at line 80 of file SGObject.cpp.

CVersion * get_version (  ) 

get the version object

Returns:
version object

Definition at line 93 of file SGObject.cpp.

void set_io ( CIO io  ) 

set the io object

Parameters:
io io object to use

Definition at line 60 of file SGObject.cpp.

void set_parallel ( CParallel parallel  ) 

set the parallel object

Parameters:
parallel parallel object to use

Definition at line 73 of file SGObject.cpp.

void set_version ( CVersion version  ) 

set the version object

Parameters:
version version object to use

Definition at line 86 of file SGObject.cpp.


Member Data Documentation

CIO* io

Definition at line 249 of file SGObject.h.

Definition at line 250 of file SGObject.h.

Definition at line 251 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