template<class K, class T>
class shogun::CMap< K, T >
the class CMap, a map based on the hash-table. w: http://en.wikipedia.org/wiki/Hash_table
Definition at line 39 of file SGObject.h.
|
| CMap (int32_t size=41, int32_t reserved=128, bool tracable=true) |
|
virtual | ~CMap () |
|
virtual const char * | get_name () const |
|
int32_t | add (const K &key, const T &data) |
|
bool | contains (const K &key) |
|
void | remove (const K &key) |
|
int32_t | index_of (const K &key) |
|
T | get_element (const K &key) |
|
void | set_element (const K &key, const T &data) |
|
int32_t | get_num_elements () const |
|
int32_t | get_array_size () const |
|
T * | get_element_ptr (int32_t index) |
|
CMapNode< K, T > * | get_node_ptr (int32_t index) |
|
CMapNode< K, T > ** | get_array () |
|
CMap & | operator= (const CMap &orig) |
|
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) |
|
bool | has (const std::string &name) const |
|
template<typename T > |
bool | has (const Tag< T > &tag) const |
|
template<typename T , typename U = void> |
bool | has (const std::string &name) const |
|
template<typename T > |
void | set (const Tag< T > &_tag, const T &value) |
|
template<typename T , typename U = void> |
void | set (const std::string &name, const T &value) |
|
template<typename T > |
T | get (const Tag< T > &_tag) const |
|
template<typename T , typename U = void> |
T | get (const std::string &name) const |
|
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 () |
|
CMap |
( |
int32_t |
size = 41 , |
|
|
int32_t |
reserved = 128 , |
|
|
bool |
tracable = true |
|
) |
| |
Custom constructor
Definition at line 66 of file Map.h.
Default destructor
Definition at line 87 of file Map.h.
int32_t add |
( |
const K & |
key, |
|
|
const T & |
data |
|
) |
| |
Add an element to the map
- Parameters
-
key | key to be added |
data | data to be added |
- Returns
- index of added element
Definition at line 101 of file Map.h.
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
-
dict | dictionary of parameters to be built. |
Definition at line 630 of file SGObject.cpp.
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 747 of file SGObject.cpp.
bool contains |
( |
const K & |
key | ) |
|
Check an element in the map
- Parameters
-
- Returns
- true if element contains in the map
Definition at line 122 of file Map.h.
A deep copy. All the instance variables will also be copied.
Definition at line 231 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.
- Parameters
-
other | object to compare with |
accuracy | accuracy to use for comparison (optional) |
tolerant | allows linient check on float equality (within accuracy) |
- Returns
- true if all parameters were equal, false if not
Definition at line 651 of file SGObject.cpp.
T get |
( |
const Tag< T > & |
_tag | ) |
const |
|
inherited |
Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.
- Parameters
-
_tag | name and type information of parameter |
- Returns
- value of the parameter identified by the input tag
Definition at line 367 of file SGObject.h.
T get |
( |
const std::string & |
name | ) |
const |
|
inherited |
Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.
- Parameters
-
name | name of the parameter |
- Returns
- value of the parameter corresponding to the input name and type
Definition at line 388 of file SGObject.h.
CMapNode<K, T>** get_array |
( |
| ) |
|
- Returns
- underlying array of nodes in memory
Definition at line 253 of file Map.h.
int32_t get_array_size |
( |
| ) |
const |
Get size of auxilary array
- Returns
- array size
Definition at line 220 of file Map.h.
T get_element |
( |
const K & |
key | ) |
|
Get element by key
- Parameters
-
- Returns
- exist element or new element (if key doesn't consist in map)
Definition at line 171 of file Map.h.
T* get_element_ptr |
( |
int32_t |
index | ) |
|
get element at index as reference
(does NOT do bounds checking)
- Parameters
-
- Returns
- array element at index
Definition at line 232 of file Map.h.
get the io object
- Returns
- io object
Definition at line 268 of file SGObject.cpp.
get the parallel object
- Returns
- parallel object
Definition at line 310 of file SGObject.cpp.
get the version object
- Returns
- version object
Definition at line 323 of file SGObject.cpp.
virtual uint32_t get_hash_value |
( |
const K & |
key | ) |
|
|
protectedvirtual |
Get the hash of a given key
- Parameters
-
- Returns
- hash of the key
Reimplemented in CStringMap< T >.
Definition at line 447 of file Map.h.
- Returns
- vector of names of all parameters which are registered for model selection
Definition at line 531 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_name | name of the parameter |
- Returns
- description of the parameter
Definition at line 555 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_name | name of model selection parameter |
- Returns
- index of model selection parameter with provided name, -1 if there is no such
Definition at line 568 of file SGObject.cpp.
virtual const char* get_name |
( |
| ) |
const |
|
virtual |
CMapNode<K, T>* get_node_ptr |
( |
int32_t |
index | ) |
|
get node at index as reference
(does NOT do bounds checking)
- Parameters
-
- Returns
- node at index
Definition at line 247 of file Map.h.
int32_t get_num_elements |
( |
| ) |
const |
Get number of elements
- Returns
- number of elements
Definition at line 211 of file Map.h.
bool has |
( |
const std::string & |
name | ) |
const |
|
inherited |
Checks if object has a class parameter identified by a name.
- Parameters
-
name | name of the parameter |
- Returns
- true if the parameter exists with the input name
Definition at line 289 of file SGObject.h.
bool has |
( |
const Tag< T > & |
tag | ) |
const |
|
inherited |
Checks if object has a class parameter identified by a Tag.
- Parameters
-
tag | tag of the parameter containing name and type information |
- Returns
- true if the parameter exists with the input tag
Definition at line 301 of file SGObject.h.
bool has |
( |
const std::string & |
name | ) |
const |
|
inherited |
Checks if a type exists for a class parameter identified by a name.
- Parameters
-
name | name of the parameter |
- Returns
- true if the parameter exists with the input name and type
Definition at line 312 of file SGObject.h.
int32_t index_of |
( |
const K & |
key | ) |
|
Index of element in the set
- Parameters
-
- Returns
- index of the element or -1 if not found
Definition at line 154 of file Map.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
-
generic | set to the type of the generic if returning TRUE |
- Returns
- TRUE if a class template.
Definition at line 329 of file SGObject.cpp.
Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!
- Parameters
-
file | where to load from |
prefix | prefix for members |
- Returns
- TRUE if done, otherwise FALSE
Definition at line 402 of file SGObject.cpp.
|
protectedvirtualinherited |
|
protectedvirtualinherited |
CMap& operator= |
( |
const CMap< K, T > & |
orig | ) |
|
assignment operator that copies map
Definition at line 259 of file Map.h.
bool parameter_hash_changed |
( |
| ) |
|
|
virtualinherited |
- Returns
- whether parameter combination has changed since last update
Definition at line 295 of file SGObject.cpp.
void print_modsel_params |
( |
| ) |
|
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 507 of file SGObject.cpp.
void print_serializable |
( |
const char * |
prefix = "" | ) |
|
|
virtualinherited |
prints registered parameters out
- Parameters
-
Definition at line 341 of file SGObject.cpp.
void register_param |
( |
Tag< T > & |
_tag, |
|
|
const T & |
value |
|
) |
| |
|
protectedinherited |
Registers a class parameter which is identified by a tag. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.
- Parameters
-
_tag | name and type information of parameter |
value | value of the parameter |
Definition at line 439 of file SGObject.h.
void register_param |
( |
const std::string & |
name, |
|
|
const T & |
value |
|
) |
| |
|
protectedinherited |
Registers a class parameter which is identified by a name. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.
- Parameters
-
name | name of the parameter |
value | value of the parameter along with type information |
Definition at line 452 of file SGObject.h.
void remove |
( |
const K & |
key | ) |
|
Remove an element from the set
- Parameters
-
Definition at line 135 of file Map.h.
Save this object to file.
- Parameters
-
file | where to save the object; will be closed during returning if PREFIX is an empty string. |
prefix | prefix for members |
- Returns
- TRUE if done, otherwise FALSE
Definition at line 347 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.
- Exceptions
-
Reimplemented in CKernel.
Definition at line 469 of file SGObject.cpp.
|
protectedvirtualinherited |
void set |
( |
const Tag< T > & |
_tag, |
|
|
const T & |
value |
|
) |
| |
|
inherited |
Setter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.
- Parameters
-
_tag | name and type information of parameter |
value | value of the parameter |
Definition at line 328 of file SGObject.h.
void set |
( |
const std::string & |
name, |
|
|
const T & |
value |
|
) |
| |
|
inherited |
Setter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.
- Parameters
-
name | name of the parameter |
value | value of the parameter along with type information |
Definition at line 354 of file SGObject.h.
void set_element |
( |
const K & |
key, |
|
|
const T & |
data |
|
) |
| |
Set element by key
- Parameters
-
key | key of element |
data | new data for element |
Definition at line 192 of file Map.h.
void set_global_io |
( |
SGIO * |
io | ) |
|
|
inherited |
void set_global_parallel |
( |
Parallel * |
parallel | ) |
|
|
inherited |
set the parallel object
- Parameters
-
parallel | parallel object to use |
Definition at line 274 of file SGObject.cpp.
void set_global_version |
( |
Version * |
version | ) |
|
|
inherited |
set the version object
- Parameters
-
version | version object to use |
Definition at line 316 of file SGObject.cpp.
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 225 of file SGObject.cpp.
unset generic type
this has to be called in classes specializing a template class
Definition at line 336 of file SGObject.cpp.
void update_parameter_hash |
( |
| ) |
|
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 281 of file SGObject.cpp.
array for index permission
Definition at line 468 of file Map.h.
next free index for new element
Definition at line 459 of file Map.h.
CMapNode<K, T>** hash_array |
|
protected |
array of lists (chains)
Definition at line 465 of file Map.h.
hashtable size
Definition at line 456 of file Map.h.
concurrency lock
Definition at line 471 of file Map.h.
parameters wrt which we can compute gradients
Definition at line 552 of file SGObject.h.
Hash of parameter values
Definition at line 555 of file SGObject.h.
model selection parameters
Definition at line 549 of file SGObject.h.
number of elements
Definition at line 462 of file Map.h.
whether SG_MALLOC or just malloc etc shall be used
Definition at line 453 of file Map.h.
The documentation for this class was generated from the following files: