Detailed Description

Class to select parameters and their ranges for model selection. The structure is organized as a tree with different kinds of nodes, depending on the values of its member variables of name and CSGObject.

-root node: no name and no CSGObject, may have children

-CSGObject node: has name and a CSGObject, may have children which are the parameters of the CSGObject. CSGObjects are SG_REF'ed/SG_UNREF'ed

-value node: a node with a (parameter) name and an array of values for that parameter. These ranges may be set using build_values(). This node is always a leaf.

After a (legal!) tree is constructed with the append_child method, all possible combinations that are implied by this tree may be extracted with the get_combinations method. It generates a set of trees (different kind than this one) that contain the instantiated parameter combinations.

Definition at line 71 of file ModelSelectionParameters.h.

Inheritance diagram for CModelSelectionParameters:

[legend]

Public Member Functions
	CModelSelectionParameters ()

	CModelSelectionParameters (const char *node_name)

virtual CSGObject *	shallow_copy () const

virtual CSGObject *	deep_copy () const

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="")

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)

bool	has (const std::string &name) const

template<typename T >
bool	has (const Tag< T > &tag) const

template<typename T , typename U = void>
bool	has (const std::string &name) const

template<typename T >
void	set (const Tag< T > &_tag, const T &value)

template<typename T , typename U = void>
void	set (const std::string &name, const T &value)

template<typename T >
T	get (const Tag< T > &_tag) const

template<typename T , typename U = void>
T	get (const std::string &name) const

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

Public Attributes
SGIO *	io

Parallel *	parallel

Version *	version

Parameter *	m_parameters

Parameter *	m_model_selection_parameters

Parameter *	m_gradient_parameters

uint32_t	m_hash

Protected Member Functions
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)

template<typename T >
void	register_param (Tag< T > &_tag, const T &value)

template<typename T >
void	register_param (const std::string &name, const T &value)

name of the parameter of the CSGObject

constructor for a CSGObject node

Parameters

sgobject the CSGObject for this node. Is SG_REF'ed

CModelSelectionParameters (const char *node_name, CSGObject *sgobject)

~CModelSelectionParameters ()

void append_child (CModelSelectionParameters *child)

template<class T >

void set_values (const SGVector< T > &values, EMSParamType value_type)

void print_tree (int prefix_num=0)

CDynamicObjectArray * get_combinations (index_t prefix_num=1)

CParameterCombination * get_single_combination (bool rand=true)

void build_values (float64_t min, float64_t max, ERangeType type, float64_t step=1.0, float64_t type_base=2.0)

void build_values_vector (float64_t min, float64_t max, ERangeType type, void *vector, index_t *size, float64_t step=1.0, float64_t type_base=2.0)

void build_values_sgvector (float64_t min, float64_t max, ERangeType type, void *vector, float64_t step=1.0, float64_t type_base=2.0)

void build_values (int32_t min, int32_t max, ERangeType type, int32_t step=1, int32_t type_base=2)

void build_values_vector (int32_t min, int32_t max, ERangeType type, void *vector, index_t *size, int32_t step=1, int32_t type_base=2)

void build_values_sgvector (int32_t min, int32_t max, ERangeType type, void *vector, int32_t step=1, int32_t type_base=2)

virtual const char * get_name () const

bool has_children () const

Constructor & Destructor Documentation

CModelSelectionParameters ( )

constructor for a root node

Definition at line 22 of file ModelSelectionParameters.cpp.

CModelSelectionParameters ( const char * node_name )

constructor for a value node

Parameters

node_name name of the parameter the values will belong to

Definition at line 27 of file ModelSelectionParameters.cpp.

CModelSelectionParameters	(	const char *	node_name,
		CSGObject *	sgobject
	)

Definition at line 34 of file ModelSelectionParameters.cpp.

~CModelSelectionParameters ( )

destructor. If set, deletes data array and SG_UNREF's the CSGObject

Definition at line 57 of file ModelSelectionParameters.cpp.

Member Function Documentation

void append_child ( CModelSelectionParameters * child )

appends a child to this tree. only possible if this is no value node

Parameters

child child to append

Definition at line 65 of file ModelSelectionParameters.cpp.

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.

Parameters

dict	dictionary of parameters to be built.

Definition at line 630 of file SGObject.cpp.

void build_values	(	float64_t	min,
		float64_t	max,
		ERangeType	type,
		float64_t	step = `1.0`,
		float64_t	type_base = `2.0`
	)

float64_t wrapper for build_values()

Definition at line 106 of file ModelSelectionParameters.cpp.

void build_values	(	int32_t	min,
		int32_t	max,
		ERangeType	type,
		int32_t	step = `1`,
		int32_t	type_base = `2`
	)

int32_t wrapper for build_values()

Definition at line 130 of file ModelSelectionParameters.cpp.

void build_values_sgvector	(	float64_t	min,
		float64_t	max,
		ERangeType	type,
		void *	vector,
		float64_t	step = `1.0`,
		float64_t	type_base = `2.0`
	)

Definition at line 122 of file ModelSelectionParameters.cpp.

void build_values_sgvector	(	int32_t	min,
		int32_t	max,
		ERangeType	type,
		void *	vector,
		int32_t	step = `1`,
		int32_t	type_base = `2`
	)

Definition at line 146 of file ModelSelectionParameters.cpp.

void build_values_vector	(	float64_t	min,
		float64_t	max,
		ERangeType	type,
		void *	vector,
		index_t *	size,
		float64_t	step = `1.0`,
		float64_t	type_base = `2.0`
	)

Definition at line 113 of file ModelSelectionParameters.cpp.

void build_values_vector	(	int32_t	min,
		int32_t	max,
		ERangeType	type,
		void *	vector,
		index_t *	size,
		int32_t	step = `1`,
		int32_t	type_base = `2`
	)

Definition at line 137 of file ModelSelectionParameters.cpp.

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.

Returns: 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

Definition at line 747 of file SGObject.cpp.

CSGObject * deep_copy ( ) const

virtualinherited

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

Definition at line 231 of file SGObject.cpp.

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

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.

Parameters

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

Returns: true if all parameters were equal, false if not

Definition at line 651 of file SGObject.cpp.

T get ( const Tag< T > & _tag ) const

inherited

Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters

_tag	name and type information of parameter

Returns: value of the parameter identified by the input tag

Definition at line 367 of file SGObject.h.

T get ( const std::string & name ) const

inherited

Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters

name	name of the parameter

Returns: value of the parameter corresponding to the input name and type

Definition at line 388 of file SGObject.h.

CDynamicObjectArray * get_combinations ( index_t prefix_num = 1 )

most important method. If the tree was regarding node types and structure, a set of trees which contain all combinations of parameters that are implied by this tree is generated.

Parameters

prefix_num a number of tabs that is put before each output to have a more readable print layout

Returns: result all trees of parameter combinations are put into here

Definition at line 350 of file ModelSelectionParameters.cpp.

SGIO * get_global_io ( )

inherited

get the io object

Returns: io object

Definition at line 268 of file SGObject.cpp.

Parallel * get_global_parallel ( )

inherited

get the parallel object

Returns: parallel object

Definition at line 310 of file SGObject.cpp.

Version * get_global_version ( )

inherited

get the version object

Returns: version object

Definition at line 323 of file SGObject.cpp.

SGStringList< char > get_modelsel_names ( )

inherited

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

Definition at line 531 of file SGObject.cpp.

char * get_modsel_param_descr ( const char * param_name )

inherited

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

Parameters

param_name name of the parameter

Returns: description of the parameter

Definition at line 555 of file SGObject.cpp.

index_t get_modsel_param_index ( const char * param_name )

inherited

Returns index of model selection parameter with provided index

Parameters

param_name name of model selection parameter

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

Definition at line 568 of file SGObject.cpp.

virtual const char* get_name ( ) const

virtual

Returns: name of the SGSerializable

Implements CSGObject.

Definition at line 161 of file ModelSelectionParameters.h.

CParameterCombination * get_single_combination ( bool rand = true )

Instead of generating an array of combinations, get_single_combination generates a single combination of parameters. The choice of values is constrained by the value arrays built by build_values. The choice of values may be random. If not, the lowest possible values are chosen.

Parameters

rand	Is our choice random?

Returns: parameter tree of random parameter values.

Definition at line 207 of file ModelSelectionParameters.cpp.

bool has ( const std::string & name ) const

inherited

Checks if object has a class parameter identified by a name.

Parameters

name	name of the parameter

Returns: true if the parameter exists with the input name

Definition at line 289 of file SGObject.h.

bool has ( const Tag< T > & tag ) const

inherited

Checks if object has a class parameter identified by a Tag.

Parameters

tag	tag of the parameter containing name and type information

Returns: true if the parameter exists with the input tag

Definition at line 301 of file SGObject.h.

bool has ( const std::string & name ) const

inherited

Checks if a type exists for a class parameter identified by a name.

Parameters

name	name of the parameter

Returns: true if the parameter exists with the input name and type

Definition at line 312 of file SGObject.h.

bool has_children ( ) const

protected

checks if this node has children

Returns: true if it has children

Definition at line 181 of file ModelSelectionParameters.h.

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.

Parameters

generic set to the type of the generic if returning TRUE

