SHOGUN  v3.0.0
 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 | Static Protected Member Functions | Protected Attributes
CDistanceKernel Class Reference

Detailed Description

The Distance kernel takes a distance as input.

It turns a distance into something kernel like by computing

\[ k({\bf x}, {\bf x'}) = e^{-\frac{dist({\bf x}, {\bf x'})}{width}} \]

Definition at line 33 of file DistanceKernel.h.

Inheritance diagram for CDistanceKernel:
Inheritance graph
[legend]

Public Member Functions

 CDistanceKernel ()
 CDistanceKernel (int32_t cache, float64_t width, CDistance *dist)
 CDistanceKernel (CFeatures *l, CFeatures *r, float64_t width, CDistance *dist)
virtual ~CDistanceKernel ()
virtual bool init (CFeatures *l, CFeatures *r)
virtual void register_params ()
virtual EKernelType get_kernel_type ()
virtual EFeatureType get_feature_type ()
virtual EFeatureClass get_feature_class ()
virtual const char * get_name () const
virtual void set_width (float64_t w)
virtual float64_t get_width () const
float64_t kernel (int32_t idx_a, int32_t idx_b)
SGMatrix< float64_tget_kernel_matrix ()
template<class T >
SGMatrix< T > get_kernel_matrix ()
SGVector< float64_tget_kernel_diagonal (SGVector< float64_t > preallocated=SGVector< float64_t >())
virtual SGVector< float64_tget_kernel_col (int32_t j)
virtual SGVector< float64_tget_kernel_row (int32_t i)
void get_kernel_row (int32_t docnum, int32_t *active2dnum, float64_t *buffer, bool full_line=false)
virtual bool set_normalizer (CKernelNormalizer *normalizer)
virtual CKernelNormalizerget_normalizer ()
virtual bool init_normalizer ()
virtual void cleanup ()
void load (CFile *loader)
void save (CFile *writer)
CFeaturesget_lhs ()
CFeaturesget_rhs ()
virtual int32_t get_num_vec_lhs ()
virtual int32_t get_num_vec_rhs ()
virtual bool has_features ()
bool get_lhs_equals_rhs ()
virtual void remove_lhs_and_rhs ()
virtual void remove_lhs ()
virtual void remove_rhs ()
 takes all necessary steps if the rhs is removed from kernel
void set_cache_size (int32_t size)
int32_t get_cache_size ()
void cache_reset ()
int32_t get_max_elems_cache ()
int32_t get_activenum_cache ()
void cache_kernel_row (int32_t x)
void cache_multiple_kernel_rows (int32_t *key, int32_t varnum)
void kernel_cache_reset_lru ()
void kernel_cache_shrink (int32_t totdoc, int32_t num_shrink, int32_t *after)
void resize_kernel_cache (KERNELCACHE_IDX size, bool regression_hack=false)
void set_time (int32_t t)
int32_t kernel_cache_touch (int32_t cacheidx)
int32_t kernel_cache_check (int32_t cacheidx)
int32_t kernel_cache_space_available ()
void kernel_cache_init (int32_t size, bool regression_hack=false)
void kernel_cache_cleanup ()
void list_kernel ()
bool has_property (EKernelProperty p)
virtual void clear_normal ()
virtual void add_to_normal (int32_t vector_idx, float64_t weight)
EOptimizationType get_optimization_type ()
virtual void set_optimization_type (EOptimizationType t)
bool get_is_initialized ()
virtual bool init_optimization (int32_t count, int32_t *IDX, float64_t *weights)
virtual bool delete_optimization ()
bool init_optimization_svm (CSVM *svm)
virtual float64_t compute_optimized (int32_t vector_idx)
virtual void compute_batch (int32_t num_vec, int32_t *vec_idx, float64_t *target, int32_t num_suppvec, int32_t *IDX, float64_t *alphas, float64_t factor=1.0)
float64_t get_combined_kernel_weight ()
void set_combined_kernel_weight (float64_t nw)
virtual int32_t get_num_subkernels ()
virtual void compute_by_subkernel (int32_t vector_idx, float64_t *subkernel_contrib)
virtual const float64_tget_subkernel_weights (int32_t &num_weights)
virtual SGVector< float64_tget_subkernel_weights ()
virtual void set_subkernel_weights (SGVector< float64_t > weights)
virtual SGMatrix< float64_tget_parameter_gradient (const TParameter *param, index_t index=-1)
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 bool update_parameter_hash ()
virtual bool equals (CSGObject *other, float64_t accuracy=0.0)
virtual CSGObjectclone ()

