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 49 of file SGObject.h.

Inheritance diagram for CSGObject:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CSGObject ()
 CSGObject (const CSGObject &orig)
virtual ~CSGObject ()
int32_t ref ()
int32_t ref_count () const
int32_t unref ()
virtual const char * get_name () const =0

Public Attributes

CIOio
CParallelparallel
CVersionversion

Constructor & Destructor Documentation

CSGObject::CSGObject (  ) 

Definition at line 52 of file SGObject.h.

CSGObject::CSGObject ( const CSGObject orig  ) 

Definition at line 58 of file SGObject.h.

virtual CSGObject::~CSGObject (  )  [virtual]

Definition at line 64 of file SGObject.h.


Member Function Documentation

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

get the name of the object

Returns:
name of object

Implemented in CKernelPerceptron, CKNN, CLDA, CLPBoost, CLPM, CPerceptron, CPluginEstimate, CSubGradientLPM, CGMNPLib, CGMNPSVM, CGNPPLib, CGNPPSVM, CGPBTSVM, CLibLinear, CLibSVM, CLibSVMMultiClass, CLibSVMOneClass, CMPDSVM, CQPBSVMLib, CSubGradientSVM, CSVM, CSVMLin, CSVMOcas, CSVMSGD, CTron, 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, CImplicitWeightedSpecFeatures, CLabels, CRealFileFeatures, CSimpleFeatures< ST >, CSparseFeatures< ST >, CStringFeatures< ST >, CTOPFeatures, CWDFeatures, CAUCKernel, CAvgDiagKernelNormalizer, CChi2Kernel, CCombinedKernel, CCommUlongStringKernel, CCommWordStringKernel, CConstKernel, CCustomKernel, CDiagKernel, CDistanceKernel, CFirstElementKernelNormalizer, CFixedDegreeStringKernel, CGaussianKernel, CGaussianShiftKernel, CGaussianShortRealKernel, CHistogramWordStringKernel, CIdentityKernelNormalizer, CLinearByteKernel, CLinearKernel, CLinearStringKernel, CLinearWordKernel, CLocalAlignmentStringKernel, CLocalityImprovedStringKernel, CMatchWordStringKernel, COligoStringKernel, CPolyKernel, CPolyMatchStringKernel, CPolyMatchWordStringKernel, CPyramidChi2, CSalzbergWordStringKernel, CSigmoidKernel, CSimpleLocalityImprovedStringKernel, CSparseGaussianKernel, CSparseLinearKernel, CSparsePolyKernel, CSqrtDiagKernelNormalizer, CTensorProductPairKernel, CWeightedCommWordStringKernel, CWeightedDegreePositionStringKernel, CWeightedDegreeStringKernel, CArray< T >, CBitString, CCache< T >, CCplex, CDynamicArray< T >, CFile, CGCArray< T >, CList< T >, CMath, CMemoryMappedFile< T >, CSimpleFile< T >, CTime, CTrie< Trie >, CPreProc, CKRR, CLibSVR, CDynProg, CPlif, CPlifArray, CSimpleFeatures< float64_t >, CStringFeatures< uint8_t >, CStringFeatures< uint16_t >, CArray< CPlifBase * >, CArray< float64_t >, CArray< int32_t >, CArray< char >, CArray< bool >, CCache< ST >, CCache< float64_t >, CCache< TSparseEntry< ST > >, CCache< KERNELCACHE_ELEM >, CDynamicArray< CPlifBase * >, CDynamicArray< float64_t >, CDynamicArray< int32_t >, CDynamicArray< T_ATTRIBUTE >, CDynamicArray< uint64_t >, CList< CDotFeatures * >, CList< CKernel * >, CList< CFeatures * >, CTrie< DNATrie >, and CTrie< POIMTrie >.

int32_t CSGObject::ref (  ) 

increase reference counter

Returns:
reference count

Definition at line 76 of file SGObject.h.

int32_t CSGObject::ref_count (  )  const

display reference counter

Returns:
reference count

Definition at line 89 of file SGObject.h.

int32_t CSGObject::unref (  ) 

decrement reference counter and deallocate object if refcount is zero before or after decrementing it

Returns:
reference count

Definition at line 100 of file SGObject.h.


Member Data Documentation

Definition at line 179 of file SGObject.h.

Definition at line 180 of file SGObject.h.

Definition at line 181 of file SGObject.h.


The documentation for this class was generated from the following files:

SHOGUN Machine Learning Toolbox - Documentation