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
Definition at line 51 of file Set.h.
CSet |
( |
int32_t |
size = 41 , |
|
|
int32_t |
reserved = 128 , |
|
|
bool |
tracable = true |
|
) |
| |
Custom constructor
Definition at line 55 of file Set.h.
Default destructor
Definition at line 76 of file Set.h.
void add |
( |
const T & |
element | ) |
|
Add an element to the set
- Parameters
-
element | element to be added |
Definition at line 109 of file Set.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 597 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 714 of file SGObject.cpp.
bool contains |
( |
const T & |
element | ) |
|
Remove an element from the set
- Parameters
-
element | element to be looked for |
Definition at line 123 of file Set.h.
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.
- 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 618 of file SGObject.cpp.
CSetNode<T>** get_array |
( |
| ) |
|
- Returns
- underlying array of nodes in memory
Definition at line 209 of file Set.h.
int32_t get_array_size |
( |
| ) |
const |
Get size of auxilary array
- Returns
- array size
Definition at line 177 of file Set.h.
T* get_element_ptr |
( |
int32_t |
index | ) |
|
get set element at index as reference
(does NOT do bounds checking)
- Parameters
-
- Returns
- array element at index
Definition at line 189 of file Set.h.
get the io object
- Returns
- io object
Definition at line 235 of file SGObject.cpp.
get the parallel object
- Returns
- parallel object
Definition at line 277 of file SGObject.cpp.
get the version object
- Returns
- version object
Definition at line 290 of file SGObject.cpp.
- Returns
- vector of names of all parameters which are registered for model selection
Definition at line 498 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 522 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 535 of file SGObject.cpp.
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)
- Parameters
-
- Returns
- node at index
Definition at line 203 of file Set.h.
int32_t get_num_elements |
( |
| ) |
const |
Get number of elements
- Returns
- number of elements
Definition at line 168 of file Set.h.
int32_t index_of |
( |
const T & |
element | ) |
|
Index of element in the set
- Parameters
-
element | element to be looked for |
- Returns
- index of the element or -1 if not found
Definition at line 153 of file Set.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 296 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 369 of file SGObject.cpp.
|
protectedvirtualinherited |
|
protectedvirtualinherited |
bool parameter_hash_changed |
( |
| ) |
|
|
virtualinherited |
- Returns
- whether parameter combination has changed since last update
Definition at line 262 of file SGObject.cpp.
void print_modsel_params |
( |
| ) |
|
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 474 of file SGObject.cpp.
void print_serializable |
( |
const char * |
prefix = "" | ) |
|
|
virtualinherited |
prints registered parameters out
- Parameters
-
Definition at line 308 of file SGObject.cpp.
void remove |
( |
const T & |
element | ) |
|
Remove an element from the set
- Parameters
-
element | element to be removed |
Definition at line 136 of file Set.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 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.
- Exceptions
-
Reimplemented in CKernel.
Definition at line 436 of file SGObject.cpp.
|
protectedvirtualinherited |
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 241 of file SGObject.cpp.
void set_global_version |
( |
Version * |
version | ) |
|
|
inherited |
set the version object
- Parameters
-
version | version object to use |
Definition at line 283 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 192 of file SGObject.cpp.
unset generic type
this has to be called in classes specializing a template class
Definition at line 303 of file SGObject.cpp.
void update_parameter_hash |
( |
| ) |
|
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 248 of file SGObject.cpp.
array for index permission
Definition at line 348 of file Set.h.
next free index for new element
Definition at line 339 of file Set.h.
array of lists (chains)
Definition at line 345 of file Set.h.
hashtable size
Definition at line 336 of file Set.h.
parameters wrt which we can compute gradients
Definition at line 384 of file SGObject.h.
Hash of parameter values
Definition at line 387 of file SGObject.h.
model selection parameters
Definition at line 381 of file SGObject.h.
number of elements
Definition at line 342 of file Set.h.
whether SG_MALLOC or just malloc etc shall be used
Definition at line 333 of file Set.h.
The documentation for this class was generated from the following file: