SHOGUN  v3.0.0
CParameterCombination Class Reference

## Detailed Description

Class that holds ONE combination of parameters for a learning machine. The structure is organized as a tree. Every node may hold a name or an instance of a Parameter class. Nodes may have children. The nodes are organized in such way, that every parameter of a model for model selection has one node and sub-parameters are stored in sub-nodes. Using a tree of this class, parameters of models may easily be set. There are these types of nodes:

-root node: no name and no Parameter instance, every tree has such a node as root. Has children.

-Parameter node: a node with no name and an instance of Parameter, filled with one or more values. There may be different elements in these Parameter instances. Parameter nodes may have children with sub-parameters.

Again: Leafs of the tree may only be Parameter nodes.

Definition at line 41 of file ParameterCombination.h.

Inheritance diagram for CParameterCombination:
[legend]

## Public Member Functions

CParameterCombination ()
CParameterCombination (Parameter *param)
CParameterCombination (CSGObject *obj)
virtual ~CParameterCombination ()
void print_tree (int prefix_num=0) const
void apply_to_modsel_parameter (Parameter *parameter) const
void apply_to_machine (CMachine *machine) const
void append_child (CParameterCombination *child)
void merge_with (CParameterCombination *node)
CParameterCombinationcopy_tree () const
template<typename T >
bool set_parameter (const char *name, T value, CSGObject *parent, index_t index=-1)
TParameterget_parameter (const char *name, CSGObject *parent)
bool has_children () const
virtual const char * get_name () const
virtual uint32_t get_parameters_length ()
virtual void build_parameter_values_map (CMap< TParameter *, SGVector< float64_t > > *values_map)
virtual void build_parameter_parent_map (CMap< TParameter *, CSGObject * > *parent_map)
virtual CSGObjectshallow_copy () const
virtual CSGObjectdeep_copy () const
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="", 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)
SGIOget_global_io ()
void set_global_parallel (Parallel *parallel)
Parallelget_global_parallel ()
void set_global_version (Version *version)
Versionget_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 CSGObjectclone ()

## Static Public Member Functions

static CDynamicObjectArrayleaf_sets_multiplication (const CDynamicObjectArray &sets, const CParameterCombination *new_root)
static DynArray< Parameter * > * parameter_set_multiplication (const DynArray< Parameter * > &set_1, const DynArray< Parameter * > &set_2)

## Public Attributes

SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
ParameterMapm_parameter_map
uint32_t m_hash

## Protected Member Functions

TParameterget_parameter_helper (const char *name)
bool set_parameter_helper (const char *name, bool value, index_t index)
bool set_parameter_helper (const char *name, int32_t value, index_t index)
bool set_parameter_helper (const char *name, float64_t value, index_t index)
virtual TParametermigrate (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)

## Static Protected Member Functions

static CDynamicObjectArraynon_value_tree_multiplication (const CDynamicObjectArray *sets, const CParameterCombination *new_root)
static CDynamicObjectArrayextract_trees_with_name (const CDynamicObjectArray *sets, const char *desired_name)

## Protected Attributes

Parameterm_param
CDynamicObjectArraym_child_nodes
uint32_t m_parameters_length

## Friends

class CModelSelectionParameters

## Constructor & Destructor Documentation

 CParameterCombination ( )

constructor for a root node

Definition at line 22 of file ParameterCombination.cpp.

 CParameterCombination ( Parameter * param )

constructor for a parameter node

Parameters
 param parameter node

Definition at line 27 of file ParameterCombination.cpp.

 CParameterCombination ( CSGObject * obj )

constructor for an object. Builds parameter combination of the gradient parameters.

It adds parameters recursively starting from given object (given object becomes the root node).

Parameters
 obj object to build parameter combination

Definition at line 34 of file ParameterCombination.cpp.

 ~CParameterCombination ( )
virtual

destructor also recursively destroys complete tree (SG_UNREF of child nodes)

Definition at line 118 of file ParameterCombination.cpp.

## Member Function Documentation

 void append_child ( CParameterCombination * child )

appends a child to this node

Parameters
 child child to append

Definition at line 124 of file ParameterCombination.cpp.

 void apply_to_machine ( CMachine * machine ) const

applies this parameter tree to a learning machine (wrapper for apply_to_modesel_parameter() method)

Parameters
 machine learning machine to apply parameter tree to

Definition at line 696 of file ParameterCombination.cpp.

 void apply_to_modsel_parameter ( Parameter * parameter ) const

applies this parameter tree to a parameter instance

Recursively iterates over all children of the tree and sets model selection parameters of children to sub-parameters

Parameters
 parameter Parameter instance to apply parameter tree to

