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

Detailed Description

UI kernel.

Definition at line 24 of file GUIKernel.h.

Inheritance diagram for CGUIKernel:
[legend]

Public Member Functions

 CGUIKernel ()
 
 CGUIKernel (CSGInterface *interface)
 
 ~CGUIKernel ()
 
CKernel * get_kernel ()
 
bool set_normalization (char *normalization, float64_t c=0.0, float64_t r=0.0)
 
bool set_kernel (CKernel *kern)
 
bool add_kernel (CKernel *kern, float64_t weight=1)
 
bool del_last_kernel ()
 
bool init_kernel (const char *target)
 
bool init_kernel_optimization ()
 
bool delete_kernel_optimization ()
 
bool save_kernel (char *filename)
 
bool clean_kernel ()
 
bool resize_kernel_cache (int32_t size)
 
bool set_optimization_type (char *opt_type)
 
bool precompute_subkernels ()
 
bool is_initialized ()
 
CKernel * create_oligo (int32_t size, int32_t k, float64_t width)
 
CKernel * create_diag (int32_t size=10, float64_t diag=1)
 
CKernel * create_const (int32_t size=10, float64_t c=1)
 
CKernel * create_custom (float64_t *kmatrix, int32_t num_feat, int32_t num_vec, bool source_is_diag, bool dest_is_diag)
 
CKernel * create_gaussianshift (int32_t size=10, float64_t width=1, int32_t max_shift=0, int32_t shift_step=1)
 
CKernel * create_sparsegaussian (int32_t size=10, float64_t width=1)
 
CKernel * create_gaussian (int32_t size=10, float64_t width=1)
 
CKernel * create_sigmoid (int32_t size=10, float64_t gamma=0.01, float64_t coef0=0)
 
CKernel * create_tppk (int32_t size, float64_t *km, int32_t rows, int32_t cols)
 
CKernel * create_sparsepoly (int32_t size=10, int32_t degree=2, bool inhomogene=false, bool normalize=true)
 
CKernel * create_poly (int32_t size=10, int32_t degree=2, bool inhomogene=false, bool normalize=true)
 
CKernel * create_wavelet (int32_t size=10, float64_t Wdilation=5.0, float64_t Wtranslation=2.0)
 
CKernel * create_localityimprovedstring (int32_t size=10, int32_t length=3, int32_t inner_degree=3, int32_t outer_degree=1, EKernelType ktype=K_LOCALITYIMPROVED)
 
CKernel * create_weighteddegreestring (int32_t size=10, int32_t order=3, int32_t max_mismatch=1, bool use_normalization=true, int32_t mkl_stepsize=1, bool block_computation=true, int32_t single_degree=-1)
 
CKernel * create_weighteddegreepositionstring (int32_t size=10, int32_t order=3, int32_t max_mismatch=1, int32_t length=0, int32_t center=0, float64_t step=1)
 
CKernel * create_weighteddegreepositionstring3 (int32_t size=10, int32_t order=3, int32_t max_mismatch=1, int32_t *shifts=NULL, int32_t length=0, int32_t mkl_stepsize=1, float64_t *position_weights=NULL)
 
CKernel * create_weighteddegreepositionstring2 (int32_t size=10, int32_t order=3, int32_t max_mismatch=1, int32_t *shifts=NULL, int32_t length=0, bool use_normalization=true)
 
CKernel * create_weighteddegreerbf (int32_t size=10, int32_t degree=1, int32_t nof_properties=1, float64_t width=1)
 
CKernel * create_spectrummismatchrbf (int32_t size=10, float64_t *AA_matrix=NULL, int32_t nr=128, int32_t nc=128, int32_t max_mismatch=1, int32_t degree=1, float64_t width=1)
 
CKernel * create_localalignmentstring (int32_t size=10)
 
CKernel * create_fixeddegreestring (int32_t size=10, int32_t d=3)
 
CKernel * create_chi2 (int32_t size=10, float64_t width=1)
 
CKernel * create_commstring (int32_t size=10, bool use_sign=false, char *norm_str=NULL, EKernelType ktype=K_WEIGHTEDCOMMWORDSTRING)
 
CKernel * create_matchwordstring (int32_t size=10, int32_t d=3, bool normalize=true)
 
CKernel * create_polymatchstring (int32_t size=10, int32_t degree=2, bool inhomogene=false, bool normalize=true)
 
CKernel * create_polymatchwordstring (int32_t size=10, int32_t degree=2, bool inhomogene=false, bool normalize=true)
 
CKernel * create_salzbergword (int32_t size=10)
 
CKernel * create_histogramword (int32_t size=10)
 
CKernel * create_linearbyte (int32_t size=10, float64_t scale=-1)
 
CKernel * create_linearword (int32_t size=10, float64_t scale=-1)
 
CKernel * create_linearstring (int32_t size=10, float64_t scale=-1)
 
CKernel * create_linear (int32_t size=10, float64_t scale=-1)
 
CKernel * create_sparselinear (int32_t size=10, float64_t scale=-1)
 
CKernel * create_distance (int32_t size=10, float64_t width=1)
 
CKernel * create_combined (int32_t size=10, bool append_subkernel_weights=false)
 
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

CKernel * kernel
 
CSGInterface * ui
 
bool initialized
 

Constructor & Destructor Documentation

CGUIKernel ( )

constructor

Definition at line 28 of file GUIKernel.h.

CGUIKernel ( CSGInterface *  interface)

constructor

Parameters
interface

Definition at line 65 of file GUIKernel.cpp.

~CGUIKernel ( )

destructor

Definition at line 71 of file GUIKernel.cpp.

Member Function Documentation

bool add_kernel ( CKernel *  kern,
float64_t  weight = 1 
)

add kernel to a Combined kernel, creating one if necessary

Definition at line 861 of file GUIKernel.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_kernel ( )

clean/r kernel

Definition at line 914 of file GUIKernel.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.

CKernel * create_chi2 ( int32_t  size = 10,
float64_t  width = 1 
)

create a new Chi2 kernel

Definition at line 426 of file GUIKernel.cpp.

CKernel * create_combined ( int32_t  size = 10,
bool  append_subkernel_weights = false 
)

create a new Combined kernel

Definition at line 627 of file GUIKernel.cpp.

CKernel * create_commstring ( int32_t  size = 10,
bool  use_sign = false,
char *  norm_str = NULL,
EKernelType  ktype = K_WEIGHTEDCOMMWORDSTRING 
)

create a new WeightedCommWord/CommWord/CommULongString kernel

Definition at line 437 of file GUIKernel.cpp.

CKernel * create_const ( int32_t  size = 10,
float64_t  c = 1 
)

create a new Const kernel

Definition at line 100 of file GUIKernel.cpp.

CKernel * create_custom ( float64_t *  kmatrix,
int32_t  num_feat,
int32_t  num_vec,
bool  source_is_diag,
bool  dest_is_diag 
)

create a new Custom kernel

Definition at line 113 of file GUIKernel.cpp.

CKernel * create_diag ( int32_t  size = 10,
float64_t  diag = 1 
)

create a new Diag kernel

Definition at line 89 of file GUIKernel.cpp.

CKernel * create_distance ( int32_t  size = 10,
float64_t  width = 1 
)

create a new Distance kernel

Definition at line 612 of file GUIKernel.cpp.

CKernel * create_fixeddegreestring ( int32_t  size = 10,
int32_t  d = 3 
)

create a new FixedDegreeString kernel

Definition at line 415 of file GUIKernel.cpp.

CKernel * create_gaussian ( int32_t  size = 10,
float64_t  width = 1 
)

create a new Gaussian kernel

Definition at line 157 of file GUIKernel.cpp.

CKernel * create_gaussianshift ( int32_t  size = 10,
float64_t  width = 1,
int32_t  max_shift = 0,
int32_t  shift_step = 1 
)

create a new GaussianShift kernel

Definition at line 134 of file GUIKernel.cpp.

CKernel * create_histogramword ( int32_t  size = 10)

create a new HistogramWord kernel

Definition at line 530 of file GUIKernel.cpp.

