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

Detailed Description

UI structure.

Definition at line 28 of file GUIStructure.h.

Inheritance diagram for CGUIStructure:
[legend]

Public Member Functions

 CGUIStructure ()
 
 CGUIStructure (CSGInterface *interface)
 
 ~CGUIStructure ()
 
bool set_dyn_prog (CDynProg *h)
 
CDynProgget_dyn_prog ()
 
float64_tget_feature_matrix (bool copy)
 
CSparseFeatures< float64_t > * get_feature_matrix_sparse (int32_t index)
 
bool set_feature_matrix (float64_t *feat, int32_t *dims)
 
bool set_feature_matrix_sparse (SGSparseVector< float64_t > *f1, SGSparseVector< float64_t > *f2, int32_t *dims)
 
bool set_feature_dims (int32_t *dims)
 
int32_t * get_feature_dims ()
 
bool set_all_pos (int32_t *pos, int32_t Npos)
 
int32_t * get_all_positions ()
 
int32_t get_num_positions ()
 
bool set_content_svm_weights (float64_t *weights, int32_t Nweights, int32_t Mweights)
 
float64_tget_content_svm_weights ()
 
int32_t get_num_svm_weights ()
 
CPlifMatrixget_plif_matrix ()
 
bool set_orf_info (int32_t *orf_info, int32_t Norf_info, int32_t Morf_info)
 
int32_t * get_orf_info ()
 
bool set_use_orf (bool use_orf)
 
bool get_use_orf ()
 
bool set_mod_words (int32_t *mod_words, int32_t Nmod_words, int32_t Mmod_words)
 
int32_t * get_mod_words ()
 
int32_t get_num_states ()
 
bool set_num_states (int32_t num)
 
bool cleanup ()
 
virtual const char * get_name () const
 
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)
 
virtual void update_parameter_hash ()
 
virtual bool parameter_hash_changed ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)
 
virtual CSGObjectclone ()
 

Public Attributes

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_gradient_parameters
 
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)
 

Protected Attributes

CSGInterface * ui
 
int32_t m_num_plifs
 
int32_t m_num_limits
 
int32_t m_num_states
 
CDynProgm_dp
 
float64_tm_feature_matrix
 
CSparseFeatures< float64_t > * m_feature_matrix_sparse1
 
CSparseFeatures< float64_t > * m_feature_matrix_sparse2
 
int32_t * m_feature_dims
 
int32_t m_num_positions
 
int32_t * m_all_positions
 
float64_tm_content_svm_weights
 
int32_t m_num_svm_weights
 
int32_t * m_orf_info
 
bool m_use_orf
 
int32_t * m_mod_words
 
CPlifMatrixm_plif_matrix
 

Constructor & Destructor Documentation

constructor

Definition at line 32 of file GUIStructure.h.

CGUIStructure ( CSGInterface *  interface)

constructor

Parameters
interface

Definition at line 20 of file GUIStructure.cpp.

destructor

Definition at line 31 of file GUIStructure.cpp.

Member Function Documentation

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

bool cleanup ( )

cleanup

Definition at line 234 of file GUIStructure.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 714 of file SGObject.cpp.

CSGObject * deep_copy ( ) const
virtualinherited

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

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

int32_t* get_all_positions ( )

get all positions

Definition at line 144 of file GUIStructure.h.

float64_t* get_content_svm_weights ( )

get content svm weights

Definition at line 166 of file GUIStructure.h.

CDynProg* get_dyn_prog ( )

get dyn prog

Definition at line 51 of file GUIStructure.h.

int32_t* get_feature_dims ( )

get feature dims

Definition at line 127 of file GUIStructure.h.

float64_t* get_feature_matrix ( bool  copy)

get feature matrix

Parameters
copy

Definition at line 61 of file GUIStructure.h.

CSparseFeatures<float64_t>* get_feature_matrix_sparse ( int32_t  index)

get feature matrix sparse

Parameters
index

Definition at line 77 of file GUIStructure.h.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 235 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 277 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 290 of file SGObject.cpp.

int32_t* get_mod_words ( )

get mod words

Definition at line 222 of file GUIStructure.h.

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

Definition at line 498 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 522 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 535 of file SGObject.cpp.

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

Implements CSGObject.

Definition at line 251 of file GUIStructure.h.

int32_t get_num_positions ( )

get num positions

Definition at line 146 of file GUIStructure.h.

int32_t get_num_states ( )

get num states

Definition at line 224 of file GUIStructure.h.

int32_t get_num_svm_weights ( )

get num svm weights

Definition at line 168 of file GUIStructure.h.

int32_t* get_orf_info ( )

get orf info

Definition at line 190 of file GUIStructure.h.

CPlifMatrix* get_plif_matrix ( )

get plif matrix

Definition at line 171 of file GUIStructure.h.

bool get_use_orf ( )

get use orf

Definition at line 204 of file GUIStructure.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 296 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 369 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 426 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 421 of file SGObject.cpp.

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

Definition at line 262 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 474 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 308 of file SGObject.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 314 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 436 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 431 of file SGObject.cpp.

bool set_all_pos ( int32_t *  pos,
int32_t  Npos 
)

set all pos

Parameters
pos
Npos

Definition at line 133 of file GUIStructure.h.

bool set_content_svm_weights ( float64_t weights,
int32_t  Nweights,
int32_t  Mweights 
)

set content svm weights

Parameters
weights
Nweights
Mweights

Definition at line 153 of file GUIStructure.h.

bool set_dyn_prog ( CDynProg h)

set dyn prog

Parameters
h

Definition at line 43 of file GUIStructure.h.

bool set_feature_dims ( int32_t *  dims)

set feature dims

Parameters
dims

Definition at line 119 of file GUIStructure.h.

bool set_feature_matrix ( float64_t feat,
int32_t *  dims 
)

set feature matrix

Parameters
feat
dims

Definition at line 91 of file GUIStructure.h.

bool set_feature_matrix_sparse ( SGSparseVector< float64_t > *  f1,
SGSparseVector< float64_t > *  f2,
int32_t *  dims 
)

set feature matrix sparse

Parameters
f1
f2
dims

Definition at line 105 of file GUIStructure.h.

void set_generic ( )
inherited

Definition at line 41 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 46 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 51 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 56 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 61 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 66 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 71 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 76 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 81 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 86 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 91 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 96 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 101 of file SGObject.cpp.

void set_generic ( )
inherited

Definition at line 106 of file SGObject.cpp.

void set_generic ( )
inherited

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

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 241 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 283 of file SGObject.cpp.

bool set_mod_words ( int32_t *  mod_words,
int32_t  Nmod_words,
int32_t  Mmod_words 
)

set mod words

Parameters
mod_words
Nmod_words
Mmod_words

Definition at line 211 of file GUIStructure.h.

bool set_num_states ( int32_t  num)

set num states

Parameters
num

Definition at line 228 of file GUIStructure.h.

bool set_orf_info ( int32_t *  orf_info,
int32_t  Norf_info,
int32_t  Morf_info 
)

set orf info

Parameters
orf_info
Norf_info
Morf_info

Definition at line 178 of file GUIStructure.h.

bool set_use_orf ( bool  use_orf)

set use orf

Parameters
use_orf

Definition at line 198 of file GUIStructure.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 192 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 303 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 248 of file SGObject.cpp.

Member Data Documentation

SGIO* io
inherited

io

Definition at line 369 of file SGObject.h.

int32_t* m_all_positions
protected

all positions

Definition at line 275 of file GUIStructure.h.

float64_t* m_content_svm_weights
protected

content svm weights

Definition at line 277 of file GUIStructure.h.

CDynProg* m_dp
protected

dp

Definition at line 263 of file GUIStructure.h.

int32_t* m_feature_dims
protected

feature dims

Definition at line 271 of file GUIStructure.h.

float64_t* m_feature_matrix
protected

feature matrix

Definition at line 265 of file GUIStructure.h.

CSparseFeatures<float64_t>* m_feature_matrix_sparse1
protected

feature matrix sparse 1

Definition at line 267 of file GUIStructure.h.

CSparseFeatures<float64_t>* m_feature_matrix_sparse2
protected

feature matrix sparse 2

Definition at line 269 of file GUIStructure.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 384 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 387 of file SGObject.h.

int32_t* m_mod_words
protected

mod words

Definition at line 285 of file GUIStructure.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 381 of file SGObject.h.

int32_t m_num_limits
protected

num limits

Definition at line 259 of file GUIStructure.h.

int32_t m_num_plifs
protected

num plifs

Definition at line 257 of file GUIStructure.h.

int32_t m_num_positions
protected

num positions

Definition at line 273 of file GUIStructure.h.

int32_t m_num_states
protected

num states

Definition at line 261 of file GUIStructure.h.

int32_t m_num_svm_weights
protected

num svm weights

Definition at line 279 of file GUIStructure.h.

int32_t* m_orf_info
protected

orf info

Definition at line 281 of file GUIStructure.h.

Parameter* m_parameters
inherited

parameters

Definition at line 378 of file SGObject.h.

CPlifMatrix* m_plif_matrix
protected

plif matrix

Definition at line 287 of file GUIStructure.h.

bool m_use_orf
protected

use orf

Definition at line 283 of file GUIStructure.h.

Parallel* parallel
inherited

parallel

Definition at line 372 of file SGObject.h.

CSGInterface* ui
protected

ui

Definition at line 255 of file GUIStructure.h.

Version* version
inherited

version

Definition at line 375 of file SGObject.h.


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

SHOGUN Machine Learning Toolbox - Documentation