Definition at line 701 of file ParameterCombination.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 1196 of file SGObject.cpp.

 void build_parameter_parent_map ( CMap< TParameter *, CSGObject * > * parent_map )
virtual

builds map, which contains parameters and its parents

Parameters
 parent_map map, which contains parameters and its parents

Definition at line 795 of file ParameterCombination.cpp.

 void build_parameter_values_map ( CMap< TParameter *, SGVector< float64_t > > * values_map )
virtual

builds map, which contains parameters and its values.

This method adds to map only parameters of floating point type.

Parameters
 values_map map, which contains parameters and its values

Definition at line 757 of file ParameterCombination.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 1313 of file SGObject.cpp.

 CParameterCombination * copy_tree ( ) const

Copies the complete tree of this node. Note that nodes are actually copied. If this is a parameter node, a NEW Parameter instance to the same data is created in the copy

Returns
copy of the tree with this node as root as described above

Definition at line 670 of file ParameterCombination.cpp.

 virtual CSGObject* deep_copy ( ) const
virtualinherited

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

Definition at line 160 of file SGObject.h.

 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.

Parameters
 other object to compare with accuracy accuracy to use for comparison (optional)
Returns
true if all parameters were equal, false if not

Definition at line 1217 of file SGObject.cpp.

 CDynamicObjectArray * extract_trees_with_name ( const CDynamicObjectArray * sets, const char * desired_name )
staticprotected

Takes a set of sets of trees and extracts all trees with a given name. Assumes that in a (inner) set, all trees have the same name on their single parameter. Used by get_combinations

Parameters
 sets set of sets of CParameterCombination instances to search in desired_name tree with this name is searched
Returns
set of trees with the desired name

Definition at line 640 of file ParameterCombination.cpp.

 SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 214 of file SGObject.cpp.

 Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 249 of file SGObject.cpp.

 Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 262 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 1100 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 1124 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 1137 of file SGObject.cpp.

 virtual const char* get_name ( ) const
virtual
Returns
name of the SGSerializable

Implements CSGObject.

Definition at line 211 of file ParameterCombination.h.

 TParameter * get_parameter ( const char * name, CSGObject * parent )

Gets specific parameter by name.

Parameters
 name Name of parameter parent The CSObject that directly holds this parameter

Definition at line 235 of file ParameterCombination.cpp.

 TParameter * get_parameter_helper ( const char * name )
protected

Gets parameter by name in current node.

Parameters
 name name of parameter
Returns

Definition at line 219 of file ParameterCombination.cpp.

 virtual uint32_t get_parameters_length ( )
virtual

returns total length of the parameters in combination

Returns
total length of the parameters in combination

Definition at line 220 of file ParameterCombination.h.

 bool has_children ( ) const

checks whether this node has children

Returns
true if node has children

Definition at line 194 of file ParameterCombination.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 268 of file SGObject.cpp.

 CDynamicObjectArray * leaf_sets_multiplication ( const CDynamicObjectArray & sets, const CParameterCombination * new_root )
static

Takes a set of sets of leafs nodes (!) and produces a set of instances of this class that contain every combination of the parameters in the leaf nodes in their Parameter variables. All combinations are put into a newly created tree. The root of this tree will be a copy of a specified node

created Parameter instances are added to the result set.

Parameters
 sets Set of sets of leafs to combine new_root root node that is copied and put as root into all result trees
Returns
result set of tree combinations

Definition at line 407 of file ParameterCombination.cpp.

 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)

Parameters
 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
Returns
(sorted) array of created TParameter instances with file data

Definition at line 673 of file SGObject.cpp.

 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

Parameters
 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
Returns
new array with TParameter instances with the attached data

Definition at line 514 of file SGObject.cpp.

 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!

Parameters
 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)
Returns
TRUE if done, otherwise FALSE

Definition at line 345 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 occurres.

Definition at line 1029 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 occurres.

Definition at line 1024 of file SGObject.cpp.

 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

Parameters
 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

Definition at line 711 of file SGObject.cpp.

 void merge_with ( CParameterCombination * node )

Adds (copies of) all children of given node

Parameters
 node (copies of) children of given node are added to this one

Definition at line 281 of file ParameterCombination.cpp.

 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

Parameters
 param_base set of TParameter instances to use for migration target parameter info for the resulting TParameter
Returns
a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

Definition at line 918 of file SGObject.cpp.

 CDynamicObjectArray * non_value_tree_multiplication ( const CDynamicObjectArray * sets, const CParameterCombination * new_root )
staticprotected

Takes a set of sets of (non-value) trees and returns a set with all combinations of the elements, where only combinations of trees with different names are built.