CKernel * create_linear ( int32_t  size = 10,
float64_t  scale = -1 
)

create a new Linear kernel

Definition at line 578 of file GUIKernel.cpp.

CKernel * create_linearbyte ( int32_t  size = 10,
float64_t  scale = -1 
)

create a new LinearByte kernel

Definition at line 546 of file GUIKernel.cpp.

CKernel * create_linearstring ( int32_t  size = 10,
float64_t  scale = -1 
)

create a new LinearString kernel

Definition at line 566 of file GUIKernel.cpp.

CKernel * create_linearword ( int32_t  size = 10,
float64_t  scale = -1 
)

create a new LinearWord kernel

Definition at line 556 of file GUIKernel.cpp.

CKernel * create_localalignmentstring ( int32_t  size = 10)

create a new LocalAlignmentString kernel

Definition at line 404 of file GUIKernel.cpp.

CKernel * create_localityimprovedstring ( int32_t  size = 10,
int32_t  length = 3,
int32_t  inner_degree = 3,
int32_t  outer_degree = 1,
EKernelType  ktype = K_LOCALITYIMPROVED 
)

create a new (Simple)LocalityImprovedString kernel

Definition at line 212 of file GUIKernel.cpp.

CKernel * create_matchwordstring ( int32_t  size = 10,
int32_t  d = 3,
bool  normalize = true 
)

create a new MatchWordString kernel

Definition at line 469 of file GUIKernel.cpp.

CKernel * create_oligo ( int32_t  size,
int32_t  k,
float64_t  width 
)

create Oligo kernel

Definition at line 81 of file GUIKernel.cpp.

CKernel * create_poly ( int32_t  size = 10,
int32_t  degree = 2,
bool  inhomogene = false,
bool  normalize = true 
)

create a new Poly kernel

Definition at line 201 of file GUIKernel.cpp.

CKernel * create_polymatchstring ( int32_t  size = 10,
int32_t  degree = 2,
bool  inhomogene = false,
bool  normalize = true 
)

create a new PolyMatchString kernel

Definition at line 480 of file GUIKernel.cpp.

CKernel * create_polymatchwordstring ( int32_t  size = 10,
int32_t  degree = 2,
bool  inhomogene = false,
bool  normalize = true 
)

create a new PolyMatchWordString kernel

Definition at line 491 of file GUIKernel.cpp.

CKernel * create_salzbergword ( int32_t  size = 10)

create a new SalzbergWord kernel

Definition at line 502 of file GUIKernel.cpp.

CKernel * create_sigmoid ( int32_t  size = 10,
float64_t  gamma = 0.01,
float64_t  coef0 = 0 
)

create a new Sigmoid kernel

Definition at line 168 of file GUIKernel.cpp.

CKernel * create_sparsegaussian ( int32_t  size = 10,
float64_t  width = 1 
)

create a new SparseGaussian kernel

Definition at line 146 of file GUIKernel.cpp.

CKernel * create_sparselinear ( int32_t  size = 10,
float64_t  scale = -1 
)

create a new SparseLinear kernel

Definition at line 589 of file GUIKernel.cpp.

CKernel * create_sparsepoly ( int32_t  size = 10,
int32_t  degree = 2,
bool  inhomogene = false,
bool  normalize = true 
)

create a new SparsePoly kernel

Definition at line 190 of file GUIKernel.cpp.

CKernel * create_spectrummismatchrbf ( int32_t  size = 10,
float64_t *  AA_matrix = NULL,
int32_t  nr = 128,
int32_t  nc = 128,
int32_t  max_mismatch = 1,
int32_t  degree = 1,
float64_t  width = 1 
)

create a new SpectrumMismatchRBF kernel

Definition at line 390 of file GUIKernel.cpp.

CKernel * create_tppk ( int32_t  size,
float64_t *  km,
int32_t  rows,
int32_t  cols 
)

create a new TPP kernel

Definition at line 600 of file GUIKernel.cpp.

CKernel * create_wavelet ( int32_t  size = 10,
float64_t  Wdilation = 5.0,
float64_t  Wtranslation = 2.0 
)

create new Wavelet kernel

