SHOGUN  6.1.3
CCosineDistance Class Reference

## Detailed Description

class CosineDistance

The Cosine distance is obtained by using the Cosine similarity (Orchini similarity, angular similarity, normalized dot product), which measures similarity between two vectors by finding their angle. An extension to the Cosine similarity yields the Tanimoto coefficient.

$\displaystyle d(\bf{x},\bf{x'}) = 1 - \frac{\sum_{i=1}^{n}\bf{x_{i}}\bf{x'_{i}}} {\sqrt{\sum_{i=1}^{n} x_{i}^2 \sum_{i=1}^{n} {x'}_{i}^2}} \quad x,x' \in R^{n}$

Wikipedia: Cosine similarity
CTanimotoDistance

Definition at line 37 of file CosineDistance.h.

Inheritance diagram for CCosineDistance:
[legend]

## Public Types

typedef rxcpp::subjects::subject< ObservedValueSGSubject

typedef rxcpp::observable< ObservedValue, rxcpp::dynamic_observable< ObservedValue > > SGObservable

typedef rxcpp::subscriber< ObservedValue, rxcpp::observer< ObservedValue, void, void, void, void > > SGSubscriber

## Public Member Functions

CCosineDistance ()

CCosineDistance (CDenseFeatures< float64_t > *l, CDenseFeatures< float64_t > *r)

virtual ~CCosineDistance ()

virtual bool init (CFeatures *l, CFeatures *r)

virtual void cleanup ()

virtual EDistanceType get_distance_type ()

virtual const char * get_name () const

virtual EFeatureClass get_feature_class ()

virtual EFeatureType get_feature_type ()

EFeatureType get_feature_type ()

EFeatureType get_feature_type ()

EFeatureType get_feature_type ()

EFeatureType get_feature_type ()

EFeatureType get_feature_type ()

EFeatureType get_feature_type ()

EFeatureType get_feature_type ()

virtual float64_t distance (int32_t idx_a, int32_t idx_b)

virtual float64_t distance_upper_bounded (int32_t idx_a, int32_t idx_b, float64_t upper_bound)

virtual void precompute_rhs ()

virtual void precompute_lhs ()

virtual void reset_precompute ()

SGMatrix< float64_tget_distance_matrix ()

template<class T >
SGMatrix< T > get_distance_matrix ()

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

void save (CFile *writer)

CFeaturesget_lhs ()

CFeaturesget_rhs ()

virtual CFeaturesreplace_rhs (CFeatures *rhs)

virtual CFeaturesreplace_lhs (CFeatures *lhs)

virtual void remove_lhs_and_rhs ()

virtual void remove_lhs ()
takes all necessary steps if the lhs is removed from distance matrix More...

virtual void remove_rhs ()
takes all necessary steps if the rhs is removed from distance matrix More...

bool get_precompute_matrix ()

virtual void set_precompute_matrix (bool flag)

virtual int32_t get_num_vec_lhs ()

virtual int32_t get_num_vec_rhs ()

virtual bool has_features ()

bool lhs_equals_rhs ()

void run_distance_rhs (SGVector< float64_t > &result, const index_t idx_r_start, index_t idx_start, const index_t idx_stop, const index_t idx_a)

void run_distance_lhs (SGVector< float64_t > &result, const index_t idx_r_start, index_t idx_start, const index_t idx_stop, const index_t idx_b)

int32_t ref ()

int32_t ref_count ()

int32_t unref ()

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)

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 >
get (const Tag< T > &_tag) const

template<typename T , typename U = void>
get (const std::string &name) const

SGObservableget_parameters_observable ()

void subscribe_to_parameters (ParameterObserverInterface *obs)

void list_observable_parameters ()

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

uint32_t m_hash

## Protected Member Functions

virtual float64_t compute (int32_t idx_a, int32_t idx_b)

void do_precompute_matrix ()
matrix precomputation More...

virtual bool check_compatibility (CFeatures *l, CFeatures *r)

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)

bool clone_parameters (CSGObject *other)

void observe (const ObservedValue value)

void register_observable_param (const std::string &name, const SG_OBS_VALUE_TYPE type, const std::string &description)

## Static Protected Member Functions

static void * run_distance_thread (void *p)

## Protected Attributes

float32_tprecomputed_matrix

bool precompute_matrix

CFeatureslhs
feature vectors to occur on the left hand side More...

CFeaturesrhs
feature vectors to occur on the right hand side More...

int32_t num_lhs

int32_t num_rhs

## ◆ SGObservable

 inherited

Definition at line 130 of file SGObject.h.

## ◆ SGSubject

 inherited

Definition at line 127 of file SGObject.h.

## ◆ SGSubscriber

 typedef rxcpp::subscriber< ObservedValue, rxcpp::observer > SGSubscriber
inherited

Definition at line 133 of file SGObject.h.

## ◆ CCosineDistance() [1/2]

 CCosineDistance ( )

default constructor

Definition at line 19 of file CosineDistance.cpp.

## ◆ CCosineDistance() [2/2]

 CCosineDistance ( CDenseFeatures< float64_t > * l, CDenseFeatures< float64_t > * r )

constructor

Parameters
 l features of left-hand side r features of right-hand side

Definition at line 24 of file CosineDistance.cpp.

## ◆ ~CCosineDistance()

 ~CCosineDistance ( )
virtual

Definition at line 30 of file CosineDistance.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
 dict dictionary of parameters to be built.

Definition at line 635 of file SGObject.cpp.

## ◆ check_compatibility()

 bool check_compatibility ( CFeatures * l, CFeatures * r )
protectedvirtualinherited

Checks the compatibility between two supplied features

Parameters
 l left hand side features r right hand side features
Returns
true if the features are compatible

Definition at line 80 of file Distance.cpp.

## ◆ cleanup()

 void cleanup ( )
virtual

cleanup distance

Implements CDistance.

Definition at line 40 of file CosineDistance.cpp.

## ◆ clone()

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

## ◆ clone_parameters()

 bool clone_parameters ( CSGObject * other )
protectedinherited

Definition at line 759 of file SGObject.cpp.

## ◆ compute()

 float64_t compute ( int32_t idx_a, int32_t idx_b )
protectedvirtual

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

Implements CDistance.

Definition at line 44 of file CosineDistance.cpp.

## ◆ compute_row_start()

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

compute row start offset for parallel kernel matrix computation

Parameters
 offs offset n number of columns symmetric whether matrix is symmetric

Definition at line 173 of file Distance.h.

## ◆ deep_copy()

 CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 232 of file SGObject.cpp.

## ◆ distance()

 float64_t distance ( int32_t idx_a, int32_t idx_b )
virtualinherited

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

Parameters
 idx_a feature vector a at idx_a idx_b feature vector b at idx_b
Returns
distance value

Definition at line 185 of file Distance.cpp.

## ◆ distance_upper_bounded()

 virtual float64_t distance_upper_bounded ( int32_t idx_a, int32_t idx_b, float64_t upper_bound )
virtualinherited

get distance function for lhs feature vector a and rhs feature vector b. The computation of the distance stops if the intermediate result is larger than upper_bound. This is useful to use with John Langford's Cover Tree and it is ONLY implemented for Euclidean distance

Parameters
 idx_a feature vector a at idx_a idx_b feature vector b at idx_b upper_bound value above which the computation halts
Returns
distance value or upper_bound

Reimplemented in CEuclideanDistance.

Definition at line 124 of file Distance.h.

## ◆ do_precompute_matrix()

 void do_precompute_matrix ( )
protectedinherited

matrix precomputation

Definition at line 233 of file Distance.cpp.

## ◆ equals()

 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
 other object to compare with accuracy accuracy to use for comparison (optional) tolerant allows linient check on float equality (within accuracy)
Returns
true if all parameters were equal, false if not

Definition at line 656 of file SGObject.cpp.

## ◆ get() [1/2]

 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
 _tag name and type information of parameter
Returns
value of the parameter identified by the input tag

Definition at line 381 of file SGObject.h.

## ◆ get() [2/2]

 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
 name name of the parameter
Returns
value of the parameter corresponding to the input name and type

Definition at line 404 of file SGObject.h.

## ◆ get_distance_matrix() [1/2]

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

get distance matrix

Returns
computed distance matrix (needs to be cleaned up)

Definition at line 156 of file Distance.h.

## ◆ get_distance_matrix() [2/2]

 SGMatrix< T > get_distance_matrix ( )
inherited

get distance matrix (templated)

Returns
the distance matrix

Definition at line 269 of file Distance.cpp.

## ◆ get_distance_type()

 virtual EDistanceType get_distance_type ( )
virtual

get distance type we are

Returns
distance type COSINE

Implements CDenseDistance< float64_t >.

Definition at line 66 of file CosineDistance.h.

## ◆ get_feature_class()

 virtual EFeatureClass get_feature_class ( )
virtualinherited

get feature class the distance can deal with

Returns
feature class DENSE

Implements CDistance.

Definition at line 42 of file DenseDistance.h.

## ◆ get_feature_type() [1/8]

 EFeatureType get_feature_type ( )
virtualinherited

get feature type the DREAL distance can deal with

Returns
feature type DREAL

Implements CDistance.

Definition at line 28 of file DenseDistance.cpp.

## ◆ get_feature_type() [2/8]

 EFeatureType get_feature_type ( )
virtualinherited

get feature type the ULONG distance can deal with

Returns
feature type ULONG

Implements CDistance.

Definition at line 34 of file DenseDistance.cpp.

## ◆ get_feature_type() [3/8]

 EFeatureType get_feature_type ( )
virtualinherited

get feature type the INT distance can deal with

Returns
feature type INT

Implements CDistance.

Definition at line 40 of file DenseDistance.cpp.

## ◆ get_feature_type() [4/8]

 EFeatureType get_feature_type ( )
virtualinherited

get feature type the WORD distance can deal with

Returns
feature type WORD

Implements CDistance.

Definition at line 46 of file DenseDistance.cpp.

## ◆ get_feature_type() [5/8]

 virtual EFeatureType get_feature_type ( )
virtualinherited

get feature type the distance can deal with

Returns
template-specific feature type

Implements CDistance.

Reimplemented in CMahalanobisDistance, CAttenuatedEuclideanDistance, and CRealDistance.

## ◆ get_feature_type() [6/8]

 EFeatureType get_feature_type ( )
virtualinherited

get feature type the SHORT distance can deal with

Returns
feature type SHORT

Implements CDistance.

Definition at line 52 of file DenseDistance.cpp.

## ◆ get_feature_type() [7/8]

 EFeatureType get_feature_type ( )
virtualinherited

get feature type the BYTE distance can deal with

Returns
feature type BYTE

Implements CDistance.

Definition at line 58 of file DenseDistance.cpp.

## ◆ get_feature_type() [8/8]

 EFeatureType get_feature_type ( )
virtualinherited

get feature type the CHAR distance can deal with

Returns
feature type CHAR

Implements CDistance.

Definition at line 64 of file DenseDistance.cpp.

## ◆ get_global_io()

 SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 269 of file SGObject.cpp.

## ◆ get_global_parallel()

 Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 311 of file SGObject.cpp.

## ◆ get_global_version()

 Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 324 of file SGObject.cpp.

## ◆ get_lhs()

 CFeatures* get_lhs ( )
inherited

get left-hand side features used in distance matrix

Returns
left-hand side features

Definition at line 218 of file Distance.h.

## ◆ get_modelsel_names()

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

Definition at line 536 of file SGObject.cpp.

## ◆ get_modsel_param_descr()

 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_name name of the parameter
Returns
description of the parameter

Definition at line 560 of file SGObject.cpp.

## ◆ get_modsel_param_index()

 index_t get_modsel_param_index ( const char * param_name )
inherited

Returns index of model selection parameter with provided index

Parameters
 param_name name of model selection parameter
Returns
index of model selection parameter with provided name, -1 if there is no such

Definition at line 573 of file SGObject.cpp.

## ◆ get_name()

 virtual const char* get_name ( ) const
virtual

get name of the distance

Returns
name Cosine distance

Reimplemented from CDenseDistance< float64_t >.

Definition at line 72 of file CosineDistance.h.

## ◆ get_num_vec_lhs()

 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 CCustomDistance.

Definition at line 306 of file Distance.h.

## ◆ get_num_vec_rhs()

 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 CCustomDistance.

Definition at line 315 of file Distance.h.

## ◆ get_parameters_observable()

 SGObservable* get_parameters_observable ( )
inherited

Get parameters observable

Returns
RxCpp observable

Definition at line 415 of file SGObject.h.

## ◆ get_precompute_matrix()

 bool get_precompute_matrix ( )
inherited

FIXME: precompute matrix should be dropped, handling should be via customdistance

Returns
if precompute_matrix

Definition at line 284 of file Distance.h.

## ◆ get_rhs()

 CFeatures* get_rhs ( )
inherited

get right-hand side features used in distance matrix

Returns
right-hand side features

Definition at line 224 of file Distance.h.

## ◆ has() [1/3]

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

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

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

Definition at line 304 of file SGObject.h.

## ◆ has() [2/3]

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

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

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

Definition at line 315 of file SGObject.h.

## ◆ has() [3/3]

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

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

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

Definition at line 326 of file SGObject.h.

## ◆ has_features()

 virtual bool has_features ( )
virtualinherited

test whether features have been assigned to lhs and rhs

Returns
true if features are assigned

Reimplemented in CCustomDistance.

Definition at line 324 of file Distance.h.

## ◆ init()

 bool init ( CFeatures * l, CFeatures * r )
virtual

init distance

Parameters
 l features of left-hand side r features of right-hand side
Returns
if init was successful

Reimplemented from CDenseDistance< float64_t >.

Definition at line 35 of file CosineDistance.cpp.

## ◆ is_generic()

 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
 generic set to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 330 of file SGObject.cpp.

## ◆ lhs_equals_rhs()

 bool lhs_equals_rhs ( )
inherited

test whether features on lhs and rhs are the same

Returns
true if features are the same

Definition at line 333 of file Distance.h.

## ◆ list_observable_parameters()

 void list_observable_parameters ( )
inherited

Print to stdout a list of observable parameters

Definition at line 878 of file SGObject.cpp.

inherited

Parameters

Definition at line 111 of file Distance.cpp.

 bool load_serializable ( CSerializableFile * file, const char * prefix = "" )
virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

Parameters
 file where to load from prefix prefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 403 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
 ShogunException will be thrown if an error occurs.

Definition at line 460 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
 ShogunException will be thrown if an error occurs.

Definition at line 455 of file SGObject.cpp.

## ◆ observe()

 void observe ( const ObservedValue value )
protectedinherited

Observe a parameter value and emit them to observer.

Parameters
 value Observed parameter's value

Definition at line 828 of file SGObject.cpp.

## ◆ parameter_hash_changed()

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

Definition at line 296 of file SGObject.cpp.

## ◆ precompute_lhs()

 virtual void precompute_lhs ( )
virtualinherited

Precomputation related to features of left hand side WARNING : Make sure to reset computations using reset_precompute() when features or feature matrix are changed. This method is empty, should be overloaded in derived class.

Reimplemented in CEuclideanDistance.

Definition at line 143 of file Distance.h.

## ◆ precompute_rhs()

 virtual void precompute_rhs ( )
virtualinherited

Precomputation related to features of right hand side WARNING : Make sure to reset computations using reset_precompute() when features or feature matrix are changed. This method is empty, should be overloaded in derived class.

Reimplemented in CEuclideanDistance.

Definition at line 135 of file Distance.h.

## ◆ print_modsel_params()

 void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 512 of file SGObject.cpp.

## ◆ print_serializable()

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

prints registered parameters out

Parameters
 prefix prefix for members

Definition at line 342 of file SGObject.cpp.

## ◆ ref()

 int32_t ref ( )
inherited

increase reference counter

Returns
reference count

Definition at line 186 of file SGObject.cpp.

## ◆ ref_count()

 int32_t ref_count ( )
inherited

display reference counter

Returns
reference count

Definition at line 193 of file SGObject.cpp.

## ◆ register_observable_param()

 void register_observable_param ( const std::string & name, const SG_OBS_VALUE_TYPE type, const std::string & description )
protectedinherited

Register which params this object can emit.

Parameters
 name the param name type the param type description a user oriented description

Definition at line 871 of file SGObject.cpp.

## ◆ register_param() [1/2]

 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
 _tag name and type information of parameter value value of the parameter

Definition at line 472 of file SGObject.h.

## ◆ register_param() [2/2]

 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
 name name of the parameter value value of the parameter along with type information

Definition at line 485 of file SGObject.h.

## ◆ remove_lhs()

 void remove_lhs ( )
virtualinherited

takes all necessary steps if the lhs is removed from distance matrix

Definition at line 134 of file Distance.cpp.

## ◆ remove_lhs_and_rhs()

 void remove_lhs_and_rhs ( )
virtualinherited

remove lhs and rhs from distance

Definition at line 123 of file Distance.cpp.

## ◆ remove_rhs()

 void remove_rhs ( )
virtualinherited

takes all necessary steps if the rhs is removed from distance matrix

takes all necessary steps if the rhs is removed from distance

Definition at line 142 of file Distance.cpp.

## ◆ replace_lhs()

 CFeatures * replace_lhs ( CFeatures * lhs )
virtualinherited

replace left-hand side features used in distance matrix

make sure to check that your distance can deal with the supplied features (!)

Parameters
 lhs features of right-hand side
Returns
replaced left-hand side features

Reimplemented in CEuclideanDistance.

Definition at line 167 of file Distance.cpp.

## ◆ replace_rhs()

 CFeatures * replace_rhs ( CFeatures * rhs )
virtualinherited

replace right-hand side features used in distance matrix

make sure to check that your distance can deal with the supplied features (!)

Parameters
 rhs features of right-hand side
Returns
replaced right-hand side features

Reimplemented in CEuclideanDistance.

Definition at line 149 of file Distance.cpp.

## ◆ reset_precompute()

 virtual void reset_precompute ( )
virtualinherited

Reset precomputations for features of both sides Should be used to reset whenever features or feature matrix are changed. This method is empty, should be overloaded in derived class.

Reimplemented in CEuclideanDistance.

Definition at line 150 of file Distance.h.

## ◆ run_distance_lhs()

 void run_distance_lhs ( SGVector< float64_t > & result, const index_t idx_r_start, index_t idx_start, const index_t idx_stop, const index_t idx_b )
inherited

Function for computing distance values

Parameters
 result array of distance values idx_r_start iteration start value idx_start start idx_stop iteration end value idx_b feature vector b at idx_b

Definition at line 227 of file Distance.cpp.

## ◆ run_distance_rhs()

 void run_distance_rhs ( SGVector< float64_t > & result, const index_t idx_r_start, index_t idx_start, const index_t idx_stop, const index_t idx_a )
inherited

Function for computing distance values

Parameters
 result array of distance values idx_r_start iteration start value idx_start start idx_stop iteration end value idx_a feature vector a at idx_a

Definition at line 221 of file Distance.cpp.

 static void* run_distance_thread ( void * p )
staticprotectedinherited

## ◆ save()

 void save ( CFile * writer )
inherited

save kernel matrix

Parameters
 writer File object via which to save data

Definition at line 117 of file Distance.cpp.

## ◆ save_serializable()

 bool save_serializable ( CSerializableFile * file, const char * prefix = "" )
virtualinherited

Save this object to file.

Parameters
 file where to save the object; will be closed during returning if PREFIX is an empty string. prefix prefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 348 of file SGObject.cpp.

## ◆ save_serializable_post()

 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
 ShogunException will be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 470 of file SGObject.cpp.

## ◆ save_serializable_pre()

 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
 ShogunException will be thrown if an error occurs.

Definition at line 465 of file SGObject.cpp.

## ◆ set() [1/2]

 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
 _tag name and type information of parameter value value of the parameter

Definition at line 342 of file SGObject.h.

## ◆ set() [2/2]

 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
 name name of the parameter value value of the parameter along with type information

Definition at line 368 of file SGObject.h.

## ◆ set_generic() [1/16]

 void set_generic ( )
inherited

Definition at line 73 of file SGObject.cpp.

## ◆ set_generic() [2/16]

 void set_generic ( )
inherited

Definition at line 78 of file SGObject.cpp.

## ◆ set_generic() [3/16]

 void set_generic ( )
inherited

Definition at line 83 of file SGObject.cpp.

## ◆ set_generic() [4/16]

 void set_generic ( )
inherited

Definition at line 88 of file SGObject.cpp.

## ◆ set_generic() [5/16]

 void set_generic ( )
inherited

Definition at line 93 of file SGObject.cpp.

## ◆ set_generic() [6/16]

 void set_generic ( )
inherited

Definition at line 98 of file SGObject.cpp.

## ◆ set_generic() [7/16]

 void set_generic ( )
inherited

Definition at line 103 of file SGObject.cpp.

## ◆ set_generic() [8/16]

 void set_generic ( )
inherited

Definition at line 108 of file SGObject.cpp.

## ◆ set_generic() [9/16]

 void set_generic ( )
inherited

Definition at line 113 of file SGObject.cpp.

## ◆ set_generic() [10/16]

 void set_generic ( )
inherited

Definition at line 118 of file SGObject.cpp.

## ◆ set_generic() [11/16]

 void set_generic ( )
inherited

Definition at line 123 of file SGObject.cpp.

## ◆ set_generic() [12/16]

 void set_generic ( )
inherited

Definition at line 128 of file SGObject.cpp.

## ◆ set_generic() [13/16]

 void set_generic ( )
inherited

Definition at line 133 of file SGObject.cpp.

## ◆ set_generic() [14/16]

 void set_generic ( )
inherited

Definition at line 138 of file SGObject.cpp.

## ◆ set_generic() [15/16]

 void set_generic ( )
inherited

Definition at line 143 of file SGObject.cpp.

## ◆ set_generic() [16/16]

 void set_generic ( )
inherited

set generic type to T

## ◆ set_global_io()

 void set_global_io ( SGIO * io )
inherited

set the io object

Parameters
 io io object to use

Definition at line 262 of file SGObject.cpp.

## ◆ set_global_parallel()

 void set_global_parallel ( Parallel * parallel )
inherited

set the parallel object

Parameters
 parallel parallel object to use

Definition at line 275 of file SGObject.cpp.

## ◆ set_global_version()

 void set_global_version ( Version * version )
inherited

set the version object

Parameters
 version version object to use

Definition at line 317 of file SGObject.cpp.

## ◆ set_precompute_matrix()

 virtual void set_precompute_matrix ( bool flag )
virtualinherited

FIXME: precompute matrix should be dropped, handling should be via customdistance

Parameters
 flag if precompute_matrix

Definition at line 291 of file Distance.h.

## ◆ shallow_copy()

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

## ◆ subscribe_to_parameters()

 void subscribe_to_parameters ( ParameterObserverInterface * obs )
inherited

Subscribe a parameter observer to watch over params

Definition at line 811 of file SGObject.cpp.

## ◆ unref()

 int32_t unref ( )
inherited

decrement reference counter and deallocate object if refcount is zero before or after decrementing it

Returns
reference count

Definition at line 200 of file SGObject.cpp.

## ◆ unset_generic()

 void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 337 of file SGObject.cpp.

## ◆ update_parameter_hash()

 void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 282 of file SGObject.cpp.

## ◆ io

 SGIO* io
inherited

io

Definition at line 600 of file SGObject.h.

## ◆ lhs

 CFeatures* lhs
protectedinherited

feature vectors to occur on the left hand side

Definition at line 397 of file Distance.h.

inherited

parameters wrt which we can compute gradients

Definition at line 615 of file SGObject.h.

## ◆ m_hash

 uint32_t m_hash
inherited

Hash of parameter values

Definition at line 618 of file SGObject.h.

## ◆ m_model_selection_parameters

 Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 612 of file SGObject.h.

## ◆ m_parameters

 Parameter* m_parameters
inherited

parameters

Definition at line 609 of file SGObject.h.

## ◆ num_lhs

 int32_t num_lhs
protectedinherited

number of feature vectors on the left hand side

Definition at line 402 of file Distance.h.

## ◆ num_rhs

 int32_t num_rhs
protectedinherited

number of feature vectors on the right hand side

Definition at line 404 of file Distance.h.

## ◆ parallel

 Parallel* parallel
inherited

parallel

Definition at line 603 of file SGObject.h.

## ◆ precompute_matrix

 bool precompute_matrix
protectedinherited

FIXME: precompute matrix should be dropped, handling should be via customdistance

Definition at line 394 of file Distance.h.

## ◆ precomputed_matrix

 float32_t* precomputed_matrix
protectedinherited

FIXME: precompute matrix should be dropped, handling should be via customdistance

Definition at line 389 of file Distance.h.

## ◆ rhs

 CFeatures* rhs
protectedinherited

feature vectors to occur on the right hand side

Definition at line 399 of file Distance.h.

## ◆ version

 Version* version
inherited

version

Definition at line 606 of file SGObject.h.

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

SHOGUN Machine Learning Toolbox - Documentation