SHOGUN  4.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions
CWrappedObjectArray Class Reference

Detailed Description

Specialization of CDynamicObjectArray that adds methods to append wrapped elements to make them serializable. Objects are wrapped through the classes CWrappedBasic, CWrappedSGVector, CWrappedSGMatrix.

Definition at line 52 of file WrappedObjectArray.h.

Inheritance diagram for CWrappedObjectArray:
[legend]

Public Member Functions

 CWrappedObjectArray ()
 
template<class T >
bool append_wrapped (T data, const char *data_name="")
 
template<class T >
bool append_wrapped (SGVector< T > data, const char *data_name="")
 
template<class T >
bool append_wrapped (SGMatrix< T > data, const char *data_name="")
 
virtual const char * get_name () const
 
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 ()
 
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 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)
 
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 ()
 

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)
 
template<typename T >
void register_param (Tag< T > &_tag, const T &value)
 
template<typename T >
void register_param (const std::string &name, const T &value)
 

Constructor & Destructor Documentation

CWrappedObjectArray ( )

Definition at line 55 of file WrappedObjectArray.h.

Member Function Documentation

bool append_element ( CSGObject *  e)
inherited

append array element to the end of array

Parameters
eelement to append
Returns
if setting was successful

Definition at line 285 of file DynamicObjectArray.h.

bool append_wrapped ( T  data,
const char *  data_name = "" 
)

Works as CDynamicObjectArray::append_element, but accepts basic Shogun types, which are wrapped through CWrappedBasicObject.

Parameters
dataData element to append, after being wrapped.
data_nameName of wrapped data element.

Definition at line 63 of file WrappedObjectArray.h.

bool append_wrapped ( SGVector< T >  data,
const char *  data_name = "" 
)

Works as CDynamicObjectArray::append_element, but accepts SGVector, which are wrapped through CWrappedSGVectorObject.

Parameters
dataData element to append, after being wrapped.
data_nameName of wrapped data element.

Definition at line 74 of file WrappedObjectArray.h.

bool append_wrapped ( SGMatrix< T >  data,
const char *  data_name = "" 
)

Works as CDynamicObjectArray::append_element, but accepts SGMatrix, which are wrapped through CWrappedSGVectorObject.

Parameters
dataData element to append, after being wrapped.
data_nameName of wrapped data element.

Definition at line 86 of file WrappedObjectArray.h.

CSGObject* back ( ) const
inherited

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

Returns
element at the end of array

Definition at line 321 of file DynamicObjectArray.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 630 of file SGObject.cpp.

void clear_array ( )
inherited

clear the array (with zeros)

Definition at line 355 of file DynamicObjectArray.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 747 of file SGObject.cpp.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 231 of file SGObject.cpp.

bool delete_element ( int32_t  idx)
inherited

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

Parameters
idxindex
Returns
if deleting was successful

Definition at line 345 of file DynamicObjectArray.h.

CSGObject* element ( int32_t  idx1,
int32_t  idx2 = 0,
int32_t  idx3 = 0 
)
inherited

get array element at index

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

Definition at line 208 of file DynamicObjectArray.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 651 of file SGObject.cpp.

int32_t find_element ( CSGObject *  elem) const
inherited

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

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

Definition at line 334 of file DynamicObjectArray.h.

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
_tagname 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
namename of the parameter
Returns
value of the parameter corresponding to the input name and type

Definition at line 388 of file SGObject.h.

CSGObject** get_array ( ) const
inherited
Returns
underlying array of pointers

Definition at line 388 of file DynamicObjectArray.h.

const char* get_array_name ( ) const
inherited

get array's name

Returns
array's name

Definition at line 409 of file DynamicObjectArray.h.

int32_t get_array_size ( )
inherited

get array size (including granularity buffer)

Returns
total array size (including granularity buffer)

Definition at line 131 of file DynamicObjectArray.h.

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

return 2d array size

Parameters
dim1dimension 1 will be stored here
dim2dimension 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 
)
inherited

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 153 of file DynamicObjectArray.h.

int32_t get_dim1 ( )
inherited

get dimension 1

Returns
dimension 1

Definition at line 164 of file DynamicObjectArray.h.

int32_t get_dim2 ( )
inherited

get dimension 2

Returns
dimension 2

Definition at line 170 of file DynamicObjectArray.h.

int32_t get_dim3 ( )
inherited

get dimension 3

Returns
dimension 3

Definition at line 176 of file DynamicObjectArray.h.