Static Public Member Functions

static CKernelobtain_from_generic (CSGObject *kernel)

Public Attributes

SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
Parameterm_gradient_parameters
ParameterMapm_parameter_map
uint32_t m_hash

Protected Member Functions

float64_t compute (int32_t idx_a, int32_t idx_b)
void set_property (EKernelProperty p)
void unset_property (EKernelProperty p)
void set_is_initialized (bool p_init)
int32_t compute_row_start (int64_t offs, int32_t n, bool symmetric)
virtual void load_serializable_post () throw (ShogunException)
virtual void save_serializable_pre () throw (ShogunException)
virtual void save_serializable_post () throw (ShogunException)
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)

Static Protected Member Functions

template<class T >
static void * get_kernel_matrix_helper (void *p)

Protected Attributes

CDistancedistance
float64_t width
int32_t cache_size
 cache_size in MB
KERNEL_CACHE kernel_cache
 kernel cache
KERNELCACHE_ELEMkernel_matrix
CFeatureslhs
 feature vectors to occur on left hand side
CFeaturesrhs
 feature vectors to occur on right hand side
bool lhs_equals_rhs
 lhs
int32_t num_lhs
 number of feature vectors on left hand side
int32_t num_rhs
 number of feature vectors on right hand side
float64_t combined_kernel_weight
bool optimization_initialized
EOptimizationType opt_type
uint64_t properties
CKernelNormalizernormalizer

Constructor & Destructor Documentation

default constructor

Definition at line 20 of file DistanceKernel.cpp.

CDistanceKernel ( int32_t  cache,
float64_t  width,
CDistance dist 
)

constructor

Parameters
cachecache size
widthwidth
distdistance

Definition at line 26 of file DistanceKernel.cpp.

CDistanceKernel ( CFeatures l,
CFeatures r,
float64_t  width,
CDistance dist 
)

constructor

Parameters
lfeatures of left-hand side
rfeatures of right-hand side
widthwidth
distdistance

Definition at line 35 of file DistanceKernel.cpp.

~CDistanceKernel ( )
virtual

Definition at line 46 of file DistanceKernel.cpp.

Member Function Documentation

void add_to_normal ( int32_t  vector_idx,
float64_t  weight 
)
virtualinherited

add vector*factor to 'virtual' normal vector

Parameters
vector_idxindex
weightweight

Reimplemented in CCombinedKernel, CWeightedDegreeStringKernel, CWeightedDegreePositionStringKernel, CCommUlongStringKernel, CCommWordStringKernel, CLinearKernel, CLinearStringKernel, and CWeightedCommWordStringKernel.

Definition at line 838 of file Kernel.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 1196 of file SGObject.cpp.

void cache_kernel_row ( int32_t  x)
inherited

cache kernel row

Parameters
xx

Definition at line 293 of file Kernel.cpp.

void cache_multiple_kernel_rows ( int32_t *  key,
int32_t  varnum 
)
inherited

cache multiple kernel rows

Parameters
keykey
varnum

Definition at line 367 of file Kernel.cpp.

void cache_reset ( )
inherited

cache reset

Definition at line 444 of file Kernel.h.

void cleanup ( )
virtualinherited
void clear_normal ( )
virtualinherited

for optimizable kernels, i.e. kernels where the weight vector can be computed explicitly (if it fits into memory)

Reimplemented in CCombinedKernel, CWeightedDegreeStringKernel, CWeightedDegreePositionStringKernel, CCommUlongStringKernel, CCommWordStringKernel, CLinearKernel, and CLinearStringKernel.

