SHOGUN
v3.0.0
|
Template Dynamic array class 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 is performance tuned for simple types like float etc. and for hi-level objects only stores pointers, which are not automagically SG_REF'd/deleted.
Definition at line 28 of file DynamicArray.h.
Public Member Functions | |
CDynamicArray () | |
CDynamicArray (int32_t p_dim1_size, int32_t p_dim2_size=1, int32_t p_dim3_size=1) | |
CDynamicArray (T *p_array, int32_t p_dim1_size, bool p_free_array, bool p_copy_array) | |
CDynamicArray (T *p_array, int32_t p_dim1_size, int32_t p_dim2_size, bool p_free_array, bool p_copy_array) | |
CDynamicArray (T *p_array, int32_t p_dim1_size, int32_t p_dim2_size, int32_t p_dim3_size, bool p_free_array, bool p_copy_array) | |
CDynamicArray (const T *p_array, int32_t p_dim1_size=1, int32_t p_dim2_size=1, int32_t p_dim3_size=1) | |
virtual | ~CDynamicArray () |
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 |
const T & | get_element (int32_t idx1, int32_t idx2=0, int32_t idx3=0) const |
const T & | element (int32_t idx1, int32_t idx2=0, int32_t idx3=0) const |
T & | element (int32_t idx1, int32_t idx2=0, int32_t idx3=0) |
T & | element (T *p_array, int32_t idx1, int32_t idx2=0, int32_t idx3=0) |
T & | element (T *p_array, int32_t idx1, int32_t idx2, int32_t idx3, int32_t p_dim1_size, int32_t p_dim2_size) |
T | get_last_element () const |
T | get_element_safe (int32_t index) const |
bool | set_element (T e, int32_t idx1, int32_t idx2=0, int32_t idx3=0) |
bool | insert_element (T e, int32_t index) |
bool | append_element (T e) |
void | push_back (T e) |
void | pop_back () |
T | back () |
int32_t | find_element (T e) |
bool | delete_element (int32_t idx) |
bool | resize_array (int32_t ndim1, int32_t ndim2=1, int32_t ndim3=1) |
void | set_const (const T &const_element) |
T * | get_array () const |
void | set_array (T *p_array, int32_t p_num_elements, int32_t array_size) |
void | set_array (T *p_array, int32_t dim1, bool p_free_array, bool copy_array) |
void | set_array (T *p_array, int32_t dim1, int32_t dim2, bool p_free_array, bool copy_array) |
void | set_array (T *p_array, int32_t dim1, int32_t dim2, int32_t dim3, bool p_free_array, bool copy_array) |
void | set_array (const T *p_array, int32_t p_size) |
void | clear_array (T value) |
void | reset_array () |
const T & | operator[] (int32_t index) const |
T & | operator[] (int32_t index) |
CDynamicArray< T > & | operator= (CDynamicArray< T > &orig) |
void | shuffle () |
void | shuffle (CRandom *rand) |
void | set_array_name (const char *p_name) |
const char * | get_array_name () const |
void | display_array () |
void | display_size () |
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 () |
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 () |
Public Attributes | |
SGIO * | io |
Parallel * | parallel |
Version * | version |
Parameter * | m_parameters |
Parameter * | m_model_selection_parameters |
Parameter * | m_gradient_parameters |
ParameterMap * | m_parameter_map |
uint32_t | m_hash |
Protected Member Functions | |
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_post () throw (ShogunException) |
virtual void | save_serializable_post () throw (ShogunException) |
Protected Attributes | |
DynArray< T > | m_array |
int32_t | dim1_size |
int32_t | dim2_size |
int32_t | dim3_size |
const char * | name |
CDynamicArray | ( | ) |
default constructor
Definition at line 32 of file DynamicArray.h.
CDynamicArray | ( | int32_t | p_dim1_size, |
int32_t | p_dim2_size = 1 , |
||
int32_t | p_dim3_size = 1 |
||
) |
constructor
p_dim1_size | dimension 1 |
p_dim2_size | dimension 2 |
p_dim3_size | dimension 3 |
Definition at line 48 of file DynamicArray.h.
CDynamicArray | ( | T * | p_array, |
int32_t | p_dim1_size, | ||
bool | p_free_array, | ||
bool | p_copy_array | ||
) |
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 65 of file DynamicArray.h.
CDynamicArray | ( | T * | p_array, |
int32_t | p_dim1_size, | ||
int32_t | p_dim2_size, | ||
bool | p_free_array, | ||
bool | p_copy_array | ||
) |
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 83 of file DynamicArray.h.
CDynamicArray | ( | T * | p_array, |
int32_t | p_dim1_size, | ||
int32_t | p_dim2_size, | ||
int32_t | p_dim3_size, | ||
bool | p_free_array, | ||
bool | p_copy_array | ||
) |
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 103 of file DynamicArray.h.
CDynamicArray | ( | const T * | p_array, |
int32_t | p_dim1_size = 1 , |
||
int32_t | p_dim2_size = 1 , |
||
int32_t | p_dim3_size = 1 |
||
) |
constructor
p_array | another array |
p_dim1_size | dimension 1 |
p_dim2_size | dimension 2 |
p_dim3_size | dimension 3 |
Definition at line 121 of file DynamicArray.h.
|
virtual |
Definition at line 131 of file DynamicArray.h.
bool append_element | ( | T | e | ) |
append array element to the end of array
e | element to append |
Definition at line 325 of file DynamicArray.h.
T back | ( | ) |
STD VECTOR compatible. Return array element at the end of array.
Definition at line 351 of file DynamicArray.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 1196 of file SGObject.cpp.
void clear_array | ( | T | value | ) |
clear the array (with e.g. zeros)
value | value to fill array with |
Definition at line 488 of file DynamicArray.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 1313 of file SGObject.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 160 of file SGObject.h.
bool delete_element | ( | int32_t | idx | ) |
delete array element at idx (does not call SG_FREE() or the like)
idx | index |
Definition at line 373 of file DynamicArray.h.
void display_array | ( | ) |
display this array
Definition at line 562 of file DynamicArray.h.
void display_size | ( | ) |
display array's size
Definition at line 580 of file DynamicArray.h.
const T& element | ( | int32_t | idx1, |
int32_t | idx2 = 0 , |
||
int32_t | idx3 = 0 |
||
) | const |
get array element at index
idx1 | index 1 |
idx2 | index 2 |
idx3 | index 3 |
Definition at line 222 of file DynamicArray.h.
T& 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 234 of file DynamicArray.h.
T& element | ( | T * | p_array, |
int32_t | idx1, | ||
int32_t | idx2 = 0 , |
||
int32_t | idx3 = 0 |
||
) |
get element of given array at given index
p_array | another array |
idx1 | index 1 |
idx2 | index 2 |
idx3 | index 3 |
Definition at line 247 of file DynamicArray.h.
T& element | ( | T * | p_array, |
int32_t | idx1, | ||
int32_t | idx2, | ||
int32_t | idx3, | ||
int32_t | p_dim1_size, | ||
int32_t | p_dim2_size | ||
) |
get element of given array at given index
p_array | another array |
idx1 | index 1 |
idx2 | index 2 |
idx3 | index 3 |
p_dim1_size | size of dimension 1 |
p_dim2_size | size of dimension 2 |
Definition at line 265 of file DynamicArray.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) |
Definition at line 1217 of file SGObject.cpp.
int32_t find_element | ( | T | e | ) |
find first occurence of array element and return its index or -1 if not available
e | element to search for |
Definition at line 362 of file DynamicArray.h.
T* get_array | ( | ) | const |
get the array call get_array just before messing with it DO NOT call any [],resize/delete functions after get_array(), the pointer may become invalid !
Definition at line 406 of file DynamicArray.h.
const char* get_array_name | ( | ) | const |
int32_t get_array_size | ( | ) |
get array size (including granularity buffer)
Definition at line 147 of file DynamicArray.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 157 of file DynamicArray.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 169 of file DynamicArray.h.
int32_t get_dim1 | ( | ) |
int32_t get_dim2 | ( | ) |
int32_t get_dim3 | ( | ) |
const T& get_element | ( | int32_t | idx1, |
int32_t | idx2 = 0 , |
||
int32_t | idx3 = 0 |
||
) | const |
get array element at index
idx1 | index 1 |
idx2 | index 2 |
idx3 | index 3 |
Definition at line 210 of file DynamicArray.h.
T get_element_safe | ( | int32_t | index | ) | const |
get array element at index
(does bounds checking)
index | index |
Definition at line 291 of file DynamicArray.h.
|
inherited |
|
inherited |
|
inherited |
T get_last_element | ( | ) | const |
gets last array element
Definition at line 279 of file DynamicArray.h.
|
inherited |
Definition at line 1100 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 1124 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1137 of file SGObject.cpp.
|
virtual |
int32_t get_num_elements | ( | ) | const |
bool insert_element | ( | T | e, |
int32_t | index | ||
) |
insert array element at index
e | element to insert |
index | index |
Definition at line 315 of file DynamicArray.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 268 of file SGObject.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::get_version_parameter() for this in most cases) |
file | file to load from |
prefix | prefix for members |
Definition at line 673 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 514 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) |
Definition at line 345 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, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 1029 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 599 of file DynamicArray.h.
|
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 711 of file SGObject.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 918 of file SGObject.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 858 of file SGObject.cpp.
CDynamicArray<T>& operator= | ( | CDynamicArray< T > & | orig | ) |
operator overload for array assignment
orig | original array |
Definition at line 530 of file DynamicArray.h.
const T& operator[] | ( | int32_t | index | ) | const |
operator overload for array read only access use set_element() for write access (will also make the array dynamically grow)
DOES NOT DO ANY BOUNDS CHECKING
index | index |
Definition at line 508 of file DynamicArray.h.
T& operator[] | ( | int32_t | index | ) |
operator overload for array read-write access
DOES NOT DO ANY BOUNDS CHECKING
index | index |
Definition at line 520 of file DynamicArray.h.
void pop_back | ( | ) |
STD VECTOR compatible. Delete array element at the end of array.
Definition at line 341 of file DynamicArray.h.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1076 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 280 of file SGObject.cpp.
void push_back | ( | T | e | ) |
STD VECTOR compatible. Append array element to the end of array.
e | element to append |
Definition at line 335 of file DynamicArray.h.
void reset_array | ( | ) |
resets the array
Definition at line 494 of file DynamicArray.h.
bool resize_array | ( | int32_t | ndim1, |
int32_t | ndim2 = 1 , |
||
int32_t | ndim3 = 1 |
||
) |
resize array
ndim1 | new dimension 1 |
ndim2 | new dimension 2 |
ndim3 | new dimension 3 |
Definition at line 385 of file DynamicArray.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 |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Definition at line 286 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 1039 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 614 of file DynamicArray.h.
void set_array | ( | T * | p_array, |
int32_t | p_num_elements, | ||
int32_t | array_size | ||
) |
set the array pointer and free previously allocated memory
p_array | new array |
p_num_elements | last element index + 1 |
array_size | number of elements in array |
Definition at line 417 of file DynamicArray.h.
void set_array | ( | T * | p_array, |
int32_t | dim1, | ||
bool | p_free_array, | ||
bool | copy_array | ||
) |
set the array pointer and free previously allocated memory
p_array | another array |
dim1 | dimension 1 |
p_free_array | if array must be freed |
copy_array | if array must be copied |
Definition at line 430 of file DynamicArray.h.
void set_array | ( | T * | p_array, |
int32_t | dim1, | ||
int32_t | dim2, | ||
bool | p_free_array, | ||
bool | copy_array | ||
) |
set the 2d array pointer and free previously allocated memory
p_array | another array |
dim1 | dimension 1 |
dim2 | dimension 2 |
p_free_array | if array must be freed |
copy_array | if array must be copied |
Definition at line 447 of file DynamicArray.h.
void set_array | ( | T * | p_array, |
int32_t | dim1, | ||
int32_t | dim2, | ||
int32_t | dim3, | ||
bool | p_free_array, | ||
bool | copy_array | ||
) |
set the 3d array pointer and free previously allocated memory
p_array | another array |
dim1 | dimension 1 |
dim2 | dimension 2 |
dim3 | dimension 3 |
p_free_array | if array must be freed |
copy_array | if array must be copied |
Definition at line 466 of file DynamicArray.h.
void set_array | ( | const T * | p_array, |
int32_t | p_size | ||
) |
set the array pointer and free previously allocated memory
p_array | another array |
p_size | size of another array |
Definition at line 480 of file DynamicArray.h.
void set_array_name | ( | const char * | p_name | ) |
void set_const | ( | const T & | const_element | ) |
set array with a constant
Definition at line 394 of file DynamicArray.h.
bool set_element | ( | T | 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 304 of file DynamicArray.h.
|
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 220 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 255 of file SGObject.cpp.
int32_t set_granularity | ( | int32_t | g | ) |
set the resize granularity
g | new granularity |
Definition at line 138 of file DynamicArray.h.
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 151 of file SGObject.h.
void shuffle | ( | ) |
shuffles the array (not thread safe!)
Definition at line 541 of file DynamicArray.h.
void shuffle | ( | CRandom * | rand | ) |
shuffles the array with external random state
Definition at line 544 of file DynamicArray.h.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 275 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination.
Definition at line 227 of file SGObject.cpp.
|
protected |
dimension 1
Definition at line 653 of file DynamicArray.h.
|
protected |
dimension 2
Definition at line 656 of file DynamicArray.h.
|
protected |
dimension 3
Definition at line 659 of file DynamicArray.h.
|
inherited |
io
Definition at line 514 of file SGObject.h.
|
protected |
underlying array
Definition at line 650 of file DynamicArray.h.
|
inherited |
parameters wrt which we can compute gradients
Definition at line 529 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 535 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 526 of file SGObject.h.
|
inherited |
map for different parameter versions
Definition at line 532 of file SGObject.h.
|
inherited |
parameters
Definition at line 523 of file SGObject.h.
|
protected |
array's name
Definition at line 662 of file DynamicArray.h.
|
inherited |
parallel
Definition at line 517 of file SGObject.h.
|
inherited |
version
Definition at line 520 of file SGObject.h.