详细描述

Abstract base class for all splitting types. Takes a CLabels instance and generates a desired number of subsets which are being accessed by their indices via the method generate_subset_indices(...).

When being extended, the abstract method build_subsets() has to be implemented. build_subsets implementations HAVE TO call reset_subsets before, in order to allow calling them from the outside. Also they HAVE to set the m_is_filled flag to true (otherwise there will be an error when accessing the index sets)

Implementations have to (re)fill the CDynamicArray<index_t> elements in the (inherited) m_subset_indices variable. Note that these elements are already created by the constructor of this class - they just have to be filled. Every element represents one index subset.

Calling the method agains means that the indices are rebuilt.

在文件 SplittingStrategy.h 第 40 行定义.

类 CSplittingStrategy 继承关系图:

[图例]

Public 成员函数
	CSplittingStrategy ()

	CSplittingStrategy (CLabels *labels, index_t num_subsets)

virtual	~CSplittingStrategy ()

SGVector< index_t >	generate_subset_indices (index_t subset_idx)

SGVector< index_t >	generate_subset_inverse (index_t subset_idx)

index_t	get_num_subsets () const

virtual void	build_subsets ()=0

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

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

void	unset_generic ()

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

virtual bool	save_serializable (CSerializableFile file, const char prefix="", int32_t param_version=Version::get_version_parameter())

virtual bool	load_serializable (CSerializableFile file, const char prefix="", int32_t param_version=Version::get_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)

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

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

virtual CSGObject *	clone ()

Public 属性
SGIO *	io

Parallel *	parallel

Version *	version

Parameter *	m_parameters

Parameter *	m_model_selection_parameters

Parameter *	m_gradient_parameters

ParameterMap *	m_parameter_map

uint32_t	m_hash

Protected 成员函数
void	reset_subsets ()

virtual TParameter *	migrate (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)

Protected 属性
CLabels *	m_labels

CDynamicObjectArray *	m_subset_indices

index_t	m_num_subsets

bool	m_is_filled

构造及析构函数说明

CSplittingStrategy ( )

constructor

在文件 SplittingStrategy.cpp 第 16 行定义.

CSplittingStrategy	(	CLabels *	labels,
		index_t	num_subsets
	)

constructor

参数

labels	labels to be (possibly) used for splitting
num_subsets	desired number of subsets, the labels are split into

在文件 SplittingStrategy.cpp 第 21 行定义.

~CSplittingStrategy ( )

virtual

destructor

在文件 SplittingStrategy.cpp 第 70 行定义.

成员函数说明

void build_gradient_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.

参数

dict	dictionary of parameters to be built.

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

virtual void build_subsets ( )

pure virtual

Abstract method. Has to refill the elements of the m_subset_indices variable with concrete indices. Note that CDynamicArray<index_t> instances for every subset are created in the constructor of this class - they just have to be filled.

在 CStratifiedCrossValidationSplitting , 以及 CCrossValidationSplitting 内被实现.

CSGObject * clone ( )

virtualinherited

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 第 1312 行定义.

virtual CSGObject* deep_copy ( ) const

virtualinherited

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

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

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

virtualinherited

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)

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

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

SGVector< index_t > generate_subset_indices ( index_t subset_idx )

generates a newly created SGVector<index_t> with indices of the subset with the desired index

参数

subset_idx subset index of the to be generated vector indices

返回: newly created vector of subset indices of the specified subset is written here.

Error if there are no index sets

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

SGVector< index_t > generate_subset_inverse ( index_t subset_idx )

generates a newly created SGVector<index_t> with inverse indices of the subset with the desired index. inverse here means all other indices.

参数

subset_idx subset index of the to be generated inverse indices

返回: newly created vector of the subset's inverse indices is written here.

Error if there are no index sets

在文件 SplittingStrategy.cpp 第 100 行定义.

SGIO * get_global_io ( )

inherited

get the io object

返回: io object

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

Parallel * get_global_parallel ( )

inherited

get the parallel object

返回: parallel object

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

Version * get_global_version ( )

inherited

get the version object

返回: version object

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

SGStringList< char > get_modelsel_names ( )

inherited

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

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

char * get_modsel_param_descr ( const char * param_name )

inherited

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 第 1123 行定义.

index_t get_modsel_param_index ( const char * param_name )

inherited

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 第 1136 行定义.

virtual const char* get_name ( ) const

pure virtualinherited

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

返回: name of the SGSerializable

index_t get_num_subsets ( ) const

返回: number of subsets.

在文件 SplittingStrategy.cpp 第 128 行定义.

bool is_generic ( EPrimitiveType * generic ) const

virtualinherited

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 第 267 行定义.

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)

参数

