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
CGUIFeatures Class Reference

Detailed Description

UI features.

Definition at line 36 of file GUIFeatures.h.

Inheritance diagram for CGUIFeatures:
[legend]

Public Member Functions

 CGUIFeatures ()
 
 CGUIFeatures (CSGInterface *interface)
 
 ~CGUIFeatures ()
 
CFeatures * get_train_features ()
 
CFeatures * get_test_features ()
 
bool set_train_features (CFeatures *f)
 
bool set_test_features (CFeatures *f)
 
void add_train_features (CFeatures *f)
 
void add_test_features (CFeatures *f)
 
void add_train_dotfeatures (CDotFeatures *f)
 
void add_test_dotfeatures (CDotFeatures *f)
 
bool del_last_feature_obj (char *target)
 
void invalidate_train ()
 
void invalidate_test ()
 
bool load (char *filename, char *fclass, char *type, char *target, int32_t size, int32_t comp_features)
 
bool save (char *filename, char *type, char *target)
 
bool clean (char *target)
 
bool reshape (char *target, int32_t num_feat, int32_t num_vec)
 
CFeatures * get_convert_features (char *target)
 
bool set_convert_features (CFeatures *features, char *target)
 
CSparseFeatures< float64_t > * convert_simple_real_to_sparse_real (CDenseFeatures< float64_t > *src)
 
CStringFeatures< char > * convert_simple_char_to_string_char (CDenseFeatures< char > *src)
 
CDenseFeatures< float64_t > * convert_simple_char_to_simple_align (CDenseFeatures< char > *src, float64_t gap_cost=0)
 
CDenseFeatures< float64_t > * convert_simple_word_to_simple_salzberg (CDenseFeatures< uint16_t > *src)
 
CTOPFeatures * convert_string_word_to_simple_top (CStringFeatures< uint16_t > *src)
 
CFKFeatures * convert_string_word_to_simple_fk (CStringFeatures< uint16_t > *src)
 
CDenseFeatures< float64_t > * convert_sparse_real_to_simple_real (CSparseFeatures< float64_t > *src)
 
CExplicitSpecFeatures * convert_string_byte_to_spec_word (CStringFeatures< uint16_t > *src, bool use_norm)
 
template<class CT , class ST >
CStringFeatures< ST > * convert_string_char_to_string_generic (CStringFeatures< CT > *src, int32_t order=1, int32_t start=0, int32_t gap=0, char rev='f', CAlphabet *alpha=NULL)
 
bool set_reference_features (char *target)
 
virtual const char * get_name () const
 
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

CSGInterface * ui
 
CFeatures * train_features
 
CFeatures * test_features
 
CFeatures * ref_features
 

Constructor & Destructor Documentation

CGUIFeatures ( )

constructor

Definition at line 47 of file GUIFeatures.h.

CGUIFeatures ( CSGInterface *  interface)

constructor

Parameters
interface

Definition at line 21 of file GUIFeatures.cpp.

~CGUIFeatures ( )

destructor

Definition at line 27 of file GUIFeatures.cpp.

Member Function Documentation

void add_test_dotfeatures ( CDotFeatures *  f)

add test dotfeatures

Parameters
f

Definition at line 613 of file GUIFeatures.cpp.

void add_test_features ( CFeatures *  f)

add test features

Parameters
f

Definition at line 644 of file GUIFeatures.cpp.

void add_train_dotfeatures ( CDotFeatures *  f)

add train dotfeatures

Parameters
f

Definition at line 581 of file GUIFeatures.cpp.

void add_train_features ( CFeatures *  f)

add train features

Parameters
f

Definition at line 553 of file GUIFeatures.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 clean ( char *  target)

clean/r features

Definition at line 204 of file GUIFeatures.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.

CDenseFeatures< float64_t > * convert_simple_char_to_simple_align ( CDenseFeatures< char > *  src,
float64_t  gap_cost = 0 
)

convert simple char to simple align

Parameters
src
gap_cost

Definition at line 504 of file GUIFeatures.cpp.

CStringFeatures< char > * convert_simple_char_to_string_char ( CDenseFeatures< char > *  src)

converst simple char to string char

Parameters
src

