class RealDistance
Definition at line 22 of file RealDistance.h.
|
| CRealDistance () |
|
virtual bool | init (CFeatures *l, CFeatures *r) |
|
virtual EFeatureType | get_feature_type () |
|
virtual const char * | get_name () const |
|
virtual void | cleanup ()=0 |
|
virtual EDistanceType | get_distance_type ()=0 |
|
virtual EFeatureClass | get_feature_class () |
|
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 () |
|
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 |
|
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 () |
|
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 630 of file SGObject.cpp.
|
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 101 of file Distance.cpp.
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 747 of file SGObject.cpp.
virtual float64_t compute |
( |
int32_t |
x, |
|
|
int32_t |
y |
|
) |
| |
|
protectedpure virtual |
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.
A deep copy. All the instance variables will also be copied.
Definition at line 231 of file SGObject.cpp.
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 206 of file Distance.cpp.
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.
void do_precompute_matrix |
( |
| ) |
|
|
protectedinherited |
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 651 of file SGObject.cpp.
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 367 of file SGObject.h.
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 388 of file SGObject.h.
get distance matrix
- Returns
- computed distance matrix (needs to be cleaned up)
Definition at line 156 of file Distance.h.
get distance matrix (templated)
- Returns
- the distance matrix
Definition at line 334 of file Distance.cpp.
template void * get_distance_matrix_helper< float32_t > |
( |
void * |
p | ) |
|
|
staticinherited |
helper for computing the kernel matrix in a parallel way
- Parameters
-
Definition at line 283 of file Distance.cpp.
get feature class the distance can deal with
- Returns
- feature class DENSE
Implements CDistance.
Definition at line 42 of file DenseDistance.h.
get the io object
- Returns
- io object
Definition at line 268 of file SGObject.cpp.
get the parallel object
- Returns
- parallel object
Definition at line 310 of file SGObject.cpp.
get the version object
- Returns
- version object
Definition at line 323 of file SGObject.cpp.
get left-hand side features used in distance matrix
- Returns
- left-hand side features
Definition at line 224 of file Distance.h.
- Returns
- vector of names of all parameters which are registered for model selection
Definition at line 531 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_name | name of the parameter |
- Returns
- description of the parameter
Definition at line 555 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_name | name of model selection parameter |
- Returns
- index of model selection parameter with provided name, -1 if there is no such
Definition at line 568 of file SGObject.cpp.
virtual const char* get_name |
( |
| ) |
const |
|
virtual |
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 312 of file Distance.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 CCustomDistance.
Definition at line 321 of file Distance.h.
bool get_precompute_matrix |
( |
| ) |
|
|
inherited |
FIXME: precompute matrix should be dropped, handling should be via customdistance
- Returns
- if precompute_matrix
Definition at line 290 of file Distance.h.
get right-hand side features used in distance matrix
- Returns
- right-hand side features
Definition at line 230 of file Distance.h.
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 289 of file SGObject.h.
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 301 of file SGObject.h.
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 312 of file SGObject.h.
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 330 of file Distance.h.
bool is_generic |
( |
EPrimitiveType * |
generic | ) |
const |
|
virtualinherited |
If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.
- Parameters
-
generic | set to the type of the generic if returning TRUE |
- Returns
- TRUE if a class template.
Definition at line 329 of file SGObject.cpp.
test whether features on lhs and rhs are the same
- Returns
- true if features are the same
Definition at line 339 of file Distance.h.
void load |
( |
CFile * |
loader | ) |
|
|
inherited |
load the kernel matrix
- Parameters
-
loader | File object via which to load data |
Definition at line 132 of file Distance.cpp.
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 402 of file SGObject.cpp.
|
protectedvirtualinherited |
|
protectedvirtualinherited |
bool parameter_hash_changed |
( |
| ) |
|
|
virtualinherited |
- Returns
- whether parameter combination has changed since last update
Definition at line 295 of file SGObject.cpp.
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.
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.
void print_modsel_params |
( |
| ) |
|
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 507 of file SGObject.cpp.
void print_serializable |
( |
const char * |
prefix = "" | ) |
|
|
virtualinherited |
prints registered parameters out
- Parameters
-
Definition at line 341 of file SGObject.cpp.
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 439 of file SGObject.h.
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 452 of file SGObject.h.
takes all necessary steps if the lhs is removed from distance matrix
Definition at line 155 of file Distance.cpp.
void remove_lhs_and_rhs |
( |
| ) |
|
|
virtualinherited |
remove lhs and rhs from distance
Definition at line 144 of file Distance.cpp.
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 163 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 (!)
- Parameters
-
lhs | features of right-hand side |
- Returns
- replaced left-hand side features
Reimplemented in CEuclideanDistance.
Definition at line 188 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 (!)
- Parameters
-
rhs | features of right-hand side |
- Returns
- replaced right-hand side features
Reimplemented in CEuclideanDistance.
Definition at line 170 of file Distance.cpp.
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.
static void* run_distance_thread |
( |
void * |
p | ) |
|
|
staticprotectedinherited |
void save |
( |
CFile * |
writer | ) |
|
|
inherited |
save kernel matrix
- Parameters
-
writer | File object via which to save data |
Definition at line 138 of file Distance.cpp.
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 347 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.
- Exceptions
-
Reimplemented in CKernel.
Definition at line 469 of file SGObject.cpp.
|
protectedvirtualinherited |
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 328 of file SGObject.h.
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 354 of file SGObject.h.
void set_global_io |
( |
SGIO * |
io | ) |
|
|
inherited |
void set_global_parallel |
( |
Parallel * |
parallel | ) |
|
|
inherited |
set the parallel object
- Parameters
-
parallel | parallel object to use |
Definition at line 274 of file SGObject.cpp.
void set_global_version |
( |
Version * |
version | ) |
|
|
inherited |
set the version object
- Parameters
-
version | version object to use |
Definition at line 316 of file SGObject.cpp.
virtual void set_precompute_matrix |
( |
bool |
flag | ) |
|
|
virtualinherited |
FIXME: precompute matrix should be dropped, handling should be via customdistance
- Parameters
-
Definition at line 297 of file Distance.h.
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 225 of file SGObject.cpp.
unset generic type
this has to be called in classes specializing a template class
Definition at line 336 of file SGObject.cpp.
void update_parameter_hash |
( |
| ) |
|
|
virtualinherited |
Updates the hash of current parameter combination
Definition at line 281 of file SGObject.cpp.
feature vectors to occur on the left hand side
Definition at line 381 of file Distance.h.
parameters wrt which we can compute gradients
Definition at line 552 of file SGObject.h.
Hash of parameter values
Definition at line 555 of file SGObject.h.
model selection parameters
Definition at line 549 of file SGObject.h.
number of feature vectors on the left hand side
Definition at line 386 of file Distance.h.
number of feature vectors on the right hand side
Definition at line 388 of file Distance.h.
FIXME: precompute matrix should be dropped, handling should be via customdistance
Definition at line 378 of file Distance.h.
FIXME: precompute matrix should be dropped, handling should be via customdistance
Definition at line 373 of file Distance.h.
feature vectors to occur on the right hand side
Definition at line 383 of file Distance.h.
The documentation for this class was generated from the following file: