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

Detailed Description

The MultitaskKernel allows learning a piece-wise linear function (PLIF) via MKL.

Definition at line 27 of file MultitaskKernelPlifNormalizer.h.

Inheritance diagram for CMultitaskKernelPlifNormalizer:
[legend]

Public Member Functions

 CMultitaskKernelPlifNormalizer ()
 
 CMultitaskKernelPlifNormalizer (std::vector< float64_t > support_, std::vector< int32_t > task_vector)
 
virtual float64_t normalize (float64_t value, int32_t idx_lhs, int32_t idx_rhs)
 
int32_t get_num_unique_tasks (std::vector< int32_t > vec)
 
virtual ~CMultitaskKernelPlifNormalizer ()
 
void update_cache ()
 
float64_t compute_task_similarity (int32_t task_a, int32_t task_b)
 
virtual std::vector< int32_t > get_task_vector_lhs () const
 
virtual void set_task_vector_lhs (std::vector< int32_t > vec)
 
virtual std::vector< int32_t > get_task_vector_rhs () const
 
virtual void set_task_vector_rhs (std::vector< int32_t > vec)
 
virtual void set_task_vector (std::vector< int32_t > vec)
 
float64_t get_task_distance (int32_t task_lhs, int32_t task_rhs)
 
void set_task_distance (int32_t task_lhs, int32_t task_rhs, float64_t distance)
 
float64_t get_task_similarity (int32_t task_lhs, int32_t task_rhs)
 
void set_task_similarity (int32_t task_lhs, int32_t task_rhs, float64_t similarity)
 
float64_t get_beta (int32_t idx)
 
void set_beta (int32_t idx, float64_t weight)
 
int32_t get_num_betas ()
 
virtual const char * get_name () const
 
CMultitaskKernelPlifNormalizerKernelNormalizerToMultitaskKernelPlifNormalizer (CKernelNormalizer *n)
 
virtual bool init (CKernel *k)
 
virtual float64_t normalize_lhs (float64_t value, int32_t idx_lhs)
 
virtual float64_t normalize_rhs (float64_t value, int32_t idx_rhs)
 
ENormalizerType get_normalizer_type ()
 
void set_normalizer_type (ENormalizerType type)
 
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 register_params ()
 
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

int32_t num_tasks
 
int32_t num_tasksqr
 
std::vector< int32_t > task_vector_lhs
 
std::vector< int32_t > task_vector_rhs
 
std::vector< float64_tdistance_matrix
 
std::vector< float64_tsimilarity_matrix
 
int32_t num_betas
 
std::vector< float64_tbetas
 
std::vector< float64_tsupport
 
float64_t scale
 
ENormalizerType m_type
 

Constructor & Destructor Documentation

default constructor

Definition at line 32 of file MultitaskKernelPlifNormalizer.h.

CMultitaskKernelPlifNormalizer ( std::vector< float64_t support_,
std::vector< int32_t >  task_vector 
)

constructor

Definition at line 41 of file MultitaskKernelPlifNormalizer.h.

virtual ~CMultitaskKernelPlifNormalizer ( )
virtual

default destructor

Definition at line 118 of file MultitaskKernelPlifNormalizer.h.

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.

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.

float64_t compute_task_similarity ( int32_t  task_a,
int32_t  task_b 
)

derive similarity from distance with plif

Definition at line 143 of file MultitaskKernelPlifNormalizer.h.

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.

float64_t get_beta ( int32_t  idx)
virtual
Parameters
idxindex of MKL weight to get

Implements CMultitaskKernelMklNormalizer.

Definition at line 283 of file MultitaskKernelPlifNormalizer.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.

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

Reimplemented from CMultitaskKernelMklNormalizer.

Definition at line 315 of file MultitaskKernelPlifNormalizer.h.

ENormalizerType get_normalizer_type ( )
inherited

getter for normalizer type

Definition at line 102 of file KernelNormalizer.h.

int32_t get_num_betas ( )
virtual
Returns
number of kernel weights (support points)

Implements CMultitaskKernelMklNormalizer.

Definition at line 306 of file MultitaskKernelPlifNormalizer.h.

int32_t get_num_unique_tasks ( std::vector< int32_t >  vec)

helper routine

Parameters
vecvector with containing task_id for each example
Returns
number of unique task ids

Definition at line 101 of file MultitaskKernelPlifNormalizer.h.

float64_t get_task_distance ( int32_t  task_lhs,
int32_t  task_rhs 
)
Parameters
task_lhstask_id on left hand side
task_rhstask_id on right hand side
Returns
distance between tasks

Definition at line 223 of file MultitaskKernelPlifNormalizer.h.

float64_t get_task_similarity ( int32_t  task_lhs,
int32_t  task_rhs 
)
Parameters
task_lhstask_id on left hand side
task_rhstask_id on right hand side
Returns
similarity between tasks

Definition at line 254 of file MultitaskKernelPlifNormalizer.h.

virtual std::vector<int32_t> get_task_vector_lhs ( ) const
virtual
Returns
vec task vector with containing task_id for each example on left hand side

Definition at line 188 of file MultitaskKernelPlifNormalizer.h.

virtual std::vector<int32_t> get_task_vector_rhs ( ) const
virtual
Returns
vec task vector with containing task_id for each example on right hand side

Definition at line 200 of file MultitaskKernelPlifNormalizer.h.

virtual bool init ( CKernel k)
virtualinherited

initialization of the normalizer

Parameters
kkernel

Implements CKernelNormalizer.

Definition at line 43 of file MultitaskKernelMklNormalizer.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.

CMultitaskKernelPlifNormalizer* KernelNormalizerToMultitaskKernelPlifNormalizer ( CKernelNormalizer n)

casts kernel normalizer to multitask kernel plif normalizer

Parameters
nkernel normalizer to cast

Definition at line 323 of file MultitaskKernelPlifNormalizer.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 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.

virtual float64_t normalize ( float64_t  value,
int32_t  idx_lhs,
int32_t  idx_rhs 
)
virtual

normalize the kernel value

Parameters
valuekernel value
idx_lhsindex of left hand side vector
idx_rhsindex of right hand side vector

Implements CKernelNormalizer.

Definition at line 76 of file MultitaskKernelPlifNormalizer.h.

virtual float64_t normalize_lhs ( float64_t  value,
int32_t  idx_lhs 
)
virtualinherited

normalize only the left hand side vector

Parameters
valuevalue of a component of the left hand side feature vector
idx_lhsindex of left hand side vector

Implements CKernelNormalizer.

Reimplemented in CMultitaskKernelTreeNormalizer.

Definition at line 80 of file MultitaskKernelMklNormalizer.h.

virtual float64_t normalize_rhs ( float64_t  value,
int32_t  idx_rhs 
)
virtualinherited

normalize only the right hand side vector

Parameters
valuevalue of a component of the right hand side feature vector
idx_rhsindex of right hand side vector

Implements CKernelNormalizer.

Reimplemented in CMultitaskKernelTreeNormalizer.

Definition at line 90 of file MultitaskKernelMklNormalizer.h.

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.

virtual void register_params ( )
protectedvirtual

register the parameters

Reimplemented from CKernelNormalizer.

Definition at line 331 of file MultitaskKernelPlifNormalizer.h.

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.

void set_beta ( int32_t  idx,
float64_t  weight 
)
virtual
Parameters
idxindex of MKL weight to set
weightMKL weight to set

Implements CMultitaskKernelMklNormalizer.

Definition at line 294 of file MultitaskKernelPlifNormalizer.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.

void set_normalizer_type ( ENormalizerType  type)
inherited

setter for normalizer type

Parameters
typetype of normalizer

Definition at line 110 of file KernelNormalizer.h.

void set_task_distance ( int32_t  task_lhs,
int32_t  task_rhs,
float64_t  distance 
)
Parameters
task_lhstask_id on left hand side
task_rhstask_id on right hand side
distancedistance between tasks

Definition at line 238 of file MultitaskKernelPlifNormalizer.h.

void set_task_similarity ( int32_t  task_lhs,
int32_t  task_rhs,
float64_t  similarity 
)
Parameters
task_lhstask_id on left hand side
task_rhstask_id on right hand side
similaritysimilarity between tasks

Definition at line 269 of file MultitaskKernelPlifNormalizer.h.

virtual void set_task_vector ( std::vector< int32_t >  vec)
virtual
Parameters
vectask vector with containing task_id for each example

Definition at line 212 of file MultitaskKernelPlifNormalizer.h.

virtual void set_task_vector_lhs ( std::vector< int32_t >  vec)
virtual
Parameters
vectask vector with containing task_id for each example

Definition at line 194 of file MultitaskKernelPlifNormalizer.h.

virtual void set_task_vector_rhs ( std::vector< int32_t >  vec)
virtual
Parameters
vectask vector with containing task_id for each example

Definition at line 206 of file MultitaskKernelPlifNormalizer.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_cache ( )

update cache

Definition at line 124 of file MultitaskKernelPlifNormalizer.h.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 248 of file SGObject.cpp.

Member Data Documentation

std::vector<float64_t> betas
protected

weights

Definition at line 362 of file MultitaskKernelPlifNormalizer.h.

std::vector<float64_t> distance_matrix
protected

MxM matrix encoding distance between tasks

Definition at line 353 of file MultitaskKernelPlifNormalizer.h.

SGIO* io
inherited

io

Definition at line 369 of file SGObject.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.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 381 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 378 of file SGObject.h.

ENormalizerType m_type
protectedinherited

normalizer type

Definition at line 117 of file KernelNormalizer.h.

int32_t num_betas
protected

number of weights

Definition at line 359 of file MultitaskKernelPlifNormalizer.h.

int32_t num_tasks
protected

number of tasks

Definition at line 342 of file MultitaskKernelPlifNormalizer.h.

int32_t num_tasksqr
protected

square of num_tasks – for registration purpose

Definition at line 344 of file MultitaskKernelPlifNormalizer.h.

Parallel* parallel
inherited

parallel

Definition at line 372 of file SGObject.h.

float64_t scale
protectedinherited

scale constant obtained from k(0,0)

Definition at line 127 of file MultitaskKernelMklNormalizer.h.

std::vector<float64_t> similarity_matrix
protected

MxM matrix encoding similarity between tasks

Definition at line 356 of file MultitaskKernelPlifNormalizer.h.

std::vector<float64_t> support
protected

support points

Definition at line 365 of file MultitaskKernelPlifNormalizer.h.

std::vector<int32_t> task_vector_lhs
protected

task vector indicating to which task each example on the left hand side belongs

Definition at line 347 of file MultitaskKernelPlifNormalizer.h.

std::vector<int32_t> task_vector_rhs
protected

task vector indicating to which task each example on the right hand side belongs

Definition at line 350 of file MultitaskKernelPlifNormalizer.h.

Version* version
inherited

version

Definition at line 375 of file SGObject.h.


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

SHOGUN Machine Learning Toolbox - Documentation