详细描述

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:

parallel - to determine the number of used CPUs for a method (cf. Parallel)
io - to output messages and general i/o (cf. IO)
version - to provide version information of the shogun version used (cf. Version)

All objects can be cloned and compared (deep copy, recursively)

在文件 SGObject.h 第 112 行定义.

被 CCache< char >, CCache< float64_t >, CCache< KERNELCACHE_ELEM >, CCache< shogun::SGSparseVectorEntry< float64_t > >, CCache< shogun::SGSparseVectorEntry< ST > >, CCache< shogun::SGSparseVectorEntry< T > >, CCache< ST >, CCache< uint16_t >, CCache< uint32_t >, CCache< uint8_t >, CDynamicArray< bool >, CDynamicArray< char >, CDynamicArray< float32_t >, CDynamicArray< float64_t >, CDynamicArray< int32_t >, CEMBase< MixModelData >, CLinearOperator< complex128_t >, CLinearOperator< float64_t >, CLinearSolver< complex128_t, float64_t >, CLinearSolver< float64_t, float64_t >, CLinearSolver< T, T >, CMap< shogun::TParameter *, shogun::CSGObject * >, CMap< shogun::TParameter *, shogun::SGVector< float64_t > >, CMap< std::string, float64_t >, CMap< std::string, int32_t >, CMap< std::string, shogun::SGVector< float64_t > >, CMap< std::string, T >, CMemoryMappedFile< ST >, COperatorFunction< float64_t >, CTreeMachineNode< C45TreeNodeData >, CTreeMachineNode< CARTreeNodeData >, CTreeMachineNode< CHAIDTreeNodeData >, CTreeMachineNode< ConditionalProbabilityTreeNodeData >, CTreeMachineNode< id3TreeNodeData >, CTreeMachineNode< NbodyTreeNodeData >, CTreeMachineNode< RelaxedTreeNodeData >, CTreeMachineNode< VwConditionalProbabilityTreeNodeData >, CTrie< DNATrie >, CTrie< POIMTrie >, CAlphabet, CApproxJointDiagonalizer, CBinaryStream< T >, CBitString, CCache< T >, CCircularBuffer, CCombinationRule, CCompressor, CConverter, CCplex, CCrossValidationOutput, CData, CDataGenerator, CDeepBeliefNetwork, CDifferentiableFunction, CDisjointSet, CDistance, CDistribution, CDynamicArray< T >, CDynamicObjectArray, CDynProg, CECOCDecoder, CECOCEncoder, CEigenSolver, CEMBase< T >, CEvaluation, CEvaluationResult, CFactor, CFactorDataSource, CFactorGraph, CFactorGraphDataGenerator, CFactorType, CFeatures, CFile, CFunction, CGCArray< T >, CGMNPLib, CGNPPLib, CGUIClassifier, CGUIConverter, CGUIDistance, CGUIFeatures, CGUIHMM, CGUIKernel, CGUILabels, CGUIMath, CGUIPluginEstimate, CGUIPreprocessor, CGUIStructure, CGUITime, CHash, CHypothesisTest, CIndependentComputationEngine, CIndependentJob, CIndexBlock, CIndexBlockRelation, CIntegration, CIntronList, CIOBuffer, CJacobiEllipticFunctions, CJobResult, CJobResultAggregator, CKernel, CKernelMeanMatching, CKernelNormalizer, CKernelSelection, CLabels, CLabelsFactory, CLatentModel, CLikelihoodModel, CLinearOperator< T >, CLinearSolver< T, ST >, CLineReader, CList, CListElement, CLMNN, CLMNNStatistics, CLogDetEstimator, CLossFunction, CMachine, CMachineEvaluation, CMap< K, T >, CMAPInference, CMAPInferImpl, CMath, CMeanFunction, CMemoryMappedFile< T >, CMinimizerContext, CModelSelection, CModelSelectionParameters, CMulticlassStrategy, CNeuralLayer, CNeuralLayers, CNode, COperatorFunction< T >, CParameterCombination, CParser, CPlifBase, CPlifMatrix, CPreprocessor, CProbabilityDistribution, CQPBSVMLib, CRandom, CRBM, CRejectionStrategy, CResultSet, CSegmentLoss, CSerializableFile, CSerializableFile::TSerializableReader, CSet< T >, CSignal, CSimpleFile< T >, CSOSVMHelper, CSparseInverseCovariance, CSplittingStrategy, CStateModel, CStatistics, CStreamingFile, CStructuredData, CStructuredModel, CSubset, CSubsetStack, CTask, CTaskRelation, CTaxonomy, CTime, CTokenizer, CTraceSampler, CTreeMachineNode< T >, CTrie< Trie >, CVwCacheReader, CVwCacheWriter, CVwEnvironment, CVwLearner, CVwParser, CVwRegressor , 以及 MKLMulticlassOptimizationBase 继承.

