SHOGUN  3.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
CPlif Class Reference

Detailed Description

class Plif

Definition at line 40 of file Plif.h.

Inheritance diagram for CPlif:
Inheritance graph
[legend]

Public Member Functions

 CPlif (int32_t len=0)
virtual ~CPlif ()
void init_penalty_struct_cache ()
float64_t lookup_penalty_svm (float64_t p_value, float64_t *d_values) const
float64_t lookup_penalty (float64_t p_value, float64_t *svm_values) const
float64_t lookup_penalty (int32_t p_value, float64_t *svm_values) const
float64_t lookup (float64_t p_value)
void penalty_clear_derivative ()
void penalty_add_derivative_svm (float64_t p_value, float64_t *svm_values, float64_t factor)
void penalty_add_derivative (float64_t p_value, float64_t *svm_values, float64_t factor)
const float64_tget_cum_derivative (int32_t &p_len) const
bool set_transform_type (const char *type_str)
const char * get_transform_type ()
void set_id (int32_t p_id)
int32_t get_id () const
int32_t get_max_id () const
void set_use_svm (int32_t p_use_svm)
int32_t get_use_svm () const
virtual bool uses_svm_values () const
void set_use_cache (int32_t p_use_cache)
void invalidate_cache ()
int32_t get_use_cache ()
void set_plif (int32_t p_len, float64_t *p_limits, float64_t *p_penalties)
void set_plif_limits (SGVector< float64_t > p_limits)
void set_plif_penalty (SGVector< float64_t > p_penalties)
void set_plif_length (int32_t p_len)
SGVector< float64_tget_plif_limits ()
SGVector< float64_tget_plif_penalties ()
void set_max_value (float64_t p_max_value)
virtual float64_t get_max_value () const
void set_min_value (float64_t p_min_value)
virtual float64_t get_min_value () const
void set_plif_name (char *p_name)
char * get_plif_name () const
bool get_do_calc ()
void set_do_calc (bool b)
void get_used_svms (int32_t *num_svms, int32_t *svm_ids)
int32_t get_plif_len ()
virtual void list_plif () const
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 ()
void unset_generic ()
virtual void print_serializable (const char *prefix="")
virtual bool save_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_version_parameter())
virtual bool load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_version_parameter())
DynArray< TParameter * > * load_file_parameters (const SGParamInfo *param_info, int32_t file_version, CSerializableFile *file, const char *prefix="")
DynArray< TParameter * > * load_all_file_parameters (int32_t file_version, int32_t current_version, CSerializableFile *file, const char *prefix="")
void map_parameters (DynArray< TParameter * > *param_base, int32_t &base_version, DynArray< const SGParamInfo * > *target_param_infos)
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 ()

Static Public Member Functions

static void delete_penalty_struct (CPlif **PEN, int32_t P)

Public Attributes

SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
Parameterm_gradient_parameters
ParameterMapm_parameter_map
uint32_t m_hash

Protected Member Functions

virtual TParametermigrate (DynArray< TParameter * > *param_base, const SGParamInfo *target)
virtual void one_to_one_migration_prepare (DynArray< TParameter * > *param_base, const SGParamInfo *target, TParameter *&replacement, TParameter *&to_migrate, char *old_name=NULL)
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 len
SGVector< float64_tlimits
SGVector< float64_tpenalties
SGVector< float64_tcum_derivatives
float64_t max_value
float64_t min_value
float64_tcache
enum ETransformType transform
int32_t id
char * name
int32_t use_svm
bool use_cache
bool do_calc

Constructor & Destructor Documentation

CPlif ( int32_t  len = 0)

constructor

Parameters
lenlen

Definition at line 23 of file Plif.cpp.

~CPlif ( )
virtual

Definition at line 43 of file Plif.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 1189 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 1306 of file SGObject.cpp.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 146 of file SGObject.cpp.

void delete_penalty_struct ( CPlif **  PEN,
int32_t  P 
)
static

delete plif struct

Parameters
PENarray of plifs
Pid of plif

Definition at line 115 of file Plif.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 1210 of file SGObject.cpp.