Definition at line 843 of file Kernel.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 1313 of file SGObject.cpp.

float64_t compute ( int32_t  idx_a,
int32_t  idx_b 
)
protectedvirtual

compute kernel function for features a and b idx_{a,b} denote the index of the feature vectors in the corresponding feature object

Parameters
idx_aindex a
idx_bindex b
Returns
computed kernel function at indices a,b

Implements CKernel.

Reimplemented in CBesselKernel.

Definition at line 62 of file DistanceKernel.cpp.

void compute_batch ( int32_t  num_vec,
int32_t *  vec_idx,
float64_t target,
int32_t  num_suppvec,
int32_t *  IDX,
float64_t alphas,
float64_t  factor = 1.0 
)
virtualinherited

computes output for a batch of examples in an optimized fashion (favorable if kernel supports it, i.e. has KP_BATCHEVALUATION. to the outputvector target (of length num_vec elements) the output for the examples enumerated in vec_idx are added. therefore make sure that it is initialized with ZERO. the following num_suppvec, IDX, alphas arguments are the number of support vectors, their indices and weights

Reimplemented in CCombinedKernel, CWeightedDegreeStringKernel, and CWeightedDegreePositionStringKernel.

Definition at line 831 of file Kernel.cpp.

void compute_by_subkernel ( int32_t  vector_idx,
float64_t subkernel_contrib 
)
virtualinherited

compute by subkernel

Parameters
vector_idxindex
subkernel_contribsubkernel contribution

Reimplemented in CCombinedKernel, CWeightedDegreeStringKernel, and CWeightedDegreePositionStringKernel.

Definition at line 853 of file Kernel.cpp.

float64_t compute_optimized ( int32_t  vector_idx)
virtualinherited

compute optimized

Parameters
vector_idxindex to compute
Returns
optimized value at given index

Reimplemented in CCombinedKernel, CWeightedDegreeStringKernel, CWeightedDegreePositionStringKernel, CCommWordStringKernel, CCommUlongStringKernel, CLinearKernel, CLinearStringKernel, and CWeightedCommWordStringKernel.

Definition at line 825 of file Kernel.cpp.

int32_t compute_row_start ( int64_t  offs,
int32_t  n,
bool  symmetric 
)
protectedinherited

compute row start offset for parallel kernel matrix computation

Parameters
offsoffset
nnumber of columns
symmetricwhether matrix is symmetric

Definition at line 748 of file Kernel.h.

virtual CSGObject* deep_copy ( ) const
virtualinherited

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

Definition at line 160 of file SGObject.h.

bool delete_optimization ( )
virtualinherited

delete optimization

Returns
if deleting was successful

Reimplemented in CCombinedKernel, CWeightedDegreeStringKernel, CWeightedDegreePositionStringKernel, CCommWordStringKernel, CCommUlongStringKernel, CLinearKernel, and CLinearStringKernel.

Definition at line 819 of file Kernel.cpp.

bool equals ( CSGObject other,
float64_t  accuracy = 0.0 
)
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)
Returns
true if all parameters were equal, false if not

Definition at line 1217 of file SGObject.cpp.

int32_t get_activenum_cache ( )
inherited

get activenum cache

Returns
activecnum cache

Definition at line 456 of file Kernel.h.

int32_t get_cache_size ( )
inherited

return the size of the kernel cache

Returns
size of kernel cache

Definition at line 440 of file Kernel.h.

float64_t get_combined_kernel_weight ( )
inherited

get combined kernel weight

Returns
combined kernel weight

Definition at line 644 of file Kernel.h.

virtual EFeatureClass get_feature_class ( )
virtual

return feature class the kernel can deal with

Returns
feature class of distance used

Implements CKernel.

Reimplemented in CBesselKernel.

Definition at line 87 of file DistanceKernel.h.

virtual EFeatureType get_feature_type ( )
virtual

return feature type the kernel can deal with

Returns
feature type of distance used

Implements CKernel.

Reimplemented in CBesselKernel.

Definition at line 81 of file DistanceKernel.h.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 214 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 249 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 262 of file SGObject.cpp.

bool get_is_initialized ( )
inherited

check if optimization is initialized

Returns
if optimization is initialized

Definition at line 595 of file Kernel.h.

virtual SGVector<float64_t> get_kernel_col ( int32_t  j)
virtualinherited

get column j

Returns
the jth column of the kernel matrix

Definition at line 259 of file Kernel.h.

SGVector<float64_t> get_kernel_diagonal ( SGVector< float64_t preallocated = SGVector<float64_t>())
inherited
Returns
Vector with diagonal elements of the kernel matrix. Note that left- and right-handside features must be set and of equal size
Parameters
preallocatedvector with space for results

Definition at line 225 of file Kernel.h.

template SGMatrix< float32_t > get_kernel_matrix< float32_t > ( )
inherited

get kernel matrix

Returns
computed kernel matrix (needs to be cleaned up)

Definition at line 214 of file Kernel.h.

SGMatrix<T> get_kernel_matrix ( )
inherited

get kernel matrix (templated)

Returns
the kernel matrix
template void * get_kernel_matrix_helper< float32_t > ( void *  p)
staticprotectedinherited

helper for computing the kernel matrix in a parallel way

Parameters
pthread parameters

Definition at line 1011 of file Kernel.cpp.

virtual SGVector<float64_t> get_kernel_row ( int32_t  i)
virtualinherited

get row i

Returns
the ith row of the kernel matrix

Definition at line 276 of file Kernel.h.

void get_kernel_row ( int32_t  docnum,
int32_t *  active2dnum,
float64_t buffer,
bool  full_line = false 
)
inherited

get kernel row

Parameters
docnumdocnum
active2dnumactive2dnum
bufferbuffer
full_linefull line

Definition at line 229 of file Kernel.cpp.

virtual EKernelType get_kernel_type ( )
virtual

return what type of kernel we are

Returns
kernel type DISTANCE

Implements CKernel.

Reimplemented in CBesselKernel.

Definition at line 76 of file DistanceKernel.h.

CFeatures* get_lhs ( )
inherited

get left-hand side of features used in kernel

Returns
features of left-hand side

Definition at line 346 of file Kernel.h.

bool get_lhs_equals_rhs ( )
inherited

test whether features on lhs and rhs are the same

Returns
true if features are the same

Definition at line 385 of file Kernel.h.

int32_t get_max_elems_cache ( )
inherited

get maximum elements in cache

Returns
maximum elements in cache

Definition at line 450 of file Kernel.h.

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

Definition at line 1100 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 1124 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 1137 of file SGObject.cpp.

virtual const char* get_name ( ) const
virtual

return the kernel's name

Returns
name Distance

Implements CSGObject.

Reimplemented in CBesselKernel.

Definition at line 93 of file DistanceKernel.h.

CKernelNormalizer * get_normalizer ( )
virtualinherited

obtain the current kernel normalizer

Returns
the kernel normalizer

Definition at line 153 of file Kernel.cpp.

int32_t get_num_subkernels ( )
virtualinherited

get number of subkernels

Returns
number of subkernels

Reimplemented in CWeightedDegreeStringKernel, CWeightedDegreePositionStringKernel, CCombinedKernel, and CProductKernel.

Definition at line 848 of file Kernel.cpp.

virtual int32_t get_num_vec_lhs ( )
virtualinherited

get number of vectors of lhs features

Returns
number of vectors of left-hand side

Reimplemented in CCustomKernel.

Definition at line 358 of file Kernel.h.

virtual int32_t get_num_vec_rhs ( )
virtualinherited

get number of vectors of rhs features

Returns
number of vectors of right-hand side

Reimplemented in CCustomKernel.

Definition at line 367 of file Kernel.h.

EOptimizationType get_optimization_type ( )
inherited

get optimization type

Returns
optimization type

Definition at line 583 of file Kernel.h.

