SHOGUN
4.1.0
|
Dynamic array class for CSGObject pointers that creates an array that can be used like a list or an array.
It grows and shrinks dynamically, while elements can be accessed via index. It only stores CSGObject pointers, which ARE automagically SG_REF'd/deleted.
Definition at line 31 of file DynamicObjectArray.h.
Public Member Functions | |
CDynamicObjectArray () | |
CDynamicObjectArray (int32_t dim1, int32_t dim2=1, int32_t dim3=1) | |
CDynamicObjectArray (CSGObject **p_array, int32_t p_dim1_size, bool p_free_array=true, bool p_copy_array=false) | |
CDynamicObjectArray (CSGObject **p_array, int32_t p_dim1_size, int32_t p_dim2_size, bool p_free_array=true, bool p_copy_array=false) | |
CDynamicObjectArray (CSGObject **p_array, int32_t p_dim1_size, int32_t p_dim2_size, int32_t p_dim3_size, bool p_free_array=true, bool p_copy_array=false) | |
virtual | ~CDynamicObjectArray () |
int32_t | set_granularity (int32_t g) |
int32_t | get_array_size () |
void | get_array_size (int32_t &dim1, int32_t &dim2) |
void | get_array_size (int32_t &dim1, int32_t &dim2, int32_t &dim3) |
int32_t | get_dim1 () |
int32_t | get_dim2 () |
int32_t | get_dim3 () |
int32_t | get_num_elements () const |
CSGObject * | get_element (int32_t index) const |
CSGObject * | element (int32_t idx1, int32_t idx2=0, int32_t idx3=0) |
CSGObject * | get_last_element () const |
CSGObject * | get_element_safe (int32_t index) const |
bool | set_element (CSGObject *e, int32_t idx1, int32_t idx2=0, int32_t idx3=0) |
bool | insert_element (CSGObject *e, int32_t index) |
bool | append_element (CSGObject *e) |
void | push_back (CSGObject *e) |
void | pop_back () |
CSGObject * | back () const |
int32_t | find_element (CSGObject *elem) const |
bool | delete_element (int32_t idx) |
void | clear_array () |
void | reset_array () |
CDynamicObjectArray & | operator= (CDynamicObjectArray &orig) |
CSGObject ** | get_array () const |
void | shuffle () |
void | shuffle (CRandom *rand) |
void | set_array_name (const char *p_name) |
const char * | get_array_name () const |
virtual const char * | get_name () const |
virtual void | load_serializable_pre () throw (ShogunException) |
virtual void | save_serializable_pre () throw (ShogunException) |
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 Attributes | |
SGIO * | io |
Parallel * | parallel |
Version * | version |
Parameter * | m_parameters |
Parameter * | m_model_selection_parameters |
Parameter * | m_gradient_parameters |
uint32_t | m_hash |
Protected Member Functions | |
virtual void | load_serializable_post () throw (ShogunException) |
virtual void | save_serializable_post () throw (ShogunException) |
default constructor
Definition at line 35 of file DynamicObjectArray.h.
CDynamicObjectArray | ( | int32_t | dim1, |
int32_t | dim2 = 1 , |
||
int32_t | dim3 = 1 |
||
) |
constructor
dim1 | dimension 1 |
dim2 | dimension 2 |
dim3 | dimension 3 |
Definition at line 51 of file DynamicObjectArray.h.
CDynamicObjectArray | ( | CSGObject ** | p_array, |
int32_t | p_dim1_size, | ||
bool | p_free_array = true , |
||
bool | p_copy_array = false |
||
) |
constructor
p_array | another array |
p_dim1_size | dimension 1 |
p_free_array | if array must be freed |
p_copy_array | if array must be copied |
Definition at line 68 of file DynamicObjectArray.h.
CDynamicObjectArray | ( | CSGObject ** | p_array, |
int32_t | p_dim1_size, | ||
int32_t | p_dim2_size, | ||
bool | p_free_array = true , |
||
bool | p_copy_array = false |
||
) |
constructor
p_array | another array |
p_dim1_size | dimension 1 |
p_dim2_size | dimension 2 |
p_free_array | if array must be freed |
p_copy_array | if array must be copied |
Definition at line 86 of file DynamicObjectArray.h.
CDynamicObjectArray | ( | CSGObject ** | p_array, |
int32_t | p_dim1_size, | ||
int32_t | p_dim2_size, | ||
int32_t | p_dim3_size, | ||
bool | p_free_array = true , |
||
bool | p_copy_array = false |
||
) |
constructor
p_array | another array |
p_dim1_size | dimension 1 |
p_dim2_size | dimension 2 |
p_dim3_size | dimension 3 |
p_free_array | if array must be freed |
p_copy_array | if array must be copied |
Definition at line 106 of file DynamicObjectArray.h.
|
virtual |
Definition at line 117 of file DynamicObjectArray.h.
bool append_element | ( | CSGObject * | e | ) |
append array element to the end of array
e | element to append |
Definition at line 285 of file DynamicObjectArray.h.
CSGObject* back | ( | ) | const |
STD VECTOR compatible. Return array element at the end of array.
Definition at line 321 of file DynamicObjectArray.h.
|
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 597 of file SGObject.cpp.
void clear_array | ( | ) |
clear the array (with zeros)
Definition at line 355 of file DynamicObjectArray.h.
|
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.
Definition at line 714 of file SGObject.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 198 of file SGObject.cpp.
bool delete_element | ( | int32_t | idx | ) |
delete array element at idx (does not call SG_FREE() or the like)
idx | index |
Definition at line 345 of file DynamicObjectArray.h.
CSGObject* element | ( | int32_t | idx1, |
int32_t | idx2 = 0 , |
||
int32_t | idx3 = 0 |
||
) |
get array element at index
idx1 | index 1 |
idx2 | index 2 |
idx3 | index 3 |
Definition at line 208 of file DynamicObjectArray.h.
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) |
Definition at line 618 of file SGObject.cpp.
int32_t find_element | ( | CSGObject * | elem | ) | const |
find first occurence of array element and return its index or -1 if not available
elem | element to search for |
Definition at line 334 of file DynamicObjectArray.h.
CSGObject** get_array | ( | ) | const |
Definition at line 388 of file DynamicObjectArray.h.
const char* get_array_name | ( | ) | const |
int32_t get_array_size | ( | ) |
get array size (including granularity buffer)
Definition at line 131 of file DynamicObjectArray.h.
void get_array_size | ( | int32_t & | dim1, |
int32_t & | dim2 | ||
) |
return 2d array size
dim1 | dimension 1 will be stored here |
dim2 | dimension 2 will be stored here |
Definition at line 141 of file DynamicObjectArray.h.
void get_array_size | ( | int32_t & | dim1, |
int32_t & | dim2, | ||
int32_t & | dim3 | ||
) |
return 3d array size
dim1 | dimension 1 will be stored here |
dim2 | dimension 2 will be stored here |
dim3 | dimension 3 will be stored here |
Definition at line 153 of file DynamicObjectArray.h.
int32_t get_dim1 | ( | ) |
int32_t get_dim2 | ( | ) |
int32_t get_dim3 | ( | ) |
CSGObject* get_element | ( | int32_t | index | ) | const |
get array element at index
(does NOT do bounds checking)
index | index |
Definition at line 194 of file DynamicObjectArray.h.
CSGObject* get_element_safe | ( | int32_t | index | ) | const |
get array element at index
(does bounds checking)
index | index |
Definition at line 231 of file DynamicObjectArray.h.
|
inherited |
|
inherited |
|
inherited |
CSGObject* get_last_element | ( | ) | const |
get last array element
Definition at line 217 of file DynamicObjectArray.h.
|
inherited |
Definition at line 498 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 522 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 535 of file SGObject.cpp.
|
virtual |
int32_t get_num_elements | ( | ) | const |
get number of elements
Definition at line 182 of file DynamicObjectArray.h.
bool insert_element | ( | CSGObject * | e, |
int32_t | index | ||
) |
insert array element at index
e | element to insert |
index | index |
Definition at line 271 of file DynamicObjectArray.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 296 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 |
Definition at line 369 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 occurs. |
Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 426 of file SGObject.cpp.
|
virtual |
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. |
Reimplemented from CSGObject.
Definition at line 423 of file DynamicObjectArray.h.
CDynamicObjectArray& operator= | ( | CDynamicObjectArray & | orig | ) |
operator overload for array assignment
orig | original array |
Definition at line 373 of file DynamicObjectArray.h.
|
virtualinherited |
Definition at line 262 of file SGObject.cpp.
void pop_back | ( | ) |
STD VECTOR compatible. Delete array element at the end of array.
Definition at line 308 of file DynamicObjectArray.h.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 474 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 308 of file SGObject.cpp.
void push_back | ( | CSGObject * | e | ) |
STD VECTOR compatible. Append array element to the end of array.
e | element to append |
Definition at line 299 of file DynamicObjectArray.h.
void reset_array | ( | ) |
resets the array
Definition at line 362 of file DynamicObjectArray.h.
|
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 |
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.
ShogunException | will be thrown if an error occurs. |
Reimplemented in CKernel.
Definition at line 436 of file SGObject.cpp.
|
virtual |
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 from CSGObject.
Definition at line 438 of file DynamicObjectArray.h.
void set_array_name | ( | const char * | p_name | ) |
bool set_element | ( | CSGObject * | e, |
int32_t | idx1, | ||
int32_t | idx2 = 0 , |
||
int32_t | idx3 = 0 |
||
) |
set array element at index
e | element to set |
idx1 | index 1 |
idx2 | index 2 |
idx3 | index 2 |
Definition at line 246 of file DynamicObjectArray.h.
|
inherited |
Definition at line 41 of file SGObject.cpp.
|
inherited |
Definition at line 46 of file SGObject.cpp.
|
inherited |
Definition at line 51 of file SGObject.cpp.
|
inherited |
Definition at line 56 of file SGObject.cpp.
|
inherited |
Definition at line 61 of file SGObject.cpp.
|
inherited |
Definition at line 66 of file SGObject.cpp.
|
inherited |
Definition at line 71 of file SGObject.cpp.
|
inherited |
Definition at line 76 of file SGObject.cpp.
|
inherited |
Definition at line 81 of file SGObject.cpp.
|
inherited |
Definition at line 86 of file SGObject.cpp.
|
inherited |
Definition at line 91 of file SGObject.cpp.
|
inherited |
Definition at line 96 of file SGObject.cpp.
|
inherited |
Definition at line 101 of file SGObject.cpp.
|
inherited |
Definition at line 106 of file SGObject.cpp.
|
inherited |
Definition at line 111 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 241 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 283 of file SGObject.cpp.
int32_t set_granularity | ( | int32_t | g | ) |
set the resize granularity
g | new granularity |
Definition at line 124 of file DynamicObjectArray.h.
|
virtualinherited |
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.
void shuffle | ( | ) |
shuffles the array (not thread safe!)
Definition at line 391 of file DynamicObjectArray.h.
void shuffle | ( | CRandom * | rand | ) |
shuffles the array with external random state
Definition at line 394 of file DynamicObjectArray.h.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 303 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 248 of file SGObject.cpp.
|
inherited |
io
Definition at line 369 of file SGObject.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 384 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 387 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 381 of file SGObject.h.
|
inherited |
parameters
Definition at line 378 of file SGObject.h.
|
inherited |
parallel
Definition at line 372 of file SGObject.h.
|
inherited |
version
Definition at line 375 of file SGObject.h.