const float64_t* get_cum_derivative ( int32_t &  p_len) const

get cum derivative

Parameters
p_lenlen
Returns
cum derivative

Definition at line 115 of file Plif.h.

bool get_do_calc ( )

get do calc

Returns
if calc shall be done

Definition at line 398 of file Plif.cpp.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 183 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 224 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 237 of file SGObject.cpp.

int32_t get_id ( ) const

get ID

Returns
the ID

Definition at line 163 of file Plif.h.

int32_t get_max_id ( ) const
virtual

get maximum ID

Returns
maximum ID

Implements CPlifBase.

Definition at line 172 of file Plif.h.

virtual float64_t get_max_value ( ) const
virtual

get maximum value

Returns
maximum value

Implements CPlifBase.

Definition at line 341 of file Plif.h.

virtual float64_t get_min_value ( ) const
virtual

get minimum value

Returns
minimum value

Implements CPlifBase.

Definition at line 360 of file Plif.h.

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

Definition at line 1081 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 1105 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 1118 of file SGObject.cpp.

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

Implements CSGObject.

Definition at line 420 of file Plif.h.

int32_t get_plif_len ( )

get plif len

Returns
plif len

Definition at line 398 of file Plif.h.

SGVector<float64_t> get_plif_limits ( )

get Plif limits

Returns
limits

Definition at line 313 of file Plif.h.

char * get_plif_name ( ) const

get name

Returns
name

Definition at line 103 of file Plif.cpp.

SGVector<float64_t> get_plif_penalties ( )

get plif penalty

Returns
plif penalty

Definition at line 322 of file Plif.h.

const char* get_transform_type ( )

get transform type

Returns
type_str type (string)

Definition at line 132 of file Plif.h.

int32_t get_use_cache ( )

get use cache

Returns
if cache is used

Definition at line 227 of file Plif.h.

int32_t get_use_svm ( ) const

get use SVM

Returns
if SVM is used

Definition at line 191 of file Plif.h.

void get_used_svms ( int32_t *  num_svms,
int32_t *  svm_ids 
)
virtual

get SVM_ids and number of SVMs used

Implements CPlifBase.

Definition at line 388 of file Plif.cpp.

void init_penalty_struct_cache ( )

init penalty struct cache

Definition at line 73 of file Plif.cpp.

void invalidate_cache ( )

invalidate the cache

Definition at line 217 of file Plif.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 243 of file SGObject.cpp.

virtual void list_plif ( ) const
virtual

print PLIF

lists some properties of the PLIF

Implements CPlifBase.

Definition at line 407 of file Plif.h.

DynArray< TParameter * > * load_all_file_parameters ( int32_t  file_version,
int32_t  current_version,
CSerializableFile file,
const char *  prefix = "" 
)
inherited

maps all parameters of this instance to the provided file version and loads all parameter data from the file into an array, which is sorted (basically calls load_file_parameter(...) for all parameters and puts all results into a sorted array)

Parameters
file_versionparameter version of the file
current_versionversion from which mapping begins (you want to use Version::get_version_parameter() for this in most cases)
filefile to load from
prefixprefix for members
Returns
(sorted) array of created TParameter instances with file data

Definition at line 650 of file SGObject.cpp.

DynArray< TParameter * > * load_file_parameters ( const SGParamInfo param_info,
int32_t  file_version,
CSerializableFile file,
const char *  prefix = "" 
)
inherited

loads some specified parameters from a file with a specified version The provided parameter info has a version which is recursively mapped until the file parameter version is reached. Note that there may be possibly multiple parameters in the mapping, therefore, a set of TParameter instances is returned

Parameters
param_infoinformation of parameter
file_versionparameter version of the file, must be <= provided parameter version
filefile to load from
prefixprefix for members
Returns
new array with TParameter instances with the attached data

Definition at line 491 of file SGObject.cpp.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
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
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Definition at line 320 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 1008 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 1003 of file SGObject.cpp.

float64_t lookup ( float64_t  p_value)

lookup

Parameters
p_valuevalue
Returns
a penalty