Definition at line 179 of file GUIKernel.cpp.

CKernel * create_weighteddegreepositionstring ( int32_t  size = 10,
int32_t  order = 3,
int32_t  max_mismatch = 1,
int32_t  length = 0,
int32_t  center = 0,
float64_t  step = 1 
)

create a new WeightedDegreePositionString kernel

Definition at line 276 of file GUIKernel.cpp.

CKernel * create_weighteddegreepositionstring2 ( int32_t  size = 10,
int32_t  order = 3,
int32_t  max_mismatch = 1,
int32_t *  shifts = NULL,
int32_t  length = 0,
bool  use_normalization = true 
)

create a new WeightedDegreePositionString2

Definition at line 332 of file GUIKernel.cpp.

CKernel * create_weighteddegreepositionstring3 ( int32_t  size = 10,
int32_t  order = 3,
int32_t  max_mismatch = 1,
int32_t *  shifts = NULL,
int32_t  length = 0,
int32_t  mkl_stepsize = 1,
float64_t *  position_weights = NULL 
)

create a new WeightedDegreePositionString3

Definition at line 309 of file GUIKernel.cpp.

CKernel * create_weighteddegreerbf ( int32_t  size = 10,
int32_t  degree = 1,
int32_t  nof_properties = 1,
float64_t  width = 1 
)

create a new WeightedDegreeRBF kernel

Definition at line 379 of file GUIKernel.cpp.

CKernel * create_weighteddegreestring ( int32_t  size = 10,
int32_t  order = 3,
int32_t  max_mismatch = 1,
bool  use_normalization = true,
int32_t  mkl_stepsize = 1,
bool  block_computation = true,
int32_t  single_degree = -1 
)

create a new WeightedDegreeString kernel

Definition at line 237 of file GUIKernel.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_kernel ( )

delete last kernel in combined kernel

Definition at line 897 of file GUIKernel.cpp.

bool delete_kernel_optimization ( )

delete kernel optimization

Definition at line 748 of file GUIKernel.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.

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.

CKernel * get_kernel ( )

get active kernel

Definition at line 76 of file GUIKernel.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 172 of file GUIKernel.h.

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

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

Parameters
namename of the parameter
Returns
true if the parameter exists with the input name

Definition at line 289 of file SGObject.h.

bool has ( const Tag< T > &  tag) const
inherited

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

Parameters
tagtag of the parameter containing name and type information
Returns
true if the parameter exists with the input tag

Definition at line 301 of file SGObject.h.

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

Checks if a type exists for a class parameter identified by a name.

Parameters
namename of the parameter
Returns
true if the parameter exists with the input name and type

Definition at line 312 of file SGObject.h.

bool init_kernel ( const char *  target)

initialize kernel

Definition at line 757 of file GUIKernel.cpp.

bool init_kernel_optimization ( )

initialize kernel optimization

Definition at line 715 of file GUIKernel.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_initialized ( )

check if kernel is initialized

Definition at line 68 of file GUIKernel.h.

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.

bool precompute_subkernels ( )

precompute subkernels

Definition at line 960 of file GUIKernel.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 resize_kernel_cache ( int32_t  size)

resize kernel cache

Definition at line 922 of file GUIKernel.cpp.

bool save_kernel ( char *  filename)

save kernel (matrix) to file

Definition at line 837 of file GUIKernel.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.

bool set_kernel ( CKernel *  kern)

set active kernel

Definition at line 699 of file GUIKernel.cpp.

bool set_normalization ( char *  normalization,
float64_t  c = 0.0,
float64_t  r = 0.0 
)

set normalization

Definition at line 639 of file GUIKernel.cpp.

bool set_optimization_type ( char *  opt_type)

set optimization type

Definition at line 932 of file GUIKernel.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.

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

bool initialized
protected

initialized

Definition at line 180 of file GUIKernel.h.

SGIO* io
inherited

io

Definition at line 537 of file SGObject.h.

CKernel* kernel
protected

kernel

Definition at line 176 of file GUIKernel.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.

CSGInterface* ui
protected

ui

Definition at line 178 of file GUIKernel.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