SHOGUN  6.1.3
List of all members | Public Types | Public Member Functions | Public Attributes | Protected Member Functions
CDynamicObjectArray Class Reference

Detailed Description

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.

Inheritance diagram for CDynamicObjectArray:
[legend]

Public Types

typedef rxcpp::subjects::subject< ObservedValueSGSubject
 
typedef rxcpp::observable< ObservedValue, rxcpp::dynamic_observable< ObservedValue > > SGObservable
 
typedef rxcpp::subscriber< ObservedValue, rxcpp::observer< ObservedValue, void, void, void, void > > SGSubscriber
 

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
 
CSGObjectget_element (int32_t index) const
 
CSGObjectelement (int32_t idx1, int32_t idx2=0, int32_t idx3=0)
 
CSGObjectget_last_element () const
 
CSGObjectget_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 ()
 
CSGObjectback () const
 
int32_t find_element (CSGObject *elem) const
 
bool delete_element (int32_t idx)
 
void clear_array ()
 
void reset_array ()
 
CDynamicObjectArrayoperator= (CDynamicObjectArray &orig)
 
CSGObject ** get_array () const
 
void shuffle ()
 
void shuffle (CRandom *rand)
 
virtual const char * get_name () const
 
virtual void load_serializable_pre () throw (ShogunException)
 
virtual void save_serializable_pre () throw (ShogunException)
 
virtual CSGObjectclone ()
 
int32_t ref ()
 
int32_t ref_count ()
 
int32_t unref ()
 
virtual CSGObjectshallow_copy () const
 
virtual CSGObjectdeep_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)
 
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)
 
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 >
get (const Tag< T > &_tag) const
 
template<typename T , typename U = void>
get (const std::string &name) const
 
SGObservableget_parameters_observable ()
 
void subscribe_to_parameters (ParameterObserverInterface *obs)
 
void list_observable_parameters ()
 
virtual void update_parameter_hash ()
 
virtual bool parameter_hash_changed ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)
 

Public Attributes

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_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)
 
bool clone_parameters (CSGObject *other)
 
void observe (const ObservedValue value)
 
void register_observable_param (const std::string &name, const SG_OBS_VALUE_TYPE type, const std::string &description)
 

Member Typedef Documentation

◆ SGObservable

Definition at line 130 of file SGObject.h.

◆ SGSubject

Definition at line 127 of file SGObject.h.

◆ SGSubscriber

typedef rxcpp::subscriber< ObservedValue, rxcpp::observer<ObservedValue, void, void, void, void> > SGSubscriber
inherited

Definition at line 133 of file SGObject.h.

Constructor & Destructor Documentation

◆ CDynamicObjectArray() [1/5]

default constructor

Definition at line 35 of file DynamicObjectArray.h.

◆ CDynamicObjectArray() [2/5]

CDynamicObjectArray ( int32_t  dim1,
int32_t  dim2 = 1,
int32_t  dim3 = 1 
)

constructor

Parameters
dim1dimension 1
dim2dimension 2
dim3dimension 3

Definition at line 51 of file DynamicObjectArray.h.

◆ CDynamicObjectArray() [3/5]

CDynamicObjectArray ( CSGObject **  p_array,
int32_t  p_dim1_size,
bool  p_free_array = true,
bool  p_copy_array = false 
)

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

◆ CDynamicObjectArray() [4/5]

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

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

◆ CDynamicObjectArray() [5/5]

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

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

◆ ~CDynamicObjectArray()

virtual ~CDynamicObjectArray ( )
virtual

Definition at line 117 of file DynamicObjectArray.h.

Member Function Documentation

◆ append_element()

bool append_element ( CSGObject e)

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.

◆ back()

CSGObject* back ( ) const

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.

◆ build_gradient_parameter_dictionary()

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

◆ clear_array()

void clear_array ( )

clear the array (with zeros)

Definition at line 355 of file DynamicObjectArray.h.

◆ clone()

virtual CSGObject* clone ( )
virtual

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

Reimplemented from CSGObject.

Definition at line 430 of file DynamicObjectArray.h.

◆ clone_parameters()

bool clone_parameters ( CSGObject other)
protectedinherited

Definition at line 759 of file SGObject.cpp.

◆ deep_copy()

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 232 of file SGObject.cpp.

◆ delete_element()

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

◆ element()

CSGObject* 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 208 of file DynamicObjectArray.h.

