template<class T>
class shogun::CSet< T >
the class CSet, a set based on the hash-table. w: http://en.wikipedia.org/wiki/Hash_table
在文件 Set.h 第 49 行定义.
|
| CSet (int32_t size=41, int32_t reserved=128, bool tracable=true) |
|
virtual | ~CSet () |
|
virtual const char * | get_name () const |
|
void | add (const T &element) |
|
bool | contains (const T &element) |
|
void | remove (const T &element) |
|
int32_t | index_of (const T &element) |
|
int32_t | get_num_elements () const |
|
int32_t | get_array_size () const |
|
T * | get_element_ptr (int32_t index) |
|
CSetNode< T > * | get_node_ptr (int32_t index) |
|
CSetNode< T > ** | get_array () |
|
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="", 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) |
|
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 bool | update_parameter_hash () |
|
virtual bool | equals (CSGObject *other, float64_t accuracy=0.0) |
|
virtual CSGObject * | clone () |
|
CSet |
( |
int32_t |
size = 41 , |
|
|
int32_t |
reserved = 128 , |
|
|
bool |
tracable = true |
|
) |
| |
Custom constructor
在文件 Set.h 第 53 行定义.
Default destructor
在文件 Set.h 第 74 行定义.
void add |
( |
const T & |
element | ) |
|
Add an element to the set
- 参数
-
element | element to be added |
在文件 Set.h 第 107 行定义.
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 第 1195 行定义.
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.
- 返回
- 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
在文件 SGObject.cpp 第 1312 行定义.
bool contains |
( |
const T & |
element | ) |
|
Remove an element from the set
- 参数
-
element | element to be looked for |
在文件 Set.h 第 121 行定义.
A deep copy. All the instance variables will also be copied.
在文件 SGObject.h 第 159 行定义.
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) |
- 返回
- true if all parameters were equal, false if not
在文件 SGObject.cpp 第 1216 行定义.
CSetNode<T>** get_array |
( |
| ) |
|
- 返回
- underlying array of nodes in memory
在文件 Set.h 第 207 行定义.
int32_t get_array_size |
( |
| ) |
const |
Get size of auxilary array
- 返回
- array size
在文件 Set.h 第 175 行定义.
T* get_element_ptr |
( |
int32_t |
index | ) |
|
get set element at index as reference
(does NOT do bounds checking)
- 参数
-
- 返回
- array element at index
在文件 Set.h 第 187 行定义.
- 返回
- vector of names of all parameters which are registered for model selection
在文件 SGObject.cpp 第 1099 行定义.
char * get_modsel_param_descr |
( |
const char * |
param_name | ) |
|
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
- 参数
-
param_name | name of the parameter |
- 返回
- description of the parameter
在文件 SGObject.cpp 第 1123 行定义.
index_t get_modsel_param_index |
( |
const char * |
param_name | ) |
|
|
inherited |
Returns index of model selection parameter with provided index
- 参数
-
param_name | name of model selection parameter |
- 返回
- index of model selection parameter with provided name, -1 if there is no such
在文件 SGObject.cpp 第 1136 行定义.
virtual const char* get_name |
( |
| ) |
const |
|
virtual |
CSetNode<T>* get_node_ptr |
( |
int32_t |
index | ) |
|
get node at index as reference
(does NOT do bounds checking)
- 参数
-
- 返回
- node at index
在文件 Set.h 第 201 行定义.
int32_t get_num_elements |
( |
| ) |
const |
Get number of elements
- 返回
- number of elements
在文件 Set.h 第 166 行定义.
int32_t index_of |
( |
const T & |
element | ) |
|
Index of element in the set
- 参数
-
element | element to be looked for |
- 返回
- index of the element or -1 if not found
在文件 Set.h 第 151 行定义.
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.
- 参数
-
generic | set to the type of the generic if returning TRUE |
- 返回
- TRUE if a class template.
在文件 SGObject.cpp 第 267 行定义.
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::get_version_parameter() for this in most cases) |
file | file to load from |
prefix | prefix for members |
- 返回
- (sorted) array of created TParameter instances with file data
在文件 SGObject.cpp 第 672 行定义.
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 |
- 返回
- new array with TParameter instances with the attached data
在文件 SGObject.cpp 第 513 行定义.
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) |
- 返回
- TRUE if done, otherwise FALSE
在文件 SGObject.cpp 第 344 行定义.
|
protectedvirtualinherited |
|
protectedvirtualinherited |
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 |
在文件 SGObject.cpp 第 710 行定义.
|
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 |
- 返回
- a new TParameter instance with migrated data from the base of the type which is specified by the target parameter
在文件 SGObject.cpp 第 917 行定义.
|
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 |
在文件 SGObject.cpp 第 857 行定义.
void print_modsel_params |
( |
| ) |
|
|
inherited |
prints all parameter registered for model selection and their type
在文件 SGObject.cpp 第 1075 行定义.
void print_serializable |
( |
const char * |
prefix = "" | ) |
|
|
virtualinherited |
void remove |
( |
const T & |
element | ) |
|
Remove an element from the set
- 参数
-
element | element to be removed |
在文件 Set.h 第 134 行定义.
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) |
- 返回
- TRUE if done, otherwise FALSE
在文件 SGObject.cpp 第 285 行定义.
|
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.
- 异常
-
被 CKernel 重载.
在文件 SGObject.cpp 第 1038 行定义.
|
protectedvirtualinherited |
void set_global_io |
( |
SGIO * |
io | ) |
|
|
inherited |
void set_global_parallel |
( |
Parallel * |
parallel | ) |
|
|
inherited |
set the parallel object
- 参数
-
parallel | parallel object to use |
在文件 SGObject.cpp 第 219 行定义.
void set_global_version |
( |
Version * |
version | ) |
|
|
inherited |
set the version object
- 参数
-
version | version object to use |
在文件 SGObject.cpp 第 254 行定义.
unset generic type
this has to be called in classes specializing a template class
在文件 SGObject.cpp 第 274 行定义.
bool update_parameter_hash |
( |
| ) |
|
|
virtualinherited |
Updates the hash of current parameter combination.
- 返回
- bool if parameter combination has changed since last update.
在文件 SGObject.cpp 第 226 行定义.
array for index permission
在文件 Set.h 第 346 行定义.
next free index for new element
在文件 Set.h 第 337 行定义.
array of lists (chains)
在文件 Set.h 第 343 行定义.
parameters wrt which we can compute gradients
在文件 SGObject.h 第 528 行定义.
whether SG_MALLOC or just malloc etc shall be used
在文件 Set.h 第 331 行定义.
该类的文档由以下文件生成: