SHOGUN
4.1.0
|
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.
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) |
CParameterCombination * | copy_tree () const |
template<typename T > | |
bool | set_parameter (const char *name, T value, CSGObject *parent, index_t index=-1) |
TParameter * | get_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 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) |
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 () |
Static Public Member Functions | |
static CDynamicObjectArray * | leaf_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 | |
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 | |
TParameter * | get_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 CDynamicObjectArray * | non_value_tree_multiplication (const CDynamicObjectArray *sets, const CParameterCombination *new_root) |
static CDynamicObjectArray * | extract_trees_with_name (const CDynamicObjectArray *sets, const char *desired_name) |
Protected Attributes | |
Parameter * | m_param |
CDynamicObjectArray * | m_child_nodes |
uint32_t | m_parameters_length |
Friends | |
class | CModelSelectionParameters |
constructor for a root node
Definition at line 22 of file ParameterCombination.cpp.
CParameterCombination | ( | Parameter * | param | ) |
constructor for a parameter node
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).
obj | object to build parameter combination |
Definition at line 34 of file ParameterCombination.cpp.
|
virtual |
destructor also recursively destroys complete tree (SG_UNREF of child nodes)
Definition at line 133 of file ParameterCombination.cpp.
void append_child | ( | CParameterCombination * | child | ) |
appends a child to this node
child | child 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)
machine | learning 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
parameter | Parameter instance to apply parameter tree to |
Definition at line 712 of file ParameterCombination.cpp.
|
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. |
Definition at line 597 of file SGObject.cpp.
|
virtual |
builds map, which contains parameters and its parents
parent_map | map, which contains parameters and its parents |
Definition at line 807 of file ParameterCombination.cpp.
|
virtual |
builds map, which contains parameters and its values.
This method adds to map only parameters of floating point type.
values_map | map, which contains parameters and its values |
Definition at line 768 of file ParameterCombination.cpp.
|
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.
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
Definition at line 681 of file ParameterCombination.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 198 of file SGObject.cpp.
Recursively compares the current SGObject to another one. Compares all registered numerical parameters, recursion upon complex (SGObject) parameters. Does not compare pointers!
May be overwritten but please do with care! Should not be necessary in most cases.
other | object to compare with |
accuracy | accuracy to use for comparison (optional) |
tolerant | allows linient check on float equality (within accuracy) |
Definition at line 618 of file SGObject.cpp.
|
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
sets | set of sets of CParameterCombination instances to search in |
desired_name | tree with this name is searched |
Definition at line 651 of file ParameterCombination.cpp.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Definition at line 498 of file SGObject.cpp.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
param_name | name of the parameter |
Definition at line 522 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 535 of file SGObject.cpp.
|
virtual |
Implements CSGObject.
Definition at line 213 of file ParameterCombination.h.
TParameter * get_parameter | ( | const char * | name, |
CSGObject * | parent | ||
) |
Gets specific parameter by name.
name | Name of parameter |
parent | The CSObject that directly holds this parameter |
return specified parameter. NULL if not found.
Definition at line 250 of file ParameterCombination.cpp.
|
protected |
Gets parameter by name in current node.
name | name of parameter |
Definition at line 234 of file ParameterCombination.cpp.
|
virtual |
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
Definition at line 196 of file ParameterCombination.h.
|
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 |
Definition at line 296 of file SGObject.cpp.
|
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.
sets | Set of sets of leafs to combine |
new_root | root node that is copied and put as root into all result trees |
Definition at line 418 of file ParameterCombination.cpp.
|
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 |
Definition at line 369 of file SGObject.cpp.
|
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 occurs. |
Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 426 of file SGObject.cpp.
|
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 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
node | (copies of) children of given node are added to this one |
Definition at line 296 of file ParameterCombination.cpp.
|
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.
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 |
Definition at line 539 of file ParameterCombination.cpp.
|
virtualinherited |
Definition at line 262 of file SGObject.cpp.
|
static |
Returns a newly created array with pointers to newly created Parameter instances, which contain all combinations of the provided Parameters.
Definition at line 382 of file ParameterCombination.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 474 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix 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
prefix_num | number of tabs that will be prefixed for every output. At each recursion level, one is added. |
Definition at line 307 of file ParameterCombination.cpp.
|
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 |
Definition at line 314 of file SGObject.cpp.
|
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 occurs. |
Reimplemented in CKernel.
Definition at line 436 of file SGObject.cpp.
|
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 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.
|
inherited |
Definition at line 41 of file SGObject.cpp.
|
inherited |
Definition at line 46 of file SGObject.cpp.
|
inherited |
Definition at line 51 of file SGObject.cpp.
|
inherited |
Definition at line 56 of file SGObject.cpp.
|
inherited |
Definition at line 61 of file SGObject.cpp.
|
inherited |
Definition at line 66 of file SGObject.cpp.
|
inherited |
Definition at line 71 of file SGObject.cpp.
|
inherited |
Definition at line 76 of file SGObject.cpp.
|
inherited |
Definition at line 81 of file SGObject.cpp.
|
inherited |
Definition at line 86 of file SGObject.cpp.
|
inherited |
Definition at line 91 of file SGObject.cpp.
|
inherited |
Definition at line 96 of file SGObject.cpp.
|
inherited |
Definition at line 101 of file SGObject.cpp.
|
inherited |
Definition at line 106 of file SGObject.cpp.
|
inherited |
Definition at line 111 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 241 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 283 of file SGObject.cpp.
Sets specific parameter to specified value.
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 |
Definition at line 141 of file ParameterCombination.h.
|
protected |
Sets parameter by name in current node.
name | name of parameter |
value | of parameter |
index | index if parameter is a vector |
Definition at line 144 of file ParameterCombination.cpp.
|
protected |
Sets parameter by name in current node.
name | name of parameter |
value | of parameter |
index | index if parameter is a vector |
Definition at line 174 of file ParameterCombination.cpp.
Sets parameter by name in current node.
name | name of parameter |
value | of parameter |
index | index if parameter is a vector |
Definition at line 203 of file ParameterCombination.cpp.
|
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.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 303 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 248 of file SGObject.cpp.
|
friend |
Definition at line 45 of file ParameterCombination.h.
|
inherited |
io
Definition at line 369 of file SGObject.h.
|
protected |
child parameters
Definition at line 311 of file ParameterCombination.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 384 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 387 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 381 of file SGObject.h.
|
protected |
parameter of combination
Definition at line 308 of file ParameterCombination.h.
|
inherited |
parameters
Definition at line 378 of file SGObject.h.
|
protected |
total length of the parameters in combination
Definition at line 314 of file ParameterCombination.h.
|
inherited |
parallel
Definition at line 372 of file SGObject.h.
|
inherited |
version
Definition at line 375 of file SGObject.h.