Parameters
 sets set of sets of CParameterCombination instances which represent the trees to be multiplied new_root this new root is put in front of all products
Returns
set of trees with the given root as root and all combinations of the trees in the sets as children

Definition at line 528 of file ParameterCombination.cpp.

 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)

Parameters
 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

Definition at line 858 of file SGObject.cpp.

 DynArray< Parameter * > * parameter_set_multiplication ( const DynArray< Parameter * > & set_1, const DynArray< Parameter * > & set_2 )
static

Returns a newly created array with pointers to newly created Parameter instances, which contain all combinations of the provided Parameters.

Parameters
 set_1 array of Parameter instances set_2 array of Parameter instances
Returns
result array with all combinations

Definition at line 371 of file ParameterCombination.cpp.

 void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 1076 of file SGObject.cpp.

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

prints registered parameters out

Parameters
 prefix prefix for members

Definition at line 280 of file SGObject.cpp.

 void print_tree ( int prefix_num = 0 ) const

Prints a representation of the current node

Parameters
 prefix_num number of tabs that will be prefixed for every output. At each recursion level, one is added.

Definition at line 292 of file ParameterCombination.cpp.

 bool save_serializable ( CSerializableFile * file, const char * prefix = "", int32_t param_version = Version::get_version_parameter() )
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 param_version (optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Definition at line 286 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 occurres.

Reimplemented in CKernel.

Definition at line 1039 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 occurres.

Definition at line 1034 of file SGObject.cpp.

 void set_generic< complex128_t > ( )
inherited

set generic type to T

Definition at line 41 of file SGObject.cpp.

 void set_global_io ( SGIO * io )
inherited

set the io object

Parameters
 io io object to use

Definition at line 207 of file SGObject.cpp.

 void set_global_parallel ( Parallel * parallel )
inherited

set the parallel object

Parameters
 parallel parallel object to use

Definition at line 220 of file SGObject.cpp.

 void set_global_version ( Version * version )
inherited

set the version object

Parameters
 version version object to use

Definition at line 255 of file SGObject.cpp.

 bool set_parameter ( const char * name, T value, CSGObject * parent, index_t index = -1 )

Sets specific parameter to specified value.

Parameters
 name Name of parameter value value to be set parent The CSObject that directly holds this parameter index index if the parameter is a vector
Returns
bool true if value successfully set.

Definition at line 139 of file ParameterCombination.h.

 bool set_parameter_helper ( const char * name, bool value, index_t index )
protected

Sets parameter by name in current node.

Parameters
 name name of parameter value of parameter index index if parameter is a vector
Returns
true if found.

Definition at line 129 of file ParameterCombination.cpp.

 bool set_parameter_helper ( const char * name, int32_t value, index_t index )
protected

Sets parameter by name in current node.

Parameters
 name name of parameter value of parameter index index if parameter is a vector
Returns
true if found.

Definition at line 159 of file ParameterCombination.cpp.

 bool set_parameter_helper ( const char * name, float64_t value, index_t index )
protected

Sets parameter by name in current node.

Parameters
 name name of parameter value of parameter index index if parameter is a vector
Returns
true if found.

Definition at line 188 of file ParameterCombination.cpp.

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

 void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 275 of file SGObject.cpp.

 bool update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination.

Returns
bool if parameter combination has changed since last update.

Definition at line 227 of file SGObject.cpp.

## Friends And Related Function Documentation

 friend class CModelSelectionParameters
friend

Definition at line 43 of file ParameterCombination.h.

## Member Data Documentation

 SGIO* io
inherited

io

Definition at line 514 of file SGObject.h.

 CDynamicObjectArray* m_child_nodes
protected

child parameters

Definition at line 309 of file ParameterCombination.h.

inherited

parameters wrt which we can compute gradients

Definition at line 529 of file SGObject.h.

 uint32_t m_hash
inherited

Hash of parameter values

Definition at line 535 of file SGObject.h.

 Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 526 of file SGObject.h.

 Parameter* m_param
protected

parameter of combination

Definition at line 306 of file ParameterCombination.h.

 ParameterMap* m_parameter_map
inherited

map for different parameter versions

Definition at line 532 of file SGObject.h.

 Parameter* m_parameters
inherited

parameters

Definition at line 523 of file SGObject.h.

 uint32_t m_parameters_length
protected

total length of the parameters in combination

Definition at line 312 of file ParameterCombination.h.

 Parallel* parallel
inherited

parallel

Definition at line 517 of file SGObject.h.

 Version* version
inherited

version

Definition at line 520 of file SGObject.h.

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

SHOGUN Machine Learning Toolbox - Documentation