file_version	parameter version of the file
current_version	version from which mapping begins (you want to use Version::get_version_parameter() for this in most cases)
file	file to load from
prefix	prefix for members

返回: (sorted) array of created TParameter instances with file data

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

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

参数

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

返回: new array with TParameter instances with the attached data

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

bool load_serializable	(	CSerializableFile *	file,
		const char *	prefix = `""`,
		int32_t	param_version = `Version::get_version_parameter()`
	)

virtualinherited

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
param_version	(optional) a parameter version different to (this is mainly for testing, better do not use)

返回: TRUE if done, otherwise FALSE

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

void load_serializable_post	(		)
throw	(	ShogunException
	)

protectedvirtualinherited

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

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

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

void load_serializable_pre	(		)
throw	(	ShogunException
	)

protectedvirtualinherited

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

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

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

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

参数

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

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

TParameter * migrate	(	DynArray< TParameter * > *	param_base,
		const SGParamInfo *	target
	)

protectedvirtualinherited

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

参数

param_base	set of TParameter instances to use for migration
target	parameter info for the resulting TParameter

返回: a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

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

void one_to_one_migration_prepare	(	DynArray< TParameter * > *	param_base,
		const SGParamInfo *	target,
		TParameter *&	replacement,
		TParameter *&	to_migrate,
		char *	old_name = `NULL`
	)

protectedvirtualinherited

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)

参数

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

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

void print_modsel_params ( )

inherited

prints all parameter registered for model selection and their type

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

void print_serializable ( const char * prefix = "" )

virtualinherited

prints registered parameters out

参数

prefix prefix for members

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

void reset_subsets ( )

protected

resets the current subsets, meaning that all the arrays of indices will be empty again. To be called before build_subsets.

在文件 SplittingStrategy.cpp 第 40 行定义.

bool save_serializable	(	CSerializableFile *	file,
		const char *	prefix = `""`,
		int32_t	param_version = `Version::get_version_parameter()`
	)

virtualinherited

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
param_version	(optional) a parameter version different to (this is mainly for testing, better do not use)

返回: TRUE if done, otherwise FALSE

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

void save_serializable_post	(		)
throw	(	ShogunException
	)

protectedvirtualinherited

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

被 CKernel 重载.

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

void save_serializable_pre	(		)
throw	(	ShogunException
	)

protectedvirtualinherited

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

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

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

void set_generic ( )

inherited

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

void set_generic ( )

inherited

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

void set_generic ( )

inherited

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

void set_generic ( )

inherited

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

void set_generic ( )

inherited

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

void set_generic ( )

inherited

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

void set_generic ( )

inherited

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

void set_generic ( )

inherited

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

void set_generic ( )

inherited

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

void set_generic ( )

inherited

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

void set_generic ( )

inherited

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

void set_generic ( )

inherited

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

void set_generic ( )

inherited

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

void set_generic ( )

inherited

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

void set_generic ( )

inherited

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

void set_generic ( )

inherited

set generic type to T

void set_global_io ( SGIO * io )

inherited

set the io object

参数

io	io object to use

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

void set_global_parallel ( Parallel * parallel )

inherited

set the parallel object

参数

parallel parallel object to use

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

void set_global_version ( Version * version )

inherited

set the version object

参数

version version object to use

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

virtual CSGObject* shallow_copy ( ) const

virtualinherited

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

被 CGaussianKernel 重载.

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

void unset_generic ( )

inherited

unset generic type

this has to be called in classes specializing a template class

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

bool update_parameter_hash ( )

virtualinherited

Updates the hash of current parameter combination.

返回: bool if parameter combination has changed since last update.

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

类成员变量说明

SGIO* io

inherited

io

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

Parameter* m_gradient_parameters

inherited

parameters wrt which we can compute gradients

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

uint32_t m_hash

inherited

Hash of parameter values

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

bool m_is_filled

protected

flag to check whether there is a set of index sets stored. If not, call build_subsets()

在文件 SplittingStrategy.h 第 110 行定义.

CLabels* m_labels

protected

labels

在文件 SplittingStrategy.h 第 100 行定义.

Parameter* m_model_selection_parameters

inherited

model selection parameters

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

index_t m_num_subsets

protected

additional variable to store number of index subsets

在文件 SplittingStrategy.h 第 106 行定义.

ParameterMap* m_parameter_map

inherited

map for different parameter versions

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

Parameter* m_parameters

inherited

parameters

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

CDynamicObjectArray* m_subset_indices

protected

subset indices

在文件 SplittingStrategy.h 第 103 行定义.

Parallel* parallel

inherited

parallel

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

Version* version

inherited

version

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

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

详细描述

Public 成员函数

Public 属性

Protected 成员函数

Protected 属性

构造及析构函数说明

成员函数说明

类成员变量说明