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 | Protected Attributes
CCombinedFeatures Class Reference

Detailed Description

The class CombinedFeatures is used to combine a number of of feature objects into a single CombinedFeatures object.

It keeps pointers to the added sub-features and is especially useful to combine kernels working on different domains (c.f. CCombinedKernel) and to combine kernels looking at independent features.

Subsets are supported: All actions will just be given through to all sub-features. Only once per sub-feature instance, i.e. if there are two sub-features that are the same instance, the subset action will only be performed once.

Definition at line 38 of file CombinedFeatures.h.

Inheritance diagram for CCombinedFeatures:
[legend]

Public Member Functions

 CCombinedFeatures ()
 
 CCombinedFeatures (const CCombinedFeatures &orig)
 
virtual CFeatures * duplicate () const
 
virtual ~CCombinedFeatures ()
 
virtual EFeatureType get_feature_type () const
 
virtual EFeatureClass get_feature_class () const
 
virtual int32_t get_num_vectors () const
 
void list_feature_objs ()
 
bool check_feature_obj_compatibility (CCombinedFeatures *comb_feat)
 
CFeatures * get_first_feature_obj ()
 
CFeatures * get_feature_obj (int32_t idx)
 
CFeatures * get_last_feature_obj ()
 
bool insert_feature_obj (CFeatures *obj, int32_t idx)
 
bool append_feature_obj (CFeatures *obj)
 
bool delete_feature_obj (int32_t idx)
 
int32_t get_num_feature_obj ()
 
CFeatures * create_merged_copy (CFeatures *other)
 
virtual void add_subset (SGVector< index_t > subset)
 
virtual void remove_subset ()
 
virtual void remove_all_subsets ()
 
virtual CFeatures * copy_subset (SGVector< index_t > indices)
 
virtual const char * get_name () const
 
virtual void add_preprocessor (CPreprocessor *p)
 
virtual void del_preprocessor (int32_t num)
 
CPreprocessor * get_preprocessor (int32_t num) const
 
void set_preprocessed (int32_t num)
 
bool is_preprocessed (int32_t num) const
 
int32_t get_num_preprocessed () const
 
int32_t get_num_preprocessors () const
 
void clean_preprocessors ()
 
void list_preprocessors ()
 
int32_t get_cache_size () const
 
virtual bool reshape (int32_t num_features, int32_t num_vectors)
 
void list_feature_obj () const
 
virtual void load (CFile *loader)
 
virtual void save (CFile *writer)
 
bool check_feature_compatibility (CFeatures *f) const
 
bool has_property (EFeatureProperty p) const
 
void set_property (EFeatureProperty p)
 
void unset_property (EFeatureProperty p)
 
virtual CFeatures * create_merged_copy (CList *others)
 
virtual void add_subset_in_place (SGVector< index_t > subset)
 
virtual CSubsetStack * get_subset_stack ()
 
virtual void subset_changed_post ()
 
virtual CFeatures * copy_dimension_subset (SGVector< index_t > dims)
 
virtual bool support_compatible_class () const
 
virtual bool get_feature_class_compatibility (EFeatureClass rhs) const
 
virtual CFeatures * shallow_subset_copy ()
 
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_pre () throw (ShogunException)
 
virtual void load_serializable_post () throw (ShogunException)
 
virtual void save_serializable_pre () 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)
 

Protected Attributes

CDynamicObjectArray * feature_array
 
int32_t num_vec
 
CSubsetStack * m_subset_stack
 

Constructor & Destructor Documentation

CCombinedFeatures ( )

default constructor

Definition at line 20 of file CombinedFeatures.cpp.

CCombinedFeatures ( const CCombinedFeatures &  orig)

copy constructor

Definition at line 29 of file CombinedFeatures.cpp.

~CCombinedFeatures ( )
virtual

destructor

Definition at line 44 of file CombinedFeatures.cpp.

Member Function Documentation

void add_preprocessor ( CPreprocessor *  p)
virtualinherited

add preprocessor

Parameters
ppreprocessor to set

Definition at line 85 of file Features.cpp.

void add_subset ( SGVector< index_t >  subset)
virtual

