SHOGUN  4.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends
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 43 of file ParameterCombination.h.

Inheritance diagram for CParameterCombination:
Inheritance graph
[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 ()
 
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)
 
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 void update_parameter_hash ()
 
virtual bool parameter_hash_changed ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)
 
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
 
Parameterm_gradient_parameters
 
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 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

constructor for a root node

Definition at line 22 of file ParameterCombination.cpp.

constructor for a parameter node

Parameters
paramparameter node

Definition at line 27 of file ParameterCombination.cpp.

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
objobject 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 133 of file ParameterCombination.cpp.

Member Function Documentation

void append_child ( CParameterCombination child)

appends a child to this node

Parameters
childchild to append

Definition at line 139 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
machinelearning machine to apply parameter tree to

Definition at line 707 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
parameterParameter instance to apply parameter tree to

Definition at line 712 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
dictdictionary of parameters to be built.

Definition at line 597 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_mapmap, which contains parameters and its parents

Definition at line 807 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_mapmap, which contains parameters and its values

Definition at line 768 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 714 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 681 of file ParameterCombination.cpp.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 198 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
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
Returns
true if all parameters were equal, false if not

Definition at line 618 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
setsset of sets of CParameterCombination instances to search in
desired_nametree with this name is searched
Returns
set of trees with the desired name

Definition at line 651 of file ParameterCombination.cpp.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 235 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 277 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 290 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 498 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_namename of the parameter
Returns
description of the parameter

Definition at line 522 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_namename of model selection parameter
Returns
index of model selection parameter with provided name, -1 if there is no such

Definition at line 535 of file SGObject.cpp.

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

Implements CSGObject.

Definition at line 213 of file ParameterCombination.h.

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

Gets specific parameter by name.

Parameters
nameName of parameter
parentThe CSObject that directly holds this parameter

return specified parameter. NULL if not found.

Definition at line 250 of file ParameterCombination.cpp.

TParameter * get_parameter_helper ( const char *  name)
protected

Gets parameter by name in current node.

Parameters
namename of parameter
Returns
parameter. Null if not found.

Definition at line 234 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 222 of file ParameterCombination.h.

bool has_children ( ) const

checks whether this node has children

Returns
true if node has children

Definition at line 196 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
genericset to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 296 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
setsSet of sets of leafs to combine
new_rootroot node that is copied and put as root into all result trees
Returns
result set of tree combinations

Definition at line 418 of file ParameterCombination.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
filewhere to load from
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 369 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
ShogunExceptionwill be thrown if an error occurs.

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

Definition at line 426 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
ShogunExceptionwill 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 421 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 296 of file ParameterCombination.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
setsset of sets of CParameterCombination instances which represent the trees to be multiplied
new_rootthis 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 539 of file ParameterCombination.cpp.

bool parameter_hash_changed ( )
virtualinherited
Returns
whether parameter combination has changed since last update

Definition at line 262 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_1array of Parameter instances
set_2array of Parameter instances
Returns
result array with all combinations

Definition at line 382 of file ParameterCombination.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 474 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 308 of file SGObject.cpp.

void print_tree ( int  prefix_num = 0) const

Prints a representation of the current node

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

Definition at line 307 of file ParameterCombination.cpp.

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

Save this object to file.

Parameters
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 314 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
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 436 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
ShogunExceptionwill 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 431 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 41 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 46 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 51 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 56 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 61 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 66 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 71 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 76 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 81 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 86 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 91 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 96 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 101 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 106 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 111 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
ioio object to use

Definition at line 228 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 241 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 283 of file SGObject.cpp.

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

Sets specific parameter to specified value.

Parameters
nameName of parameter
valuevalue to be set
parentThe CSObject that directly holds this parameter
indexindex if the parameter is a vector
Returns
bool true if value successfully set.

Definition at line 141 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
namename of parameter
valueof parameter
indexindex if parameter is a vector
Returns
true if found.

Definition at line 144 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
namename of parameter
valueof parameter
indexindex if parameter is a vector
Returns
true if found.

Definition at line 174 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
namename of parameter
valueof parameter
indexindex if parameter is a vector
Returns
true if found.

Definition at line 203 of file ParameterCombination.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 192 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 303 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 248 of file SGObject.cpp.

Friends And Related Function Documentation

friend class CModelSelectionParameters
friend

Definition at line 45 of file ParameterCombination.h.

Member Data Documentation

SGIO* io
inherited

io

Definition at line 369 of file SGObject.h.

CDynamicObjectArray* m_child_nodes
protected

child parameters

Definition at line 311 of file ParameterCombination.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 384 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 387 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 381 of file SGObject.h.

Parameter* m_param
protected

parameter of combination

Definition at line 308 of file ParameterCombination.h.

Parameter* m_parameters
inherited

parameters

Definition at line 378 of file SGObject.h.

uint32_t m_parameters_length
protected

total length of the parameters in combination

Definition at line 314 of file ParameterCombination.h.

Parallel* parallel
inherited

parallel

Definition at line 372 of file SGObject.h.

Version* version
inherited

version

Definition at line 375 of file SGObject.h.


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

SHOGUN Machine Learning Toolbox - Documentation