virtual SGMatrix<float64_t> get_parameter_gradient ( const TParameter param,
index_t  index = -1 
)
virtualinherited

return derivative with respect to specified parameter

Parameters
paramthe parameter
indexthe index of the element if parameter is a vector
Returns
gradient with respect to parameter

Reimplemented in CCombinedKernel, CProductKernel, CGaussianKernel, CLinearARDKernel, and CGaussianARDKernel.

Definition at line 692 of file Kernel.h.

CFeatures* get_rhs ( )
inherited

get right-hand side of features used in kernel

Returns
features of right-hand side

Definition at line 352 of file Kernel.h.

const float64_t * get_subkernel_weights ( int32_t &  num_weights)
virtualinherited

get subkernel weights

Parameters
num_weightsnumber of weights will be stored here
Returns
subkernel weights

Reimplemented in CCombinedKernel, CWeightedDegreeStringKernel, and CWeightedDegreePositionStringKernel.

Definition at line 859 of file Kernel.cpp.

SGVector< float64_t > get_subkernel_weights ( )
virtualinherited

get subkernel weights (swig compatible)

Returns
subkernel weights

Reimplemented in CCombinedKernel.

Definition at line 865 of file Kernel.cpp.

virtual float64_t get_width ( ) const
virtual

return the kernel's width

Returns
kernel width

Reimplemented in CBesselKernel.

Definition at line 108 of file DistanceKernel.h.

virtual bool has_features ( )
virtualinherited

test whether features have been assigned to lhs and rhs

Returns
true if features are assigned

Reimplemented in CCustomKernel, CCombinedKernel, and CProductKernel.

Definition at line 376 of file Kernel.h.

bool has_property ( EKernelProperty  p)
inherited

check if kernel has given property

Parameters
pkernel property
Returns
if kernel has given property

Definition at line 565 of file Kernel.h.

bool init ( CFeatures l,
CFeatures r 
)
virtual

initialize kernel

Parameters
lfeatures of left-hand side
rfeatures of right-hand side
Returns
if initializing was successful

Reimplemented from CKernel.

Reimplemented in CBesselKernel.

Definition at line 54 of file DistanceKernel.cpp.

bool init_normalizer ( )
virtualinherited

initialize the current kernel normalizer

Returns
if init was successful

Definition at line 159 of file Kernel.cpp.

bool init_optimization ( int32_t  count,
int32_t *  IDX,
float64_t weights 
)
virtualinherited

initialize optimization

Parameters
countcount
IDXindex
weightsweights
Returns
if initializing was successful

Reimplemented in CCombinedKernel, CWeightedDegreeStringKernel, CWeightedDegreePositionStringKernel, CCommWordStringKernel, CCommUlongStringKernel, CLinearKernel, and CLinearStringKernel.

Definition at line 812 of file Kernel.cpp.

bool init_optimization_svm ( CSVM svm)
inherited

initialize optimization

Parameters
svmsvm model
Returns
if initializing was successful

Definition at line 895 of file Kernel.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 268 of file SGObject.cpp.

float64_t kernel ( int32_t  idx_a,
int32_t  idx_b 
)
inherited

get kernel function for lhs feature vector a and rhs feature vector b

Parameters
idx_aindex of feature vector a
idx_bindex of feature vector b
Returns
computed kernel function

Definition at line 201 of file Kernel.h.

int32_t kernel_cache_check ( int32_t  cacheidx)
inherited

check if row at given index is cached

Parameters
cacheidxindex in cache
Returns
if row at given index is cached

Definition at line 531 of file Kernel.h.

void kernel_cache_cleanup ( )
inherited

cleanup kernel cache

Definition at line 556 of file Kernel.cpp.

void kernel_cache_init ( int32_t  size,
bool  regression_hack = false 
)
inherited

initialize kernel cache

Parameters
sizesize to initialize to
regression_hackif hack for regression shall be applied

Definition at line 172 of file Kernel.cpp.

void kernel_cache_reset_lru ( )
inherited