Public 成员函数
	CSGObject ()

	CSGObject (const CSGObject &orig)

virtual	~CSGObject ()

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 ()

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_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 void	update_parameter_hash ()

virtual bool	parameter_hash_changed ()

virtual bool	equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)

virtual CSGObject *	clone ()

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 ()

Public 属性
SGIO *	io

Parallel *	parallel

Version *	version

Parameter *	m_parameters

Parameter *	m_model_selection_parameters

Parameter *	m_gradient_parameters

uint32_t	m_hash

Protected 成员函数
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)

构造及析构函数说明

CSGObject ( )

default constructor

在文件 SGObject.cpp 第 120 行定义.

CSGObject ( const CSGObject & orig )

copy constructor

在文件 SGObject.cpp 第 129 行定义.

~CSGObject ( )

virtual

destructor

在文件 SGObject.cpp 第 139 行定义.

成员函数说明

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

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.

参数

dict	dictionary of parameters to be built.

在文件 SGObject.cpp 第 597 行定义.

CSGObject * clone ( )

virtual

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.

返回: 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

在文件 SGObject.cpp 第 714 行定义.

CSGObject * deep_copy ( ) const

virtual

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

在文件 SGObject.cpp 第 198 行定义.

bool equals	(	CSGObject *	other,
		float64_t	accuracy = `0.0`,
		bool	tolerant = `false`
	)

virtual

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.

参数

other	object to compare with
accuracy	accuracy to use for comparison (optional)
tolerant	allows linient check on float equality (within accuracy)

返回: true if all parameters were equal, false if not

在文件 SGObject.cpp 第 618 行定义.

SGIO * get_global_io ( )

get the io object

返回: io object

在文件 SGObject.cpp 第 235 行定义.

Parallel * get_global_parallel ( )

get the parallel object

返回: parallel object

在文件 SGObject.cpp 第 277 行定义.

Version * get_global_version ( )

get the version object

返回: version object

在文件 SGObject.cpp 第 290 行定义.

SGStringList< char > get_modelsel_names ( )

返回: vector of names of all parameters which are registered for model selection

在文件 SGObject.cpp 第 498 行定义.

char * get_modsel_param_descr ( const char * param_name )

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

参数

param_name name of the parameter

返回: description of the parameter

在文件 SGObject.cpp 第 522 行定义.

index_t get_modsel_param_index ( const char * param_name )

Returns index of model selection parameter with provided index

参数

param_name name of model selection parameter

返回: index of model selection parameter with provided name, -1 if there is no such

在文件 SGObject.cpp 第 535 行定义.

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

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.

参数

generic set to the type of the generic if returning TRUE

返回: TRUE if a class template.

在文件 SGObject.cpp 第 296 行定义.

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!

参数

file	where to load from
prefix	prefix for members

返回: TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 369 行定义.

void load_serializable_post	(		)
throw	(	ShogunException
	)

protectedvirtual

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.

异常

ShogunException will be thrown if an error occurs.

被 CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.

在文件 SGObject.cpp 第 426 行定义.

void load_serializable_pre	(		)
throw	(	ShogunException
	)

protectedvirtual

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.

