SHOGUN
6.1.3
|
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} \]
Definition at line 37 of file CosineDistance.h.
Public Types | |
typedef rxcpp::subjects::subject< ObservedValue > | SGSubject |
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_t > | get_distance_matrix () |
template<class T > | |
SGMatrix< T > | get_distance_matrix () |
int32_t | compute_row_start (int64_t offs, int32_t n, bool symmetric) |
void | load (CFile *loader) |
void | save (CFile *writer) |
CFeatures * | get_lhs () |
CFeatures * | get_rhs () |
virtual CFeatures * | replace_rhs (CFeatures *rhs) |
virtual CFeatures * | replace_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 CSGObject * | shallow_copy () const |
virtual CSGObject * | deep_copy () const |
virtual bool | is_generic (EPrimitiveType *generic) const |
template<class T > | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
template<> | |
void | set_generic () |
void | unset_generic () |
virtual void | print_serializable (const char *prefix="") |
virtual bool | save_serializable (CSerializableFile *file, const char *prefix="") |
virtual bool | load_serializable (CSerializableFile *file, const char *prefix="") |
void | set_global_io (SGIO *io) |
SGIO * | get_global_io () |
void | set_global_parallel (Parallel *parallel) |
Parallel * | get_global_parallel () |
void | set_global_version (Version *version) |
Version * | get_global_version () |
SGStringList< char > | get_modelsel_names () |
void | print_modsel_params () |
char * | get_modsel_param_descr (const char *param_name) |
index_t | get_modsel_param_index (const char *param_name) |
void | build_gradient_parameter_dictionary (CMap< TParameter *, CSGObject *> *dict) |
bool | has (const std::string &name) const |
template<typename T > | |
bool | has (const Tag< T > &tag) const |
template<typename T , typename U = void> | |
bool | has (const std::string &name) const |
template<typename T > | |
void | set (const Tag< T > &_tag, const T &value) |
template<typename T , typename U = void> | |
void | set (const std::string &name, const T &value) |
template<typename T > | |
T | get (const Tag< T > &_tag) const |
template<typename T , typename U = void> | |
T | get (const std::string &name) const |
SGObservable * | get_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 CSGObject * | clone () |
Public Attributes | |
SGIO * | io |
Parallel * | parallel |
Version * | version |
Parameter * | m_parameters |
Parameter * | m_model_selection_parameters |
Parameter * | m_gradient_parameters |
uint32_t | m_hash |
Protected Member Functions | |
virtual 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) |
run distance thread More... | |
Protected Attributes | |
float32_t * | precomputed_matrix |
bool | precompute_matrix |
CFeatures * | lhs |
feature vectors to occur on the left hand side More... | |
CFeatures * | rhs |
feature vectors to occur on the right hand side More... | |
int32_t | num_lhs |
int32_t | num_rhs |
|
inherited |
Definition at line 130 of file SGObject.h.
|
inherited |
Definition at line 127 of file SGObject.h.
|
inherited |
Definition at line 133 of file SGObject.h.
CCosineDistance | ( | ) |
default constructor
Definition at line 19 of file CosineDistance.cpp.
CCosineDistance | ( | CDenseFeatures< float64_t > * | l, |
CDenseFeatures< float64_t > * | r | ||
) |
constructor
l | features of left-hand side |
r | features of right-hand side |
Definition at line 24 of file CosineDistance.cpp.
|
virtual |
Definition at line 30 of file CosineDistance.cpp.
|
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.
dict | dictionary of parameters to be built. |
Definition at line 635 of file SGObject.cpp.
Checks the compatibility between two supplied features
l | left hand side features |
r | right hand side features |
Definition at line 80 of file Distance.cpp.
|
virtual |
|
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.
Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CDynamicObjectArray, CAlphabet, and CMKL.
Definition at line 734 of file SGObject.cpp.
|
protectedinherited |
Definition at line 759 of file SGObject.cpp.
|
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.
|
inherited |
compute row start offset for parallel kernel matrix computation
offs | offset |
n | number of columns |
symmetric | whether matrix is symmetric |
Definition at line 173 of file Distance.h.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 232 of file SGObject.cpp.
|
virtualinherited |
get distance function for lhs feature vector a and rhs feature vector b
idx_a | feature vector a at idx_a |
idx_b | feature vector b at idx_b |
Definition at line 185 of file Distance.cpp.
|
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
idx_a | feature vector a at idx_a |
idx_b | feature vector b at idx_b |
upper_bound | value above which the computation halts |
Reimplemented in CEuclideanDistance.
Definition at line 124 of file Distance.h.
|
protectedinherited |
matrix precomputation
Definition at line 233 of file Distance.cpp.
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.
other | object to compare with |
accuracy | accuracy to use for comparison (optional) |
tolerant | allows linient check on float equality (within accuracy) |
Definition at line 656 of file SGObject.cpp.
|
inherited |
Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.
_tag | name and type information of parameter |
Definition at line 381 of file SGObject.h.
|
inherited |
Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.
name | name of the parameter |
Definition at line 404 of file SGObject.h.
get distance matrix
Definition at line 156 of file Distance.h.
|
inherited |
get distance matrix (templated)
Definition at line 269 of file Distance.cpp.
|
virtual |
get distance type we are
Implements CDenseDistance< float64_t >.
Definition at line 66 of file CosineDistance.h.
|
virtualinherited |
get feature class the distance can deal with
Implements CDistance.
Definition at line 42 of file DenseDistance.h.
|
virtualinherited |
get feature type the DREAL distance can deal with
Implements CDistance.
Definition at line 28 of file DenseDistance.cpp.
|
virtualinherited |
get feature type the ULONG distance can deal with
Implements CDistance.
Definition at line 34 of file DenseDistance.cpp.
|
virtualinherited |
get feature type the INT distance can deal with
Implements CDistance.
Definition at line 40 of file DenseDistance.cpp.
|
virtualinherited |
get feature type the WORD distance can deal with
Implements CDistance.
Definition at line 46 of file DenseDistance.cpp.
|
virtualinherited |
get feature type the distance can deal with
Implements CDistance.
Reimplemented in CMahalanobisDistance, CAttenuatedEuclideanDistance, and CRealDistance.
|
virtualinherited |
get feature type the SHORT distance can deal with
Implements CDistance.
Definition at line 52 of file DenseDistance.cpp.
|
virtualinherited |
get feature type the BYTE distance can deal with
Implements CDistance.
Definition at line 58 of file DenseDistance.cpp.
|
virtualinherited |
get feature type the CHAR distance can deal with
Implements CDistance.
Definition at line 64 of file DenseDistance.cpp.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
get left-hand side features used in distance matrix
Definition at line 218 of file Distance.h.
|
inherited |
Definition at line 536 of file SGObject.cpp.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
param_name | name of the parameter |
Definition at line 560 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 573 of file SGObject.cpp.
|
virtual |
get name of the distance
Reimplemented from CDenseDistance< float64_t >.
Definition at line 72 of file CosineDistance.h.
|
virtualinherited |
get number of vectors of lhs features
Reimplemented in CCustomDistance.
Definition at line 306 of file Distance.h.
|
virtualinherited |
get number of vectors of rhs features
Reimplemented in CCustomDistance.
Definition at line 315 of file Distance.h.
|
inherited |
|
inherited |
FIXME: precompute matrix should be dropped, handling should be via customdistance
Definition at line 284 of file Distance.h.
|
inherited |
get right-hand side features used in distance matrix
Definition at line 224 of file Distance.h.
|
inherited |
Checks if object has a class parameter identified by a name.
name | name of the parameter |
Definition at line 304 of file SGObject.h.
|
inherited |
Checks if object has a class parameter identified by a Tag.
tag | tag of the parameter containing name and type information |
Definition at line 315 of file SGObject.h.
|
inherited |
Checks if a type exists for a class parameter identified by a name.
name | name of the parameter |
Definition at line 326 of file SGObject.h.
|
virtualinherited |
test whether features have been assigned to lhs and rhs
Reimplemented in CCustomDistance.
Definition at line 324 of file Distance.h.
init distance
l | features of left-hand side |
r | features of right-hand side |
Reimplemented from CDenseDistance< float64_t >.
Definition at line 35 of file CosineDistance.cpp.
|
virtualinherited |
If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.
generic | set to the type of the generic if returning TRUE |
Definition at line 330 of file SGObject.cpp.
|
inherited |
test whether features on lhs and rhs are the same
Definition at line 333 of file Distance.h.
|
inherited |
Print to stdout a list of observable parameters
Definition at line 878 of file SGObject.cpp.
|
inherited |
load the kernel matrix
loader | File object via which to load data |
Definition at line 111 of file Distance.cpp.
|
virtualinherited |
Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!
file | where to load from |
prefix | prefix for members |
Definition at line 403 of file SGObject.cpp.
|
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.
ShogunException | will be thrown if an error occurs. |
Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 460 of file SGObject.cpp.
|
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.
ShogunException | will 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 455 of file SGObject.cpp.
|
protectedinherited |
Observe a parameter value and emit them to observer.
value | Observed parameter's value |
Definition at line 828 of file SGObject.cpp.
|
virtualinherited |
Definition at line 296 of file SGObject.cpp.
|
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.
|
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.
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 512 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 342 of file SGObject.cpp.
|
inherited |
|
inherited |
|
protectedinherited |
Register which params this object can emit.
name | the param name |
type | the param type |
description | a user oriented description |
Definition at line 871 of file SGObject.cpp.
|
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.
_tag | name and type information of parameter |
value | value of the parameter |
Definition at line 472 of file SGObject.h.
|
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.
name | name of the parameter |
value | value of the parameter along with type information |
Definition at line 485 of file SGObject.h.
|
virtualinherited |
takes all necessary steps if the lhs is removed from distance matrix
Definition at line 134 of file Distance.cpp.
|
virtualinherited |
remove lhs and rhs from distance
Definition at line 123 of file Distance.cpp.
|
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 left-hand side features used in distance matrix
make sure to check that your distance can deal with the supplied features (!)
lhs | features of right-hand side |
Reimplemented in CEuclideanDistance.
Definition at line 167 of file Distance.cpp.
replace right-hand side features used in distance matrix
make sure to check that your distance can deal with the supplied features (!)
rhs | features of right-hand side |
Reimplemented in CEuclideanDistance.
Definition at line 149 of file Distance.cpp.
|
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.
|
inherited |
Function for computing distance values
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.
|
inherited |
Function for computing distance values
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.
|
staticprotectedinherited |
run distance thread
|
inherited |
save kernel matrix
writer | File object via which to save data |
Definition at line 117 of file Distance.cpp.
|
virtualinherited |
Save this object to file.
file | where to save the object; will be closed during returning if PREFIX is an empty string. |
prefix | prefix for members |
Definition at line 348 of file SGObject.cpp.
|
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.
ShogunException | will be thrown if an error occurs. |
Reimplemented in CKernel.
Definition at line 470 of file SGObject.cpp.
|
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.
ShogunException | will 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 465 of file SGObject.cpp.
|
inherited |
Setter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.
_tag | name and type information of parameter |
value | value of the parameter |
Definition at line 342 of file SGObject.h.
|
inherited |
Setter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.
name | name of the parameter |
value | value of the parameter along with type information |
Definition at line 368 of file SGObject.h.
|
inherited |
Definition at line 73 of file SGObject.cpp.
|
inherited |
Definition at line 78 of file SGObject.cpp.
|
inherited |
Definition at line 83 of file SGObject.cpp.
|
inherited |
Definition at line 88 of file SGObject.cpp.
|
inherited |
Definition at line 93 of file SGObject.cpp.
|
inherited |
Definition at line 98 of file SGObject.cpp.
|
inherited |
Definition at line 103 of file SGObject.cpp.
|
inherited |
Definition at line 108 of file SGObject.cpp.
|
inherited |
Definition at line 113 of file SGObject.cpp.
|
inherited |
Definition at line 118 of file SGObject.cpp.
|
inherited |
Definition at line 123 of file SGObject.cpp.
|
inherited |
Definition at line 128 of file SGObject.cpp.
|
inherited |
Definition at line 133 of file SGObject.cpp.
|
inherited |
Definition at line 138 of file SGObject.cpp.
|
inherited |
Definition at line 143 of file SGObject.cpp.
|
inherited |
set generic type to T
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 275 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 317 of file SGObject.cpp.
|
virtualinherited |
FIXME: precompute matrix should be dropped, handling should be via customdistance
flag | if precompute_matrix |
Definition at line 291 of file Distance.h.
|
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.
|
inherited |
Subscribe a parameter observer to watch over params
Definition at line 811 of file SGObject.cpp.
|
inherited |
decrement reference counter and deallocate object if refcount is zero before or after decrementing it
Definition at line 200 of file SGObject.cpp.
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 337 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 282 of file SGObject.cpp.
|
inherited |
io
Definition at line 600 of file SGObject.h.
|
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.
|
inherited |
Hash of parameter values
Definition at line 618 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 612 of file SGObject.h.
|
inherited |
parameters
Definition at line 609 of file SGObject.h.
|
protectedinherited |
number of feature vectors on the left hand side
Definition at line 402 of file Distance.h.
|
protectedinherited |
number of feature vectors on the right hand side
Definition at line 404 of file Distance.h.
|
inherited |
parallel
Definition at line 603 of file SGObject.h.
|
protectedinherited |
FIXME: precompute matrix should be dropped, handling should be via customdistance
Definition at line 394 of file Distance.h.
|
protectedinherited |
FIXME: precompute matrix should be dropped, handling should be via customdistance
Definition at line 389 of file Distance.h.
|
protectedinherited |
feature vectors to occur on the right hand side
Definition at line 399 of file Distance.h.
|
inherited |
version
Definition at line 606 of file SGObject.h.