◆ equals()

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

◆ find_element()

int32_t find_element ( CSGObject elem) const

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.

◆ get() [1/2]

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 381 of file SGObject.h.

◆ get() [2/2]

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 404 of file SGObject.h.

◆ get_array()

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

Definition at line 388 of file DynamicObjectArray.h.

◆ get_array_size() [1/3]

int32_t get_array_size ( )

get array size (including granularity buffer)

Returns
total array size (including granularity buffer)

Definition at line 131 of file DynamicObjectArray.h.

◆ get_array_size() [2/3]

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

◆ get_array_size() [3/3]

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

◆ get_dim1()

int32_t get_dim1 ( )

get dimension 1

Returns
dimension 1

Definition at line 164 of file DynamicObjectArray.h.

◆ get_dim2()

int32_t get_dim2 ( )

get dimension 2

Returns
dimension 2

Definition at line 170 of file DynamicObjectArray.h.

◆ get_dim3()

int32_t get_dim3 ( )

get dimension 3

Returns
dimension 3

Definition at line 176 of file DynamicObjectArray.h.

◆ get_element()

CSGObject* get_element ( int32_t  index) const

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.

◆ get_element_safe()

CSGObject* 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 231 of file DynamicObjectArray.h.

◆ get_global_io()

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 269 of file SGObject.cpp.

◆ get_global_parallel()

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 311 of file SGObject.cpp.

◆ get_global_version()

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 324 of file SGObject.cpp.

◆ get_last_element()

CSGObject* get_last_element ( ) const

get last array element

Returns
last array element

Definition at line 217 of file DynamicObjectArray.h.

◆ get_modelsel_names()

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

Definition at line 536 of file SGObject.cpp.

◆ get_modsel_param_descr()

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

◆ get_modsel_param_index()

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

◆ get_name()

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

Implements CSGObject.

Definition at line 397 of file DynamicObjectArray.h.

◆ get_num_elements()

int32_t get_num_elements ( ) const

get number of elements

Returns
number of elements

Definition at line 182 of file DynamicObjectArray.h.

◆ get_parameters_observable()

SGObservable* get_parameters_observable ( )
inherited

Get parameters observable

Returns
RxCpp observable

Definition at line 415 of file SGObject.h.

◆ has() [1/3]

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 304 of file SGObject.h.

◆ has() [2/3]

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 315 of file SGObject.h.

◆ has() [3/3]

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 326 of file SGObject.h.

◆ insert_element()

bool insert_element ( CSGObject e,
int32_t  index 
)

insert array element at index

Parameters
eelement to insert
indexindex
Returns
if setting was successful

Definition at line 271 of file DynamicObjectArray.h.

◆ is_generic()

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

◆ list_observable_parameters()

void list_observable_parameters ( )
inherited

Print to stdout a list of observable parameters

Definition at line 878 of file SGObject.cpp.

◆ load_serializable()

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

◆ load_serializable_post()

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

◆ load_serializable_pre()

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

◆ observe()

void observe ( const ObservedValue  value)
protectedinherited

Observe a parameter value and emit them to observer.

Parameters
valueObserved parameter's value

Definition at line 828 of file SGObject.cpp.

◆ operator=()

CDynamicObjectArray& operator= ( CDynamicObjectArray orig)

operator overload for array assignment

Parameters
origoriginal array
Returns
new array

Definition at line 373 of file DynamicObjectArray.h.

◆ parameter_hash_changed()

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

Definition at line 296 of file SGObject.cpp.

◆ pop_back()

void pop_back ( )

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

Definition at line 308 of file DynamicObjectArray.h.

◆ print_modsel_params()

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 512 of file SGObject.cpp.

◆ print_serializable()

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 342 of file SGObject.cpp.

◆ push_back()

void push_back ( CSGObject e)

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

Parameters
eelement to append

Definition at line 299 of file DynamicObjectArray.h.

◆ ref()

int32_t ref ( )
inherited

increase reference counter

Returns
reference count

Definition at line 186 of file SGObject.cpp.

◆ ref_count()

int32_t ref_count ( )
inherited

display reference counter

Returns
reference count

Definition at line 193 of file SGObject.cpp.

◆ register_observable_param()

void register_observable_param ( const std::string &  name,
const SG_OBS_VALUE_TYPE  type,
const std::string &  description 
)
protectedinherited

Register which params this object can emit.