kernel cache reset lru

Definition at line 543 of file Kernel.cpp.

void kernel_cache_shrink ( int32_t  totdoc,
int32_t  num_shrink,
int32_t *  after 
)
inherited

kernel cache shrink

Parameters
totdoctotdoc
num_shrinknumber of shrink
afterafter

Definition at line 486 of file Kernel.cpp.

int32_t kernel_cache_space_available ( )
inherited

check if there is room for one more row in kernel cache

Returns
if there is room for one more row in kernel cache

Definition at line 540 of file Kernel.h.

int32_t kernel_cache_touch ( int32_t  cacheidx)
inherited

update lru time of item at given index to avoid removal from cache

Parameters
cacheidxindex in cache
Returns
if updating was successful

Definition at line 516 of file Kernel.h.

void list_kernel ( )
inherited

list kernel

Definition at line 697 of file Kernel.cpp.

void load ( CFile loader)
inherited

load the kernel matrix

Parameters
loaderFile object via which to load data

Definition at line 635 of file Kernel.cpp.

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 673 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 514 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 345 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 occurres.

Reimplemented from CSGObject.

Reimplemented in CWeightedDegreePositionStringKernel, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.

Definition at line 913 of file Kernel.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 occurres.

Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CDynamicArray< uint64_t >, and CDynamicObjectArray.

Definition at line 1024 of file SGObject.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 711 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 918 of file SGObject.cpp.

CKernel * obtain_from_generic ( CSGObject kernel)
staticinherited

Obtains a kernel from a generic SGObject with error checking. Note that if passing NULL, result will be NULL

Parameters
kernelObject to cast to CKernel, is not SG_REFed
Returns
object casted to CKernel, NULL if not possible

Definition at line 881 of file Kernel.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 858 of file SGObject.cpp.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 1076 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 280 of file SGObject.cpp.

void register_params ( )
virtual

register the parameters (serialization support)

Reimplemented from CKernel.

Definition at line 68 of file DistanceKernel.cpp.

void remove_lhs ( )
virtualinherited

remove lhs from kernel

Reimplemented in CWeightedDegreeStringKernel, CWeightedDegreePositionStringKernel, CCombinedKernel, CCommUlongStringKernel, and CProductKernel.

Definition at line 668 of file Kernel.cpp.

void remove_lhs_and_rhs ( )
virtualinherited

remove lhs and rhs from kernel

Reimplemented in CCombinedKernel, and CProductKernel.

Definition at line 649 of file Kernel.cpp.

void remove_rhs ( )
virtualinherited

takes all necessary steps if the rhs is removed from kernel

remove rhs from kernel

Reimplemented in CCombinedKernel, CCommUlongStringKernel, and CProductKernel.

Definition at line 682 of file Kernel.cpp.

void resize_kernel_cache ( KERNELCACHE_IDX  size,
bool  regression_hack = false 
)
inherited

resize kernel cache

Parameters
sizenew size
regression_hackhack for regression

Definition at line 85 of file Kernel.cpp.

void save ( CFile writer)
inherited

save kernel matrix

Parameters
writerFile object via which to save data

Definition at line 641 of file Kernel.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 286 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 occurres.

Reimplemented from CSGObject.

Definition at line 928 of file Kernel.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 occurres.

Reimplemented from CSGObject.

Definition at line 920 of file Kernel.cpp.

void set_cache_size ( int32_t  size)
inherited

set the size of the kernel cache

Parameters
sizeof kernel cache

Definition at line 428 of file Kernel.h.

void set_combined_kernel_weight ( float64_t  nw)
inherited

set combined kernel weight

Parameters
nwnew combined kernel weight

Definition at line 650 of file Kernel.h.

void set_generic< complex128_t > ( )
inherited

set generic type to T

Definition at line 41 of file SGObject.cpp.

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 207 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 220 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 255 of file SGObject.cpp.

void set_is_initialized ( bool  p_init)
protectedinherited

set is initialized

Parameters
p_initif optimization shall be set to initialized

