|
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.
在文件 ParameterCombination.h 第 43 行定义.
Public 成员函数 | |
| 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 () |
静态 Public 成员函数 | |
| 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 属性 | |
| SGIO * | io |
| Parallel * | parallel |
| Version * | version |
| Parameter * | m_parameters |
| Parameter * | m_model_selection_parameters |
| Parameter * | m_gradient_parameters |
| uint32_t | m_hash |
Protected 成员函数 | |
| 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) |
静态 Protected 成员函数 | |
| 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 属性 | |
| Parameter * | m_param |
| CDynamicObjectArray * | m_child_nodes |
| uint32_t | m_parameters_length |
友元 | |
| class | CModelSelectionParameters |
constructor for a root node
在文件 ParameterCombination.cpp 第 22 行定义.
| CParameterCombination | ( | Parameter * | param | ) |
| 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 |
在文件 ParameterCombination.cpp 第 34 行定义.
|
virtual |
destructor also recursively destroys complete tree (SG_UNREF of child nodes)
在文件 ParameterCombination.cpp 第 133 行定义.
| void append_child | ( | CParameterCombination * | child | ) |
| 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 |
在文件 ParameterCombination.cpp 第 707 行定义.
| 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 |
在文件 ParameterCombination.cpp 第 712 行定义.
|
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 第 597 行定义.
|
virtual |
builds map, which contains parameters and its parents
| parent_map | map, which contains parameters and its parents |
在文件 ParameterCombination.cpp 第 807 行定义.
|
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 |
在文件 ParameterCombination.cpp 第 768 行定义.
|
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.
在文件 SGObject.cpp 第 714 行定义.
| 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
在文件 ParameterCombination.cpp 第 681 行定义.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
在文件 SGObject.cpp 第 198 行定义.
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) |
在文件 SGObject.cpp 第 618 行定义.
|
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 |
在文件 ParameterCombination.cpp 第 651 行定义.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
在文件 SGObject.cpp 第 498 行定义.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
| param_name | name of the parameter |
在文件 SGObject.cpp 第 522 行定义.
|
inherited |
Returns index of model selection parameter with provided index
| param_name | name of model selection parameter |
在文件 SGObject.cpp 第 535 行定义.
|
virtual |
| 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.
在文件 ParameterCombination.cpp 第 250 行定义.
|
protected |
Gets parameter by name in current node.
| name | name of parameter |
在文件 ParameterCombination.cpp 第 234 行定义.
|
virtual |
returns total length of the parameters in combination
在文件 ParameterCombination.h 第 222 行定义.
| bool has_children | ( | ) | const |
checks whether this node has children
在文件 ParameterCombination.h 第 196 行定义.
|
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 |
在文件 SGObject.cpp 第 296 行定义.
|
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 |
在文件 ParameterCombination.cpp 第 418 行定义.
|
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 |
在文件 SGObject.cpp 第 369 行定义.
|
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. |
被 CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.
在文件 SGObject.cpp 第 426 行定义.
|
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. |
被 CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.
在文件 SGObject.cpp 第 421 行定义.
| 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 |
在文件 ParameterCombination.cpp 第 296 行定义.
|
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 |
在文件 ParameterCombination.cpp 第 539 行定义.
|
virtualinherited |
在文件 SGObject.cpp 第 262 行定义.
|
static |
Returns a newly created array with pointers to newly created Parameter instances, which contain all combinations of the provided Parameters.
在文件 ParameterCombination.cpp 第 382 行定义.
|
inherited |
prints all parameter registered for model selection and their type
在文件 SGObject.cpp 第 474 行定义.
|
virtualinherited |
| 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. |
在文件 ParameterCombination.cpp 第 307 行定义.
|
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 |
在文件 SGObject.cpp 第 314 行定义.
|
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. |
被 CKernel 重载.
在文件 SGObject.cpp 第 436 行定义.
|
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. |
被 CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.
在文件 SGObject.cpp 第 431 行定义.
|
inherited |
在文件 SGObject.cpp 第 41 行定义.
|
inherited |
在文件 SGObject.cpp 第 46 行定义.
|
inherited |
在文件 SGObject.cpp 第 51 行定义.
|
inherited |
在文件 SGObject.cpp 第 56 行定义.
|
inherited |
在文件 SGObject.cpp 第 61 行定义.
|
inherited |
在文件 SGObject.cpp 第 66 行定义.
|
inherited |
在文件 SGObject.cpp 第 71 行定义.
|
inherited |
在文件 SGObject.cpp 第 76 行定义.
|
inherited |
在文件 SGObject.cpp 第 81 行定义.
|
inherited |
在文件 SGObject.cpp 第 86 行定义.
|
inherited |
在文件 SGObject.cpp 第 91 行定义.
|
inherited |
在文件 SGObject.cpp 第 96 行定义.
|
inherited |
在文件 SGObject.cpp 第 101 行定义.
|
inherited |
在文件 SGObject.cpp 第 106 行定义.
|
inherited |
在文件 SGObject.cpp 第 111 行定义.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
|
inherited |
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 |
在文件 ParameterCombination.h 第 141 行定义.
|
protected |
Sets parameter by name in current node.
| name | name of parameter |
| value | of parameter |
| index | index if parameter is a vector |
在文件 ParameterCombination.cpp 第 144 行定义.
|
protected |
Sets parameter by name in current node.
| name | name of parameter |
| value | of parameter |
| index | index if parameter is a vector |
在文件 ParameterCombination.cpp 第 174 行定义.
Sets parameter by name in current node.
| name | name of parameter |
| value | of parameter |
| index | index if parameter is a vector |
在文件 ParameterCombination.cpp 第 203 行定义.
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
被 CGaussianKernel 重载.
在文件 SGObject.cpp 第 192 行定义.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
在文件 SGObject.cpp 第 303 行定义.
|
virtualinherited |
Updates the hash of current parameter combination
在文件 SGObject.cpp 第 248 行定义.
|
friend |
在文件 ParameterCombination.h 第 45 行定义.
|
inherited |
io
在文件 SGObject.h 第 369 行定义.
|
protected |
child parameters
在文件 ParameterCombination.h 第 311 行定义.
|
inherited |
parameters wrt which we can compute gradients
在文件 SGObject.h 第 384 行定义.
|
inherited |
Hash of parameter values
在文件 SGObject.h 第 387 行定义.
|
inherited |
model selection parameters
在文件 SGObject.h 第 381 行定义.
|
protected |
parameter of combination
在文件 ParameterCombination.h 第 308 行定义.
|
inherited |
parameters
在文件 SGObject.h 第 378 行定义.
|
protected |
total length of the parameters in combination
在文件 ParameterCombination.h 第 314 行定义.
|
inherited |
parallel
在文件 SGObject.h 第 372 行定义.
|
inherited |
version
在文件 SGObject.h 第 375 行定义.