Parameters
namethe param name
typethe param type
descriptiona user oriented description

Definition at line 871 of file SGObject.cpp.

◆ register_param() [1/2]

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 472 of file SGObject.h.

◆ register_param() [2/2]

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 485 of file SGObject.h.

◆ reset_array()

void reset_array ( )

resets the array

Definition at line 362 of file DynamicObjectArray.h.

◆ save_serializable()

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

◆ save_serializable_post()

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

◆ save_serializable_pre()

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

◆ set() [1/2]

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 342 of file SGObject.h.

◆ set() [2/2]

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 368 of file SGObject.h.

◆ set_element()

bool set_element ( CSGObject 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 246 of file DynamicObjectArray.h.

◆ set_generic() [1/16]

void set_generic ( )
inherited

Definition at line 73 of file SGObject.cpp.

◆ set_generic() [2/16]

void set_generic ( )
inherited

Definition at line 78 of file SGObject.cpp.

◆ set_generic() [3/16]

void set_generic ( )
inherited

Definition at line 83 of file SGObject.cpp.

◆ set_generic() [4/16]

void set_generic ( )
inherited

Definition at line 88 of file SGObject.cpp.

◆ set_generic() [5/16]

void set_generic ( )
inherited

Definition at line 93 of file SGObject.cpp.

◆ set_generic() [6/16]

void set_generic ( )
inherited

Definition at line 98 of file SGObject.cpp.

◆ set_generic() [7/16]

void set_generic ( )
inherited

Definition at line 103 of file SGObject.cpp.

◆ set_generic() [8/16]

void set_generic ( )
inherited

Definition at line 108 of file SGObject.cpp.

◆ set_generic() [9/16]

void set_generic ( )
inherited

Definition at line 113 of file SGObject.cpp.

◆ set_generic() [10/16]

void set_generic ( )
inherited

Definition at line 118 of file SGObject.cpp.

◆ set_generic() [11/16]

void set_generic ( )
inherited

Definition at line 123 of file SGObject.cpp.

◆ set_generic() [12/16]

void set_generic ( )
inherited

Definition at line 128 of file SGObject.cpp.

◆ set_generic() [13/16]

void set_generic ( )
inherited

Definition at line 133 of file SGObject.cpp.

◆ set_generic() [14/16]

void set_generic ( )
inherited

Definition at line 138 of file SGObject.cpp.

◆ set_generic() [15/16]

void set_generic ( )
inherited

Definition at line 143 of file SGObject.cpp.

◆ set_generic() [16/16]

void set_generic ( )
inherited

set generic type to T

◆ set_global_io()

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 262 of file SGObject.cpp.

◆ set_global_parallel()

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 275 of file SGObject.cpp.

◆ set_global_version()

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 317 of file SGObject.cpp.

◆ set_granularity()

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

◆ shallow_copy()

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

◆ shuffle() [1/2]

void shuffle ( )

shuffles the array (not thread safe!)

Definition at line 391 of file DynamicObjectArray.h.

◆ shuffle() [2/2]

void shuffle ( CRandom rand)

shuffles the array with external random state

Definition at line 394 of file DynamicObjectArray.h.

◆ subscribe_to_parameters()

void subscribe_to_parameters ( ParameterObserverInterface obs)
inherited

Subscribe a parameter observer to watch over params

Definition at line 811 of file SGObject.cpp.

◆ unref()

int32_t unref ( )
inherited

decrement reference counter and deallocate object if refcount is zero before or after decrementing it

Returns
reference count

Definition at line 200 of file SGObject.cpp.

◆ unset_generic()

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 337 of file SGObject.cpp.

◆ update_parameter_hash()

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 282 of file SGObject.cpp.

Member Data Documentation

◆ io

SGIO* io
inherited

io

Definition at line 600 of file SGObject.h.

◆ m_gradient_parameters

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 615 of file SGObject.h.

◆ m_hash

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 618 of file SGObject.h.

◆ m_model_selection_parameters

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 612 of file SGObject.h.

◆ m_parameters

Parameter* m_parameters
inherited

parameters

Definition at line 609 of file SGObject.h.

◆ parallel

Parallel* parallel
inherited

parallel

Definition at line 603 of file SGObject.h.

◆ version

Version* version
inherited

version

Definition at line 606 of file SGObject.h.


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

SHOGUN Machine Learning Toolbox - Documentation