Definition at line 84 of file Plif.h.

float64_t lookup_penalty ( float64_t  p_value,
float64_t svm_values 
) const
virtual

lookup penalty float64_t

Parameters
p_valuevalue
svm_valuesSVM values
Returns
the penalty

Implements CPlifBase.

Definition at line 205 of file Plif.cpp.

float64_t lookup_penalty ( int32_t  p_value,
float64_t svm_values 
) const
virtual

lookup penalty int32_t

Parameters
p_valuevalue
svm_valuesSVM values
Returns
the penalty

Implements CPlifBase.

Definition at line 185 of file Plif.cpp.

float64_t lookup_penalty_svm ( float64_t  p_value,
float64_t d_values 
) const

lookup penalty SVM

Parameters
p_valuevalue
d_valuesd values
Returns
the penalty

Definition at line 122 of file Plif.cpp.

void map_parameters ( DynArray< TParameter * > *  param_base,
int32_t &  base_version,
DynArray< const SGParamInfo * > *  target_param_infos 
)
inherited

Takes a set of TParameter instances (base) with a certain version and a set of target parameter infos and recursively maps the base level wise to the current version using CSGObject::migrate(...). The base is replaced. After this call, the base version containing parameters should be of same version/type as the initial target parameter infos. Note for this to work, the migrate methods and all the internal parameter mappings have to match

Parameters
param_baseset of TParameter instances that are mapped to the provided target parameter infos
base_versionversion of the parameter base
target_param_infosset of SGParamInfo instances that specify the target parameter base

Definition at line 688 of file SGObject.cpp.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo target 
)
protectedvirtualinherited

creates a new TParameter instance, which contains migrated data from the version that is provided. The provided parameter data base is used for migration, this base is a collection of all parameter data of the previous version. Migration is done FROM the data in param_base TO the provided param info Migration is always one version step. Method has to be implemented in subclasses, if no match is found, base method has to be called.

If there is an element in the param_base which equals the target, a copy of the element is returned. This represents the case when nothing has changed and therefore, the migrate method is not overloaded in a subclass

Parameters
param_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
Returns
a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

Definition at line 895 of file SGObject.cpp.

void one_to_one_migration_prepare ( DynArray< TParameter * > *  param_base,
const SGParamInfo target,
TParameter *&  replacement,
TParameter *&  to_migrate,
char *  old_name = NULL 
)
protectedvirtualinherited

This method prepares everything for a one-to-one parameter migration. One to one here means that only ONE element of the parameter base is needed for the migration (the one with the same name as the target). Data is allocated for the target (in the type as provided in the target SGParamInfo), and a corresponding new TParameter instance is written to replacement. The to_migrate pointer points to the single needed TParameter instance needed for migration. If a name change happened, the old name may be specified by old_name. In addition, the m_delete_data flag of to_migrate is set to true. So if you want to migrate data, the only thing to do after this call is converting the data in the m_parameter fields. If unsure how to use - have a look into an example for this. (base_migration_type_conversion.cpp for example)

Parameters
param_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
replacement(used as output) here the TParameter instance which is returned by migration is created into
to_migratethe only source that is used for migration
old_namewith this parameter, a name change may be specified

Definition at line 835 of file SGObject.cpp.

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

Definition at line 209 of file SGObject.cpp.

void penalty_add_derivative ( float64_t  p_value,
float64_t svm_values,
float64_t  factor 
)
virtual

penalty add derivative

Parameters
p_valuevalue
svm_valuesSVM values
factorfactor weighting the added value

Implements CPlifBase.

Definition at line 289 of file Plif.cpp.

void penalty_add_derivative_svm ( float64_t  p_value,
float64_t svm_values,
float64_t  factor 
)

penalty add derivative SVM

Parameters
p_valuevalue
svm_valuesSVM values
factorfactor weighting the added value

Definition at line 341 of file Plif.cpp.

void penalty_clear_derivative ( )
virtual

penalty clear derivative

Implements CPlifBase.

Definition at line 283 of file Plif.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 1057 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 255 of file SGObject.cpp.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
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
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Definition at line 261 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 1018 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 1013 of file SGObject.cpp.