CSGObject* get_element ( int32_t  index) const
inherited

get array element at index

(does NOT do bounds checking)

Parameters
indexindex
Returns
array element at index

Definition at line 194 of file DynamicObjectArray.h.

CSGObject* get_element_safe ( int32_t  index) const
inherited

get array element at index

(does bounds checking)

Parameters
indexindex
Returns
array element at index

Definition at line 231 of file DynamicObjectArray.h.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 268 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 310 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 323 of file SGObject.cpp.

CSGObject* get_last_element ( ) const
inherited

get last array element

Returns
last array element

Definition at line 217 of file DynamicObjectArray.h.

SGStringList< char > get_modelsel_names ( )
inherited
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_namename 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_namename 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
Returns
name of the CSGObject, without C prefix

Reimplemented from CDynamicObjectArray.

Definition at line 93 of file WrappedObjectArray.h.

int32_t get_num_elements ( ) const
inherited

get number of elements

Returns
number of elements

Definition at line 182 of file DynamicObjectArray.h.

bool has ( const std::string &  name) const
inherited

Checks if object has a class parameter identified by a name.

Parameters
namename 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
tagtag 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
namename of the parameter
Returns
true if the parameter exists with the input name and type

Definition at line 312 of file SGObject.h.

bool insert_element ( CSGObject *  e,
int32_t  index 
)
inherited

insert array element at index

Parameters
eelement to insert
indexindex
Returns
if setting was successful

Definition at line 271 of file DynamicObjectArray.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 329 of file SGObject.cpp.

bool load_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
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
Returns
TRUE if done, otherwise FALSE

Definition at line 402 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 459 of file SGObject.cpp.

virtual void load_serializable_pre ( )
throw (ShogunException
)
virtualinherited

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 423 of file DynamicObjectArray.h.

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

Definition at line 295 of file SGObject.cpp.

void pop_back ( )
inherited

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

Definition at line 308 of file DynamicObjectArray.h.

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
prefixprefix for members

Definition at line 341 of file SGObject.cpp.

void push_back ( CSGObject *  e)
inherited

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

Parameters
eelement to append

Definition at line 299 of file DynamicObjectArray.h.

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
_tagname and type information of parameter
valuevalue 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
namename of the parameter
valuevalue of the parameter along with type information

Definition at line 452 of file SGObject.h.

void reset_array ( )
inherited

resets the array

Definition at line 362 of file DynamicObjectArray.h.

bool save_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
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
Returns
TRUE if done, otherwise FALSE

Definition at line 347 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 469 of file SGObject.cpp.

virtual void save_serializable_pre ( )
throw (ShogunException
)
virtualinherited

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 438 of file DynamicObjectArray.h.

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
_tagname and type information of parameter
valuevalue 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
namename of the parameter
valuevalue of the parameter along with type information

Definition at line 354 of file SGObject.h.

void set_array_name ( const char *  p_name)
inherited

set array's name

Parameters
p_namenew name

Definition at line 400 of file DynamicObjectArray.h.

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

set array element at index

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

Definition at line 246 of file DynamicObjectArray.h.

void set_generic ( )
inherited

Definition at line 74 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 79 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 84 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 89 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 94 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 99 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 104 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 109 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 114 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 119 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 124 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 129 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 134 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 139 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 144 of file SGObject.cpp.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO *  io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 261 of file SGObject.cpp.

void set_global_parallel ( Parallel *  parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 274 of file SGObject.cpp.

void set_global_version ( Version *  version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 316 of file SGObject.cpp.

int32_t set_granularity ( int32_t  g)
inherited

set the resize granularity

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

Definition at line 124 of file DynamicObjectArray.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 225 of file SGObject.cpp.

void shuffle ( )
inherited

shuffles the array (not thread safe!)

Definition at line 391 of file DynamicObjectArray.h.

void shuffle ( CRandom *  rand)
inherited

shuffles the array with external random state

Definition at line 394 of file DynamicObjectArray.h.

void unset_generic ( )
inherited

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.

Member Data Documentation

SGIO* io
inherited

io

Definition at line 537 of file SGObject.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 552 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 555 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 549 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 546 of file SGObject.h.

Parallel* parallel
inherited

parallel

Definition at line 540 of file SGObject.h.

Version* version
inherited

version

Definition at line 543 of file SGObject.h.

The documentation for this class was generated from the following file:
SHOGUN Machine Learning Toolbox - Documentation