Definition at line 728 of file Kernel.h.

bool set_normalizer ( CKernelNormalizer normalizer)
virtualinherited

set the current kernel normalizer

Returns
if successful

Reimplemented in CWeightedDegreeStringKernel.

Definition at line 141 of file Kernel.cpp.

virtual void set_optimization_type ( EOptimizationType  t)
virtualinherited

set optimization type

Parameters
toptimization type to set

Reimplemented in CCombinedKernel.

Definition at line 589 of file Kernel.h.

void set_property ( EKernelProperty  p)
protectedinherited

set property

Parameters
pkernel property to set

Definition at line 710 of file Kernel.h.

void set_subkernel_weights ( SGVector< float64_t weights)
virtualinherited

set subkernel weights

Parameters
weightsnew subkernel weights

Reimplemented in CCombinedKernel, CWeightedDegreeStringKernel, and CWeightedDegreePositionStringKernel.

Definition at line 872 of file Kernel.cpp.

void set_time ( int32_t  t)
inherited

set the lru time

Parameters
tthe time to use

Definition at line 506 of file Kernel.h.

virtual void set_width ( float64_t  w)
virtual

set the kernel's width

Parameters
wkernel width

Reimplemented in CBesselKernel.

Definition at line 99 of file DistanceKernel.h.

virtual 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 151 of file SGObject.h.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 275 of file SGObject.cpp.

void unset_property ( EKernelProperty  p)
protectedinherited

unset property

Parameters
pkernel property to unset

Definition at line 719 of file Kernel.h.

bool update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination.

Returns
bool if parameter combination has changed since last update.

Definition at line 227 of file SGObject.cpp.

Member Data Documentation

int32_t cache_size
protectedinherited

cache_size in MB

Definition at line 876 of file Kernel.h.

float64_t combined_kernel_weight
protectedinherited

combined kernel weight

Definition at line 901 of file Kernel.h.

CDistance* distance
protected

distance

Definition at line 126 of file DistanceKernel.h.

SGIO* io
inherited

io

Definition at line 514 of file SGObject.h.

KERNEL_CACHE kernel_cache
protectedinherited

kernel cache

Definition at line 880 of file Kernel.h.

KERNELCACHE_ELEM* kernel_matrix
protectedinherited

this COULD store the whole kernel matrix usually not applicable / necessary to compute the whole matrix

Definition at line 885 of file Kernel.h.

CFeatures* lhs
protectedinherited

feature vectors to occur on left hand side

Definition at line 888 of file Kernel.h.

bool lhs_equals_rhs
protectedinherited

lhs

Definition at line 893 of file Kernel.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 529 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 535 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 526 of file SGObject.h.

ParameterMap* m_parameter_map
inherited

map for different parameter versions

Definition at line 532 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 523 of file SGObject.h.

CKernelNormalizer* normalizer
protectedinherited

normalize the kernel(i,j) function based on this normalization function

Definition at line 915 of file Kernel.h.

int32_t num_lhs
protectedinherited

number of feature vectors on left hand side

Definition at line 896 of file Kernel.h.

int32_t num_rhs
protectedinherited

number of feature vectors on right hand side

Definition at line 898 of file Kernel.h.

EOptimizationType opt_type
protectedinherited

optimization type (currently FASTBUTMEMHUNGRY and SLOWBUTMEMEFFICIENT)

Definition at line 908 of file Kernel.h.

bool optimization_initialized
protectedinherited

if optimization is initialized

Definition at line 904 of file Kernel.h.

Parallel* parallel
inherited

parallel

Definition at line 517 of file SGObject.h.

uint64_t properties
protectedinherited

kernel properties

Definition at line 911 of file Kernel.h.

CFeatures* rhs
protectedinherited

feature vectors to occur on right hand side

Definition at line 890 of file Kernel.h.

Version* version
inherited

version

Definition at line 520 of file SGObject.h.

float64_t width
protected

width

Definition at line 128 of file DistanceKernel.h.


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

SHOGUN Machine Learning Toolbox - Documentation