adds a subset of indices on top of the current subsets (possibly subset o subset. Calls subset_changed_post() afterwards. Adds the subset to all sub-features

Parameters
subsetsubset of indices to add

Reimplemented from CFeatures.

Definition at line 222 of file CombinedFeatures.cpp.

void add_subset_in_place ( SGVector< index_t >  subset)
virtualinherited

Sets/changes latest added subset. This allows to add multiple subsets with in-place memory requirements. They cannot be removed one-by-one afterwards, only the latest active can. If this is needed, use add_subset(). If no subset is active, this just adds.

Calls subset_changed_post() afterwards

Parameters
subsetsubset of indices to replace the latest one with.

Definition at line 316 of file Features.cpp.

bool append_feature_obj ( CFeatures *  obj)

append feature object to the end of this CombinedFeatures object array

Parameters
objfeature object to append
Returns
if appending was successful

Definition at line 141 of file CombinedFeatures.cpp.

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.

bool check_feature_compatibility ( CFeatures *  f) const
inherited

check feature compatibility

Parameters
ffeatures to check for compatibility
Returns
if features are compatible

Definition at line 283 of file Features.cpp.

bool check_feature_obj_compatibility ( CCombinedFeatures *  comb_feat)

check feature object compatibility

Parameters
comb_featfeature to check for compatibility
Returns
if feature is compatible

Definition at line 69 of file CombinedFeatures.cpp.

void clean_preprocessors ( )
inherited

clears all preprocs

Definition at line 116 of file Features.cpp.

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.

CFeatures * copy_dimension_subset ( SGVector< index_t >  dims)
virtualinherited

Creates a new CFeatures instance containing only the dimensions of the feature vector which are specified by the provided indices.

This method is needed for feature selection tasks NOT IMPLEMENTED!

Parameters
dimsindices of feature dimensions to copy
Returns
new CFeatures instance with copies of specified features

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 348 of file Features.cpp.

CFeatures * copy_subset ( SGVector< index_t >  indices)
virtual

Creates a new CFeatures instance containing copies of the elements which are specified by the provided indices. Simply creates a combined features instance where all sub-features are the results of their copy_subset calls

Parameters
indicesindices of feature elements to copy
Returns
new CFeatures instance with copies of feature data

Reimplemented from CFeatures.

Definition at line 304 of file CombinedFeatures.cpp.

CFeatures * create_merged_copy ( CFeatures *  other)
virtual

Takes another feature instance and returns a new instance which is a concatenation of a copy if this instace's data and the given instance's data. Note that the feature types have to be equal.

In this case, all sub features are merged

Parameters
otherfeature object to append
Returns
new feature object which contains copy of data of this instance and of given one

Reimplemented from CFeatures.

Definition at line 177 of file CombinedFeatures.cpp.

virtual CFeatures* create_merged_copy ( CList *  others)
virtualinherited

Takes a list of feature instances and returns a new instance being a concatenation of a copy of this instace's data and the given instancess data. Note that the feature types have to be equal.

NOT IMPLEMENTED!

Parameters
otherslist of feature objects to append
Returns
new feature object which contains copy of data of this instance and given ones

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 235 of file Features.h.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 231 of file SGObject.cpp.

void del_preprocessor ( int32_t  num)
virtualinherited

delete preprocessor from list

Parameters
numindex of preprocessor in list

Definition at line 122 of file Features.cpp.

bool delete_feature_obj ( int32_t  idx)

delete feature object at position idx

Parameters
idxthe index of the feature object to delete
Returns
if deleting was successful

Definition at line 159 of file CombinedFeatures.cpp.

CFeatures * duplicate ( ) const
virtual

duplicate feature object

Returns
feature object

Implements CFeatures.

Definition at line 39 of file CombinedFeatures.cpp.

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.

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.

int32_t get_cache_size ( ) const
inherited

get cache size

Returns
cache size

Definition at line 160 of file Features.cpp.

virtual EFeatureClass get_feature_class ( ) const
virtual

get feature class

Returns
feature class SIMPLE

Implements CFeatures.

Definition at line 68 of file CombinedFeatures.h.

bool get_feature_class_compatibility ( EFeatureClass  rhs) const
virtualinherited

Given a class in right hand side, does this class support compatible computation?

for example, is this->dot(rhs_prt) valid, where rhs_prt is the class in right hand side

Parameters
rhsthe class in right hand side
Returns
whether this class supports compatible computation

Reimplemented in CDenseSubSamplesFeatures< ST >.

Definition at line 355 of file Features.cpp.

CFeatures * get_feature_obj ( int32_t  idx)

get feature object at index idx

Parameters
idxindex of feature object
Returns
the feature object at index idx

Definition at line 49 of file CombinedFeatures.cpp.

virtual EFeatureType get_feature_type ( ) const
virtual

get feature type

Returns
feature type UNKNOWN

Implements CFeatures.

Definition at line 59 of file CombinedFeatures.h.

CFeatures * get_first_feature_obj ( )

get first feature object

Returns
first feature object

Definition at line 116 of file CombinedFeatures.cpp.

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.

CFeatures * get_last_feature_obj ( )

get last feature object

Returns
last feature object

Definition at line 121 of file CombinedFeatures.cpp.

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
object name

Implements CSGObject.

Definition at line 186 of file CombinedFeatures.h.

int32_t get_num_feature_obj ( )

get number of feature objects

Returns
number of feature objects

Definition at line 164 of file CombinedFeatures.cpp.

int32_t get_num_preprocessed ( ) const
inherited

get the number of applied preprocs

Returns
number of applied preprocessors

Definition at line 103 of file Features.cpp.

int32_t get_num_preprocessors ( ) const
inherited

get number of preprocessors

Returns
number of preprocessors

Definition at line 155 of file Features.cpp.

virtual int32_t get_num_vectors ( ) const
virtual

get number of feature vectors

Returns
number of feature vectors

Implements CFeatures.

Definition at line 77 of file CombinedFeatures.h.

CPreprocessor * get_preprocessor ( int32_t  num) const
inherited

get specified preprocessor

Parameters
numindex of preprocessor in list

Definition at line 93 of file Features.cpp.

CSubsetStack * get_subset_stack ( )
virtualinherited

returns subset stack

Returns
subset stack

Definition at line 334 of file Features.cpp.

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 has_property ( EFeatureProperty  p) const
inherited

check if features have given property

Parameters
pfeature property
Returns
if features have given property

Definition at line 295 of file Features.cpp.

bool insert_feature_obj ( CFeatures *  obj,
int32_t  idx 
)

insert feature object at index idx Important, idx must be < num_feature_obj

Parameters
objfeature object to insert
idxthe index where to insert the feature object
Returns
if inserting was successful

Definition at line 126 of file CombinedFeatures.cpp.

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 is_preprocessed ( int32_t  num) const
inherited

get whether specified preprocessor was already applied

Parameters
numindex of preprocessor in list

Definition at line 149 of file Features.cpp.

void list_feature_obj ( ) const
inherited

list feature object

Definition at line 171 of file Features.cpp.

void list_feature_objs ( )

list feature objects

Definition at line 54 of file CombinedFeatures.cpp.

void list_preprocessors ( )
inherited

print preprocessors

Definition at line 131 of file Features.cpp.

void load ( CFile *  loader)
virtualinherited

load features from file

Parameters
loaderFile object via which data shall be loaded

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, CSparseFeatures< ST >, CSparseFeatures< float64_t >, CSparseFeatures< T >, CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, and CStringFeatures< uint16_t >.

Definition at line 269 of file Features.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.

void load_serializable_pre ( )
throw (ShogunException
)
protectedvirtualinherited

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 occurs.

Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 454 of file SGObject.cpp.

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

Definition at line 295 of file SGObject.cpp.

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 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 remove_all_subsets ( )
virtual

removes all subsets Calls subset_changed_post() afterwards

Removes all subsets of all sub-features

Reimplemented from CFeatures.

Definition at line 277 of file CombinedFeatures.cpp.

void remove_subset ( )
virtual

removes that last added subset from subset stack, if existing Calls subset_changed_post() afterwards

Removes the subset from all sub-features

Reimplemented from CFeatures.

Definition at line 250 of file CombinedFeatures.cpp.

bool reshape ( int32_t  num_features,
int32_t  num_vectors 
)
virtualinherited

in case there is a feature matrix allow for reshaping

NOT IMPLEMENTED!

Parameters
num_featuresnew number of features
num_vectorsnew number of vectors
Returns
if reshaping was successful

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 165 of file Features.cpp.

void save ( CFile *  writer)
virtualinherited

save features to file

Parameters
writerFile object via which data shall be saved

Reimplemented in CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, CStringFeatures< uint16_t >, CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, CDenseFeatures< uint16_t >, CSparseFeatures< ST >, CSparseFeatures< float64_t >, and CSparseFeatures< T >.

Definition at line 276 of file Features.cpp.

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.

void save_serializable_pre ( )
throw (ShogunException
)
protectedvirtualinherited

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 occurs.

Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 464 of file SGObject.cpp.

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_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.

void set_preprocessed ( int32_t  num)
inherited

set applied flag for preprocessor

Parameters
numindex of preprocessor in list

Definition at line 143 of file Features.cpp.

void set_property ( EFeatureProperty  p)
inherited

set property

Parameters
pkernel property to set

Definition at line 300 of file Features.cpp.

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.

virtual CFeatures* shallow_subset_copy ( )
virtualinherited

Reimplemented in CDenseFeatures< ST >, CDenseFeatures< uint32_t >, CDenseFeatures< float64_t >, CDenseFeatures< T >, and CDenseFeatures< uint16_t >.

Definition at line 336 of file Features.h.

virtual void subset_changed_post ( )
virtualinherited

method may be overwritten to update things that depend on subset

Reimplemented in CStringFeatures< ST >, CStringFeatures< T >, CStringFeatures< uint8_t >, CStringFeatures< char >, and CStringFeatures< uint16_t >.

Definition at line 293 of file Features.h.

virtual bool support_compatible_class ( ) const
virtualinherited

does this class support compatible computation bewteen difference classes? for example, this->dot(rhs_prt), can rhs_prt be an instance of a difference class?

Returns
whether this class supports compatible computation

Reimplemented in CDenseSubSamplesFeatures< ST >.

Definition at line 323 of file Features.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 unset_property ( EFeatureProperty  p)
inherited

unset property

Parameters
pkernel property to unset

Definition at line 305 of file Features.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 281 of file SGObject.cpp.

Member Data Documentation

CDynamicObjectArray* feature_array
protected

feature array

Definition at line 193 of file CombinedFeatures.h.

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.

CSubsetStack* m_subset_stack
protectedinherited

subset used for index transformations

Definition at line 361 of file Features.h.

int32_t num_vec
protected

number of vectors must match between sub features

Definition at line 198 of file CombinedFeatures.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 files:
SHOGUN Machine Learning Toolbox - Documentation