SHOGUN
v2.0.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 42 of file ParameterCombination.h.
Public Member Functions | |
CParameterCombination () | |
void | print_tree (int prefix_num=0) const |
CParameterCombination (Parameter *param) | |
virtual | ~CParameterCombination () |
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 CSGObject * | shallow_copy () const |
virtual CSGObject * | deep_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_PARAMETER) |
virtual bool | load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=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) |
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_parameter_dictionary (CMap< TParameter *, CSGObject * > &dict) |
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 |
ParameterMap * | m_parameter_map |
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 TParameter * | migrate (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) |
virtual bool | update_parameter_hash () |
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 |
Friends | |
class | CModelSelectionParameters |
constructor for a root node
Definition at line 22 of file ParameterCombination.cpp.
CParameterCombination | ( | Parameter * | param | ) |
constructor for a Parameter node
Definition at line 27 of file ParameterCombination.cpp.
|
virtual |
destructor also recursively destroys complete tree (SG_UNREF of child nodes)
Definition at line 44 of file ParameterCombination.cpp.
void append_child | ( | CParameterCombination * | child | ) |
appends a child to this node
child | child to append |
Definition at line 50 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 624 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 629 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 1204 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 598 of file ParameterCombination.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 131 of file SGObject.h.
|
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 568 of file ParameterCombination.cpp.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Definition at line 1108 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 1132 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1145 of file SGObject.cpp.
|
virtual |
Implements CSGObject.
Definition at line 198 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 163 of file ParameterCombination.cpp.
|
protected |
Gets parameter by name in current node.
name | name of parameter |
Definition at line 147 of file ParameterCombination.cpp.
bool has_children | ( | ) | const |
checks whether this node has children
Definition at line 181 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 278 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 335 of file ParameterCombination.cpp.
|
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)
file_version | parameter version of the file |
current_version | version from which mapping begins (you want to use VERSION_PARAMETER for this in most cases) |
file | file to load from |
prefix | prefix for members |
Definition at line 679 of file SGObject.cpp.
|
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
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 |
Definition at line 523 of file SGObject.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 |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Reimplemented in CModelSelectionParameters.
Definition at line 354 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 occurres. |
Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CANOVAKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 1033 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 occurres. |
Definition at line 1028 of file SGObject.cpp.
|
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
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 717 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 209 of file ParameterCombination.cpp.
|
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
param_base | set of TParameter instances to use for migration |
target | parameter info for the resulting TParameter |
Definition at line 923 of file SGObject.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 456 of file ParameterCombination.cpp.
|
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)
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 864 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 299 of file ParameterCombination.cpp.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1084 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 290 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 220 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 |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Reimplemented in CModelSelectionParameters.
Definition at line 296 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 occurres. |
Reimplemented in CKernel.
Definition at line 1043 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 occurres. |
Reimplemented in CKernel.
Definition at line 1038 of file SGObject.cpp.
|
inherited |
set generic type to T
Definition at line 41 of file SGObject.cpp.
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 230 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 265 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 126 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 57 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 87 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 116 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 122 of file SGObject.h.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 285 of file SGObject.cpp.
|
protectedvirtualinherited |
Updates the hash of current parameter combination.
Definition at line 237 of file SGObject.cpp.
|
friend |
Definition at line 45 of file ParameterCombination.h.
|
inherited |
io
Definition at line 462 of file SGObject.h.
|
protected |
Child Parameters
Definition at line 275 of file ParameterCombination.h.
|
inherited |
Hash of parameter values
Definition at line 480 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 474 of file SGObject.h.
|
protected |
Parameter of combination
Definition at line 272 of file ParameterCombination.h.
|
inherited |
map for different parameter versions
Definition at line 477 of file SGObject.h.
|
inherited |
parameters
Definition at line 471 of file SGObject.h.
|
inherited |
parallel
Definition at line 465 of file SGObject.h.
|
inherited |
version
Definition at line 468 of file SGObject.h.