Definition at line 320 of file GUIFeatures.cpp.

CSparseFeatures< float64_t > * convert_simple_real_to_sparse_real ( CDenseFeatures< float64_t > *  src)

convert features from one class/type to another

Parameters
src

Definition at line 298 of file GUIFeatures.cpp.

CDenseFeatures< float64_t > * convert_simple_word_to_simple_salzberg ( CDenseFeatures< uint16_t > *  src)

convert simple word to simple salzberg

Parameters
src

Definition at line 362 of file GUIFeatures.cpp.

CDenseFeatures< float64_t > * convert_sparse_real_to_simple_real ( CSparseFeatures< float64_t > *  src)

convert sparse real to simple real

Parameters
src

Definition at line 475 of file GUIFeatures.cpp.

CExplicitSpecFeatures * convert_string_byte_to_spec_word ( CStringFeatures< uint16_t > *  src,
bool  use_norm 
)

convert string byte to spec word

Parameters
src
use_norm

Definition at line 498 of file GUIFeatures.cpp.

CStringFeatures<ST>* convert_string_char_to_string_generic ( CStringFeatures< CT > *  src,
int32_t  order = 1,
int32_t  start = 0,
int32_t  gap = 0,
char  rev = 'f',
CAlphabet *  alpha = NULL 
)

convert string char to string generic

Parameters
src
order
start
gap
rev
alpha

Definition at line 179 of file GUIFeatures.h.

CFKFeatures * convert_string_word_to_simple_fk ( CStringFeatures< uint16_t > *  src)

convert string word to simple fk

Parameters
src

Definition at line 437 of file GUIFeatures.cpp.

CTOPFeatures * convert_string_word_to_simple_top ( CStringFeatures< uint16_t > *  src)

convert string word to simple top

Parameters
src

Definition at line 404 of file GUIFeatures.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 del_last_feature_obj ( char *  target)

delete last feature obj from combined features

Definition at line 672 of file GUIFeatures.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.

CFeatures * get_convert_features ( char *  target)

get features for target to convert

Definition at line 249 of file GUIFeatures.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.

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 224 of file GUIFeatures.h.

CFeatures* get_test_features ( )

get test features

Definition at line 58 of file GUIFeatures.h.

CFeatures* get_train_features ( )

get train features

Definition at line 56 of file GUIFeatures.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.

void invalidate_test ( )

invalidate test

Definition at line 41 of file GUIFeatures.cpp.

void invalidate_train ( )

invalidate train

Definition at line 34 of file GUIFeatures.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 load ( char *  filename,
char *  fclass,
char *  type,
char *  target,
int32_t  size,
int32_t  comp_features 
)

load features from file

FIXME make CHAR type configurable... it is DNA by default

FIXME make CHAR type configurable... it is DNA by default

FIXME make CHAR type configurable... it is DNA by default

FIXME make CHAR type configurable... it is DNA by default

Definition at line 48 of file GUIFeatures.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.

bool reshape ( char *  target,
int32_t  num_feat,
int32_t  num_vec 
)

reshape target feature matrix

Definition at line 216 of file GUIFeatures.cpp.

bool save ( char *  filename,
char *  type,
char *  target 
)

save features to file

Definition at line 141 of file GUIFeatures.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.

bool set_convert_features ( CFeatures *  features,
char *  target 
)

set convert(ed) features for target

Definition at line 266 of file GUIFeatures.cpp.

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.

bool set_reference_features ( char *  target)

set reference features from target

Definition at line 531 of file GUIFeatures.cpp.

bool set_test_features ( CFeatures *  f)

set test features

Parameters
f

Definition at line 75 of file GUIFeatures.h.

bool set_train_features ( CFeatures *  f)

set train features

Parameters
f

Definition at line 63 of file GUIFeatures.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 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.

CFeatures* ref_features
protected

ref features

Definition at line 234 of file GUIFeatures.h.

CFeatures* test_features
protected

test features

Definition at line 232 of file GUIFeatures.h.

CFeatures* train_features
protected

train features

Definition at line 230 of file GUIFeatures.h.

CSGInterface* ui
protected

ui

Definition at line 228 of file GUIFeatures.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