Returns: TRUE if a class template.

Definition at line 329 of file SGObject.cpp.

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

virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

Parameters

file	where to load from
prefix	prefix for members

Returns: TRUE if done, otherwise FALSE

Definition at line 402 of file SGObject.cpp.

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.

Exceptions

ShogunException will be thrown if an error occurs.

Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.

Definition at line 459 of file SGObject.cpp.

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.

Exceptions

ShogunException will be thrown if an error occurs.

Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 454 of file SGObject.cpp.

bool parameter_hash_changed ( )

virtualinherited

Returns: whether parameter combination has changed since last update

Definition at line 295 of file SGObject.cpp.

void print_modsel_params ( )

inherited

prints all parameter registered for model selection and their type

Definition at line 507 of file SGObject.cpp.

void print_serializable ( const char * prefix = "" )

virtualinherited

prints registered parameters out

Parameters

prefix prefix for members

Definition at line 341 of file SGObject.cpp.

void print_tree ( int prefix_num = 0 )

SG_PRINT's the tree of which this node is the base

Parameters

prefix_num a number of tabs that is put before each output to have a more readable print layout

Definition at line 623 of file ModelSelectionParameters.cpp.

void register_param	(	Tag< T > &	_tag,
		const T &	value
	)

protectedinherited

Registers a class parameter which is identified by a tag. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters

_tag	name and type information of parameter
value	value of the parameter

Definition at line 439 of file SGObject.h.

void register_param	(	const std::string &	name,
		const T &	value
	)

protectedinherited

Registers a class parameter which is identified by a name. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters

name	name of the parameter
value	value of the parameter along with type information

Definition at line 452 of file SGObject.h.

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

virtualinherited

Save this object to file.

Parameters

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

Returns: TRUE if done, otherwise FALSE

Definition at line 347 of file SGObject.cpp.

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.

Exceptions

ShogunException will be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 469 of file SGObject.cpp.

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.

Exceptions

ShogunException will be thrown if an error occurs.

Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 464 of file SGObject.cpp.

void set	(	const Tag< T > &	_tag,
		const T &	value
	)

inherited

Setter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters

_tag	name and type information of parameter
value	value of the parameter

Definition at line 328 of file SGObject.h.

void set	(	const std::string &	name,
		const T &	value
	)

inherited

Setter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters

name	name of the parameter
value	value of the parameter along with type information

Definition at line 354 of file SGObject.h.

void set_generic ( )

inherited

Definition at line 74 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 79 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 84 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 89 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 94 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 99 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 104 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 109 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 114 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 119 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 124 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 129 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 134 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 139 of file SGObject.cpp.

void set_generic ( )

inherited

Definition at line 144 of file SGObject.cpp.

void set_generic ( )

inherited

set generic type to T

void set_global_io ( SGIO * io )

inherited

set the io object

Parameters

io	io object to use

Definition at line 261 of file SGObject.cpp.

void set_global_parallel ( Parallel * parallel )

inherited

set the parallel object

Parameters

parallel parallel object to use

Definition at line 274 of file SGObject.cpp.

void set_global_version ( Version * version )

inherited

set the version object

Parameters

version version object to use

Definition at line 316 of file SGObject.cpp.

void set_values	(	const SGVector< T > &	values,
		EMSParamType	value_type
	)

setter for values of this node. If the latter are not possible to be produced by set_range, a vector may be specified directly.

Parameters

values	value vector. no ref counting takes place here
value_type	type of the provided vector

Definition at line 96 of file ModelSelectionParameters.cpp.

CSGObject * shallow_copy ( ) const

virtualinherited

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

Reimplemented in CGaussianKernel.

Definition at line 225 of file SGObject.cpp.

void unset_generic ( )

inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 336 of file SGObject.cpp.

void update_parameter_hash ( )

virtualinherited

Updates the hash of current parameter combination

Definition at line 281 of file SGObject.cpp.

Member Data Documentation

SGIO* io

inherited

io

Definition at line 537 of file SGObject.h.

Parameter* m_gradient_parameters

inherited

parameters wrt which we can compute gradients

Definition at line 552 of file SGObject.h.

uint32_t m_hash

inherited

Hash of parameter values

Definition at line 555 of file SGObject.h.

Parameter* m_model_selection_parameters

inherited

model selection parameters

Definition at line 549 of file SGObject.h.

Parameter* m_parameters

inherited

parameters

Definition at line 546 of file SGObject.h.

Parallel* parallel

inherited

parallel

Definition at line 540 of file SGObject.h.

Version* version

inherited

version

Definition at line 543 of file SGObject.h.

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

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

name of the parameter of the CSGObject

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation