SHOGUN  3.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CDynamicArray< T > Class Template Reference

Detailed Description

template<class T>
class shogun::CDynamicArray< T >

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 30 of file DynamicArray.h.

Inheritance diagram for CDynamicArray< T >:
Inheritance graph
[legend]

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)
get_last_element () const
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 ()
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 CSGObjectshallow_copy () const
virtual CSGObjectdeep_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)
SGIOget_global_io ()
void set_global_parallel (Parallel *parallel)
Parallelget_global_parallel ()
void set_global_version (Version *version)
Versionget_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 CSGObjectclone ()

Public Attributes

SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
Parameterm_gradient_parameters
ParameterMapm_parameter_map
uint32_t m_hash

Protected Member Functions

virtual TParametermigrate (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

Constructor & Destructor Documentation

default constructor

Definition at line 34 of file DynamicArray.h.

CDynamicArray ( int32_t  p_dim1_size,
int32_t  p_dim2_size = 1,
int32_t  p_dim3_size = 1 
)

constructor

Parameters
p_dim1_sizedimension 1
p_dim2_sizedimension 2
p_dim3_sizedimension 3

Definition at line 50 of file DynamicArray.h.

CDynamicArray ( T *  p_array,
int32_t  p_dim1_size,
bool  p_free_array,
bool  p_copy_array 
)

constructor

Parameters
p_arrayanother array
p_dim1_sizedimension 1
p_free_arrayif array must be freed
p_copy_arrayif array must be copied

Definition at line 67 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

Parameters
p_arrayanother array
p_dim1_sizedimension 1
p_dim2_sizedimension 2
p_free_arrayif array must be freed
p_copy_arrayif array must be copied

Definition at line 85 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

Parameters
p_arrayanother array
p_dim1_sizedimension 1
p_dim2_sizedimension 2
p_dim3_sizedimension 3
p_free_arrayif array must be freed
p_copy_arrayif array must be copied

Definition at line 105 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

Parameters
p_arrayanother array
p_dim1_sizedimension 1
p_dim2_sizedimension 2
p_dim3_sizedimension 3

Definition at line 123 of file DynamicArray.h.

virtual ~CDynamicArray ( )
virtual

Definition at line 133 of file DynamicArray.h.

Member Function Documentation

bool append_element ( e)

append array element to the end of array

Parameters
eelement to append
Returns
if setting was successful

Definition at line 327 of file DynamicArray.h.

T back ( )

STD VECTOR compatible. Return array element at the end of array.

Returns
element at the end of array

Definition at line 353 of file DynamicArray.h.

void build_gradient_parameter_dictionary ( CMap< TParameter *, CSGObject * > *  dict)
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.

Parameters
dictdictionary of parameters to be built.

Definition at line 1243 of file SGObject.cpp.

void clear_array ( value)

clear the array (with e.g. zeros)

Parameters
valuevalue to fill array with

Definition at line 490 of file DynamicArray.h.

CSGObject * clone ( )
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.

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 1360 of file SGObject.cpp.

CSGObject * deep_copy ( ) const
virtualinherited

A deep copy. All the instance variables will also be copied.

Definition at line 200 of file SGObject.cpp.

bool delete_element ( int32_t  idx)

delete array element at idx (does not call SG_FREE() or the like)

Parameters
idxindex
Returns
if deleting was successful

Definition at line 375 of file DynamicArray.h.

void display_array ( )

display this array

Definition at line 564 of file DynamicArray.h.

void display_size ( )

display array's size

Definition at line 582 of file DynamicArray.h.

const T& element ( int32_t  idx1,
int32_t  idx2 = 0,
int32_t  idx3 = 0 
) const

get array element at index

Parameters
idx1index 1
idx2index 2
idx3index 3
Returns
array element at index

Definition at line 224 of file DynamicArray.h.

T& element ( int32_t  idx1,
int32_t  idx2 = 0,
int32_t  idx3 = 0 
)

get array element at index

Parameters
idx1index 1
idx2index 2
idx3index 3
Returns
array element at index

Definition at line 236 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

Parameters
p_arrayanother array
idx1index 1
idx2index 2
idx3index 3
Returns
array element at index

Definition at line 249 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

Parameters
p_arrayanother array
idx1index 1
idx2index 2
idx3index 3
p_dim1_sizesize of dimension 1
p_dim2_sizesize of dimension 2
Returns
element of given array at given index

Definition at line 267 of file DynamicArray.h.

bool equals ( CSGObject other,
float64_t  accuracy = 0.0,
bool  tolerant = false 
)
virtualinherited

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
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
Returns
true if all parameters were equal, false if not

Definition at line 1264 of file SGObject.cpp.

int32_t find_element ( e)

find first occurence of array element and return its index or -1 if not available

Parameters
eelement to search for
Returns
index of element or -1

Definition at line 364 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 !

Returns
the array

Definition at line 408 of file DynamicArray.h.

const char* get_array_name ( ) const

get array's name

Returns
array's name

Definition at line 561 of file DynamicArray.h.

int32_t get_array_size ( )

get array size (including granularity buffer)

Returns
total array size

Definition at line 149 of file DynamicArray.h.

void get_array_size ( int32_t &  dim1,
int32_t &  dim2 
)

return 2d array size

Parameters
dim1dimension 1 will be stored here
dim2dimension 2 will be stored here

Definition at line 159 of file DynamicArray.h.

void get_array_size ( int32_t &  dim1,
int32_t &  dim2,
int32_t &  dim3 
)

return 3d array size

Parameters
dim1dimension 1 will be stored here
dim2dimension 2 will be stored here
dim3dimension 3 will be stored here

Definition at line 171 of file DynamicArray.h.

int32_t get_dim1 ( )

get dimension 1

Returns
dimension 1

Definition at line 182 of file DynamicArray.h.

int32_t get_dim2 ( )

get dimension 2

Returns
dimension 2

Definition at line 188 of file DynamicArray.h.

int32_t get_dim3 ( )

get dimension 3

Returns
dimension 3

Definition at line 194 of file DynamicArray.h.

const T& get_element ( int32_t  idx1,
int32_t  idx2 = 0,
int32_t  idx3 = 0 
) const

get array element at index

Parameters
idx1index 1
idx2index 2
idx3index 3
Returns
array element at index

Definition at line 212 of file DynamicArray.h.

T get_element_safe ( int32_t  index) const

get array element at index

(does bounds checking)

Parameters
indexindex
Returns
array element at index

Definition at line 293 of file DynamicArray.h.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 237 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 278 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 291 of file SGObject.cpp.

T get_last_element ( ) const

gets last array element

Returns
array element at last index

Definition at line 281 of file DynamicArray.h.

SGStringList< char > get_modelsel_names ( )
inherited
Returns
vector of names of all parameters which are registered for model selection

Definition at line 1135 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_namename of the parameter
Returns
description of the parameter

Definition at line 1159 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_namename of model selection parameter
Returns
index of model selection parameter with provided name, -1 if there is no such

Definition at line 1172 of file SGObject.cpp.

virtual const char* get_name ( ) const
virtual
Returns
object name

Implements CSGObject.

Definition at line 588 of file DynamicArray.h.

int32_t get_num_elements ( ) const

get number of elements

Returns
number of elements

Definition at line 200 of file DynamicArray.h.

bool insert_element ( e,
int32_t  index 
)

insert array element at index

Parameters
eelement to insert
indexindex
Returns
if setting was successful

Definition at line 317 of file DynamicArray.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
genericset to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 297 of file SGObject.cpp.

DynArray< TParameter * > * load_all_file_parameters ( int32_t  file_version,
int32_t  current_version,
CSerializableFile file,
const char *  prefix = "" 
)
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)

Parameters
file_versionparameter version of the file
current_versionversion from which mapping begins (you want to use Version::get_version_parameter() for this in most cases)
filefile to load from
prefixprefix for members
Returns
(sorted) array of created TParameter instances with file data

Definition at line 704 of file SGObject.cpp.

DynArray< TParameter * > * load_file_parameters ( const SGParamInfo param_info,
int32_t  file_version,
CSerializableFile file,
const char *  prefix = "" 
)
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

Parameters
param_infoinformation of parameter
file_versionparameter version of the file, must be <= provided parameter version
filefile to load from
prefixprefix for members
Returns
new array with TParameter instances with the attached data

Definition at line 545 of file SGObject.cpp.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

Parameters
filewhere to load from
prefixprefix for members
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Definition at line 374 of file SGObject.cpp.

void load_serializable_post ( ) throw (ShogunException)
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.

Exceptions
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.

Definition at line 1062 of file SGObject.cpp.

virtual void load_serializable_pre ( ) throw (ShogunException)
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.

Exceptions
ShogunExceptionWill be thrown if an error occurres.

Reimplemented from CSGObject.

Definition at line 601 of file DynamicArray.h.

void map_parameters ( DynArray< TParameter * > *  param_base,
int32_t &  base_version,
DynArray< const SGParamInfo * > *  target_param_infos 
)
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

Parameters
param_baseset of TParameter instances that are mapped to the provided target parameter infos
base_versionversion of the parameter base
target_param_infosset of SGParamInfo instances that specify the target parameter base

Definition at line 742 of file SGObject.cpp.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo target 
)
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

Parameters
param_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
Returns
a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

Definition at line 949 of file SGObject.cpp.

void one_to_one_migration_prepare ( DynArray< TParameter * > *  param_base,
const SGParamInfo target,
TParameter *&  replacement,
TParameter *&  to_migrate,
char *  old_name = NULL 
)
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)

Parameters
param_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
replacement(used as output) here the TParameter instance which is returned by migration is created into
to_migratethe only source that is used for migration
old_namewith this parameter, a name change may be specified

Definition at line 889 of file SGObject.cpp.

CDynamicArray<T>& operator= ( CDynamicArray< T > &  orig)

operator overload for array assignment

Parameters
origoriginal array
Returns
new array

Definition at line 532 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

Parameters
indexindex
Returns
element at index

Definition at line 510 of file DynamicArray.h.

T& operator[] ( int32_t  index)

operator overload for array read-write access

DOES NOT DO ANY BOUNDS CHECKING

Parameters
indexindex
Returns
element at index

Definition at line 522 of file DynamicArray.h.

bool parameter_hash_changed ( )
virtualinherited
Returns
whether parameter combination has changed since last update

Definition at line 263 of file SGObject.cpp.

void pop_back ( )

STD VECTOR compatible. Delete array element at the end of array.

Definition at line 343 of file DynamicArray.h.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 1111 of file SGObject.cpp.

void print_serializable ( const char *  prefix = "")
virtualinherited

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 309 of file SGObject.cpp.

void push_back ( e)

STD VECTOR compatible. Append array element to the end of array.

Parameters
eelement to append

Definition at line 337 of file DynamicArray.h.

void reset_array ( )

resets the array

Definition at line 496 of file DynamicArray.h.

bool resize_array ( int32_t  ndim1,
int32_t  ndim2 = 1,
int32_t  ndim3 = 1 
)

resize array

Parameters
ndim1new dimension 1
ndim2new dimension 2
ndim3new dimension 3
Returns
if resizing was successful

Definition at line 387 of file DynamicArray.h.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
virtualinherited

Save this object to file.

Parameters
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Definition at line 315 of file SGObject.cpp.

void save_serializable_post ( ) throw (ShogunException)
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
ShogunExceptionwill be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 1072 of file SGObject.cpp.

virtual void save_serializable_pre ( ) throw (ShogunException)
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.

Exceptions
ShogunExceptionWill be thrown if an error occurres.

Reimplemented from CSGObject.

Definition at line 616 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

Parameters
p_arraynew array
p_num_elementslast element index + 1
array_sizenumber of elements in array

Definition at line 419 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

Parameters
p_arrayanother array
dim1dimension 1
p_free_arrayif array must be freed
copy_arrayif array must be copied

Definition at line 432 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

Parameters
p_arrayanother array
dim1dimension 1
dim2dimension 2
p_free_arrayif array must be freed
copy_arrayif array must be copied

Definition at line 449 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

Parameters
p_arrayanother array
dim1dimension 1
dim2dimension 2
dim3dimension 3
p_free_arrayif array must be freed
copy_arrayif array must be copied

Definition at line 468 of file DynamicArray.h.

void set_array ( const T *  p_array,
int32_t  p_size 
)

set the array pointer and free previously allocated memory

Parameters
p_arrayanother array
p_sizesize of another array

Definition at line 482 of file DynamicArray.h.

void set_array_name ( const char *  p_name)

set array's name

Parameters
p_namenew name

Definition at line 552 of file DynamicArray.h.

void set_const ( const T &  const_element)

set array with a constant

Definition at line 396 of file DynamicArray.h.

bool set_element ( e,
int32_t  idx1,
int32_t  idx2 = 0,
int32_t  idx3 = 0 
)

set array element at index

Parameters
eelement to set
idx1index 1
idx2index 2
idx3index 2
Returns
if setting was successful

Definition at line 306 of file DynamicArray.h.

void set_generic< complex128_t > ( )
inherited

set generic type to T

Definition at line 42 of file SGObject.cpp.

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 230 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 243 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 284 of file SGObject.cpp.

int32_t set_granularity ( int32_t  g)

set the resize granularity

Parameters
gnew granularity
Returns
what has been set (minimum is 128)

Definition at line 140 of file DynamicArray.h.

CSGObject * shallow_copy ( ) const
virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

Reimplemented in CGaussianKernel.

Definition at line 194 of file SGObject.cpp.

void shuffle ( )

shuffles the array (not thread safe!)

Definition at line 543 of file DynamicArray.h.

void shuffle ( CRandom rand)

shuffles the array with external random state

Definition at line 546 of file DynamicArray.h.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 304 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 250 of file SGObject.cpp.

Member Data Documentation

int32_t dim1_size
protected

dimension 1

Definition at line 655 of file DynamicArray.h.

int32_t dim2_size
protected

dimension 2

Definition at line 658 of file DynamicArray.h.

int32_t dim3_size
protected

dimension 3

Definition at line 661 of file DynamicArray.h.

SGIO* io
inherited

io

Definition at line 496 of file SGObject.h.

DynArray<T> m_array
protected

underlying array

Definition at line 652 of file DynamicArray.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 511 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 517 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 508 of file SGObject.h.

ParameterMap* m_parameter_map
inherited

map for different parameter versions

Definition at line 514 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 505 of file SGObject.h.

const char* name
protected

array's name

Definition at line 664 of file DynamicArray.h.

Parallel* parallel
inherited

parallel

Definition at line 499 of file SGObject.h.

Version* version
inherited

version

Definition at line 502 of file SGObject.h.


The documentation for this class was generated from the following file:

SHOGUN Machine Learning Toolbox - Documentation