void set_do_calc ( bool  b)

set do calc

Parameters
bif calc shall be done

Definition at line 403 of file Plif.cpp.

void set_generic< complex128_t > ( )
inherited

set generic type to T

Definition at line 38 of file SGObject.cpp.

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 176 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 189 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 230 of file SGObject.cpp.

void set_id ( int32_t  p_id)

set ID

Parameters
p_idthe id to set

Definition at line 154 of file Plif.h.

void set_max_value ( float64_t  p_max_value)

set maximum value

Parameters
p_max_valuemaximum value

Definition at line 331 of file Plif.h.

void set_min_value ( float64_t  p_min_value)

set minimum value

Parameters
p_min_valueminimum value

Definition at line 350 of file Plif.h.

void set_plif ( int32_t  p_len,
float64_t p_limits,
float64_t p_penalties 
)

set plif

Parameters
p_lenlen
p_limitslimit
p_penaltiespenalties

Definition at line 238 of file Plif.h.

void set_plif_length ( int32_t  p_len)

set plif length

Parameters
p_lenlen

Definition at line 286 of file Plif.h.

void set_plif_limits ( SGVector< float64_t p_limits)

set plif_limits

Parameters
p_limitslimit

Definition at line 257 of file Plif.h.

void set_plif_name ( char *  p_name)

set name

Parameters
p_namename

Definition at line 97 of file Plif.cpp.

void set_plif_penalty ( SGVector< float64_t p_penalties)

set plif penalty

Parameters
p_penaltiespenalties

Definition at line 272 of file Plif.h.

bool set_transform_type ( const char *  type_str)

set transform type

Parameters
type_strtype (string)
Returns
if setting was successful

Definition at line 49 of file Plif.cpp.

void set_use_cache ( int32_t  p_use_cache)

set use cache

Parameters
p_use_cacheif cache shall be used

Definition at line 209 of file Plif.h.

void set_use_svm ( int32_t  p_use_svm)

set use SVM

Parameters
p_use_svmif SVM shall be used

Definition at line 181 of file Plif.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 140 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 250 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 196 of file SGObject.cpp.

virtual bool uses_svm_values ( ) const
virtual

check if plif uses SVM values

Returns
if plif uses SVM values

Implements CPlifBase.

Definition at line 200 of file Plif.h.

Member Data Documentation

float64_t* cache
protected

cache

Definition at line 436 of file Plif.h.

SGVector<float64_t> cum_derivatives
protected

cum derivatives

Definition at line 430 of file Plif.h.

bool do_calc
protected

do calc if this is true: lookup_penalty behaves normal else: lookup_penalty returns the p_value untransformed

Definition at line 450 of file Plif.h.

int32_t id
protected

id

Definition at line 440 of file Plif.h.

SGIO* io
inherited

io

Definition at line 457 of file SGObject.h.

int32_t len
protected

len

Definition at line 424 of file Plif.h.

SGVector<float64_t> limits
protected

limits

Definition at line 426 of file Plif.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 472 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 478 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 469 of file SGObject.h.

ParameterMap* m_parameter_map
inherited

map for different parameter versions

Definition at line 475 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 466 of file SGObject.h.

float64_t max_value
protected

maximum value

Definition at line 432 of file Plif.h.

float64_t min_value
protected

minimum value

Definition at line 434 of file Plif.h.

char* name
protected

name

Definition at line 442 of file Plif.h.

Parallel* parallel
inherited

parallel

Definition at line 460 of file SGObject.h.

SGVector<float64_t> penalties
protected

penalties

Definition at line 428 of file Plif.h.

enum ETransformType transform
protected

transform type

Definition at line 438 of file Plif.h.

bool use_cache
protected

if cache shall be used

Definition at line 446 of file Plif.h.

int32_t use_svm
protected

if SVM shall be used

Definition at line 444 of file Plif.h.

Version* version
inherited

version

Definition at line 463 of file SGObject.h.


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

SHOGUN Machine Learning Toolbox - Documentation