异常

ShogunException will be thrown if an error occurs.

被 CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp 第 421 行定义.

bool parameter_hash_changed ( )

virtual

返回: whether parameter combination has changed since last update

在文件 SGObject.cpp 第 262 行定义.

void print_modsel_params ( )

prints all parameter registered for model selection and their type

在文件 SGObject.cpp 第 474 行定义.

void print_serializable ( const char * prefix = "" )

virtual

prints registered parameters out

参数

prefix prefix for members

在文件 SGObject.cpp 第 308 行定义.

bool save_serializable	(	CSerializableFile *	file,
		const char *	prefix = `""`
	)

virtual

Save this object to file.

参数

file	where to save the object; will be closed during returning if PREFIX is an empty string.
prefix	prefix for members

返回: TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 314 行定义.

void save_serializable_post	(		)
throw	(	ShogunException
	)

protectedvirtual

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.

异常

ShogunException will be thrown if an error occurs.

被 CKernel 重载.

在文件 SGObject.cpp 第 436 行定义.

void save_serializable_pre	(		)
throw	(	ShogunException
	)

protectedvirtual

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.

异常

ShogunException will be thrown if an error occurs.

被 CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp 第 431 行定义.

void set_generic ( )

在文件 SGObject.cpp 第 41 行定义.

void set_generic ( )

在文件 SGObject.cpp 第 46 行定义.

void set_generic ( )

在文件 SGObject.cpp 第 51 行定义.

void set_generic ( )

在文件 SGObject.cpp 第 56 行定义.

void set_generic ( )

在文件 SGObject.cpp 第 61 行定义.

void set_generic ( )

在文件 SGObject.cpp 第 66 行定义.

void set_generic ( )

在文件 SGObject.cpp 第 71 行定义.

void set_generic ( )

在文件 SGObject.cpp 第 76 行定义.

void set_generic ( )

在文件 SGObject.cpp 第 81 行定义.

void set_generic ( )

在文件 SGObject.cpp 第 86 行定义.

void set_generic ( )

在文件 SGObject.cpp 第 91 行定义.

void set_generic ( )

在文件 SGObject.cpp 第 96 行定义.

void set_generic ( )

在文件 SGObject.cpp 第 101 行定义.

void set_generic ( )

在文件 SGObject.cpp 第 106 行定义.

void set_generic ( )

在文件 SGObject.cpp 第 111 行定义.

void set_generic ( )

set generic type to T

void set_global_io ( SGIO * io )

set the io object

参数

io	io object to use

在文件 SGObject.cpp 第 228 行定义.

void set_global_parallel ( Parallel * parallel )

set the parallel object

参数

parallel parallel object to use

在文件 SGObject.cpp 第 241 行定义.

void set_global_version ( Version * version )

set the version object

参数

version version object to use

在文件 SGObject.cpp 第 283 行定义.

CSGObject * shallow_copy ( ) const

virtual

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

被 CGaussianKernel 重载.

在文件 SGObject.cpp 第 192 行定义.

void unset_generic ( )

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp 第 303 行定义.

void update_parameter_hash ( )

virtual

Updates the hash of current parameter combination

在文件 SGObject.cpp 第 248 行定义.

类成员变量说明

SGIO* io

io

在文件 SGObject.h 第 369 行定义.

Parameter* m_gradient_parameters

parameters wrt which we can compute gradients

在文件 SGObject.h 第 384 行定义.

uint32_t m_hash

Hash of parameter values

在文件 SGObject.h 第 387 行定义.

Parameter* m_model_selection_parameters

model selection parameters

在文件 SGObject.h 第 381 行定义.

Parameter* m_parameters

parameters

在文件 SGObject.h 第 378 行定义.

Parallel* parallel

parallel

在文件 SGObject.h 第 372 行定义.

Version* version

version

在文件 SGObject.h 第 375 行定义.

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

详细描述

Public 成员函数

Public 属性

Protected 成员函数

构造及析构函数说明

成员函数说明

类成员变量说明