SHOGUN  v3.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes
CManhattanWordDistance Class Reference

Detailed Description

class ManhattanWordDistance

Definition at line 23 of file ManhattanWordDistance.h.

Inheritance diagram for CManhattanWordDistance:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CManhattanWordDistance ()
 CManhattanWordDistance (CStringFeatures< uint16_t > *l, CStringFeatures< uint16_t > *r)
virtual ~CManhattanWordDistance ()
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 ()
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)
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 load (CFile *loader)
void save (CFile *writer)
CFeaturesget_lhs ()
CFeaturesget_rhs ()
CFeaturesreplace_rhs (CFeatures *rhs)
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
virtual void remove_rhs ()
 takes all necessary steps if the rhs is removed from distance matrix
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 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

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

Public Attributes

SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
Parameterm_gradient_parameters
ParameterMapm_parameter_map
uint32_t m_hash

Protected Member Functions

float64_t compute (int32_t idx_a, int32_t idx_b)
void do_precompute_matrix ()
 matrix precomputation
virtual TParametermigrate (DynArray< TParameter * > *param_base, const SGParamInfo *target)
virtual void one_to_one_migration_prepare (DynArray< TParameter * > *param_base, const SGParamInfo *target, TParameter *&replacement, TParameter *&to_migrate, char *old_name=NULL)
virtual void load_serializable_pre () throw (ShogunException)
virtual void load_serializable_post () throw (ShogunException)
virtual void save_serializable_pre () throw (ShogunException)
virtual void save_serializable_post () throw (ShogunException)

Static Protected Member Functions

static void * run_distance_thread (void *p)
 run distance thread

Protected Attributes

float32_tprecomputed_matrix
bool precompute_matrix
CFeatureslhs
 feature vectors to occur on the left hand side
CFeaturesrhs
 feature vectors to occur on the right hand side
int32_t num_lhs
int32_t num_rhs

Constructor & Destructor Documentation

default constructor

Definition at line 20 of file ManhattanWordDistance.cpp.

CManhattanWordDistance ( CStringFeatures< uint16_t > *  l,
CStringFeatures< uint16_t > *  r 
)

constructor

Parameters:
lfeatures of left-hand side
rfeatures of right-hand side

Definition at line 26 of file ManhattanWordDistance.cpp.

~CManhattanWordDistance ( ) [virtual]

Definition at line 35 of file ManhattanWordDistance.cpp.


Member Function Documentation

void build_gradient_parameter_dictionary ( CMap< TParameter *, CSGObject * > *  dict) [inherited]

Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.

Parameters:
dictdictionary of parameters to be built.

Definition at line 1156 of file SGObject.cpp.

void cleanup ( ) [virtual]

cleanup distance

Implements CStringDistance< uint16_t >.

Definition at line 46 of file ManhattanWordDistance.cpp.

CSGObject * clone ( ) [virtual, inherited]

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

float64_t compute ( int32_t  idx_a,
int32_t  idx_b 
) [protected, virtual]

compute distance function 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 50 of file ManhattanWordDistance.cpp.

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

compute row start offset for parallel kernel matrix computation

Parameters:
offsoffset
nnumber of columns
symmetricwhether matrix is symmetric

Definition at line 143 of file Distance.h.

virtual CSGObject* deep_copy ( ) const [virtual, inherited]

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

Definition at line 126 of file SGObject.h.

float64_t distance ( int32_t  idx_a,
int32_t  idx_b 
) [virtual, inherited]

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

Parameters:
idx_afeature vector a at idx_a
idx_bfeature vector b at idx_b
Returns:
distance value

Definition at line 189 of file Distance.cpp.

virtual float64_t distance_upper_bounded ( int32_t  idx_a,
int32_t  idx_b,
float64_t  upper_bound 
) [virtual, inherited]

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_afeature vector a at idx_a
idx_bfeature vector b at idx_b
upper_boundvalue above which the computation halts
Returns:
distance value or upper_bound

Reimplemented in CEuclideanDistance.

Definition at line 117 of file Distance.h.

void do_precompute_matrix ( ) [protected, inherited]

matrix precomputation

Definition at line 227 of file Distance.cpp.

bool equals ( CSGObject other,
float64_t  accuracy = 0.0 
) [virtual, inherited]

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

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 126 of file Distance.h.

SGMatrix<T> get_distance_matrix ( ) [inherited]

get distance matrix (templated)

Returns:
the distance matrix
template void * get_distance_matrix_helper< float32_t > ( void *  p) [static, inherited]

helper for computing the kernel matrix in a parallel way

Parameters:
pthread parameters

Definition at line 266 of file Distance.cpp.

virtual EDistanceType get_distance_type ( ) [virtual]

get distance type we are

Returns:
distance type MANHATTANWORD

Implements CStringDistance< uint16_t >.

Definition at line 52 of file ManhattanWordDistance.h.

virtual EFeatureClass get_feature_class ( ) [virtual, inherited]

get feature class the distance can deal with

Returns:
feature class STRING

Implements CDistance.

Definition at line 50 of file StringDistance.h.

virtual EFeatureType get_feature_type ( ) [virtual, inherited]

get feature type the distance can deal with

Returns:
template-specific feature type

Implements CDistance.

SGIO * get_global_io ( ) [inherited]

get the io object

Returns:
io object

Definition at line 174 of file SGObject.cpp.

Parallel * get_global_parallel ( ) [inherited]

get the parallel object

Returns:
parallel object

Definition at line 209 of file SGObject.cpp.

Version * get_global_version ( ) [inherited]

get the version object

Returns:
version object

Definition at line 222 of file SGObject.cpp.

CFeatures* get_lhs ( ) [inherited]

get left-hand side features used in distance matrix

Returns:
left-hand side features

Definition at line 194 of file Distance.h.

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

Definition at line 1060 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 1084 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 1097 of file SGObject.cpp.

virtual const char* get_name ( ) const [virtual]

get name of the distance

Returns:
name ManhattanWord

Reimplemented from CStringDistance< uint16_t >.

Definition at line 58 of file ManhattanWordDistance.h.

virtual int32_t get_num_vec_lhs ( ) [virtual, inherited]

get number of vectors of lhs features

Returns:
number of vectors of left-hand side

Reimplemented in CCustomDistance.

Definition at line 282 of file Distance.h.

virtual int32_t get_num_vec_rhs ( ) [virtual, inherited]

get number of vectors of rhs features

Returns:
number of vectors of right-hand side

Reimplemented in CCustomDistance.

Definition at line 291 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 260 of file Distance.h.

CFeatures* get_rhs ( ) [inherited]

get right-hand side features used in distance matrix

Returns:
right-hand side features

Definition at line 200 of file Distance.h.

virtual bool has_features ( ) [virtual, inherited]

test whether features have been assigned to lhs and rhs

Returns:
true if features are assigned

Reimplemented in CCustomDistance.

Definition at line 300 of file Distance.h.

bool init ( CFeatures l,
CFeatures r 
) [virtual]

init distance

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

Reimplemented from CStringDistance< uint16_t >.

Definition at line 40 of file ManhattanWordDistance.cpp.

bool is_generic ( EPrimitiveType *  generic) const [virtual, inherited]

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

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 309 of file Distance.h.

void load ( CFile loader) [inherited]

load the kernel matrix

Parameters:
loaderFile object via which to load data

Definition at line 107 of file Distance.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 633 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 474 of file SGObject.cpp.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
) [virtual, inherited]

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

void load_serializable_post ( ) throw (ShogunException) [protected, virtual, inherited]

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 in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.

Definition at line 989 of file SGObject.cpp.

void load_serializable_pre ( ) throw (ShogunException) [protected, virtual, inherited]

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 >, and CDynamicObjectArray.

Definition at line 984 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 671 of file SGObject.cpp.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo target 
) [protected, virtual, inherited]

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

void one_to_one_migration_prepare ( DynArray< TParameter * > *  param_base,
const SGParamInfo target,
TParameter *&  replacement,
TParameter *&  to_migrate,
char *  old_name = NULL 
) [protected, virtual, inherited]

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

void print_modsel_params ( ) [inherited]

prints all parameter registered for model selection and their type

Definition at line 1036 of file SGObject.cpp.

void print_serializable ( const char *  prefix = "") [virtual, inherited]

prints registered parameters out

Parameters:
prefixprefix for members

Definition at line 240 of file SGObject.cpp.

void remove_lhs ( ) [virtual, inherited]

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

Definition at line 130 of file Distance.cpp.

void remove_lhs_and_rhs ( ) [virtual, inherited]

remove lhs and rhs from distance

Definition at line 119 of file Distance.cpp.

void remove_rhs ( ) [virtual, inherited]

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 138 of file Distance.cpp.

CFeatures * replace_lhs ( CFeatures lhs) [inherited]

replace left-hand side features used in distance matrix

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

Parameters:
lhsfeatures of right-hand side
Returns:
replaced left-hand side features

Definition at line 167 of file Distance.cpp.

CFeatures * replace_rhs ( CFeatures rhs) [inherited]

replace right-hand side features used in distance matrix

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

Parameters:
rhsfeatures of right-hand side
Returns:
replaced right-hand side features

Definition at line 145 of file Distance.cpp.

static void* run_distance_thread ( void *  p) [static, protected, inherited]

run distance thread

void save ( CFile writer) [inherited]

save kernel matrix

Parameters:
writerFile object via which to save data

Definition at line 113 of file Distance.cpp.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
) [virtual, inherited]

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

void save_serializable_post ( ) throw (ShogunException) [protected, virtual, inherited]

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 in CKernel.

Definition at line 999 of file SGObject.cpp.

void save_serializable_pre ( ) throw (ShogunException) [protected, virtual, inherited]

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 in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 994 of file SGObject.cpp.

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

void set_global_parallel ( Parallel parallel) [inherited]

set the parallel object

Parameters:
parallelparallel object to use

Definition at line 180 of file SGObject.cpp.

void set_global_version ( Version version) [inherited]

set the version object

Parameters:
versionversion object to use

Definition at line 215 of file SGObject.cpp.

virtual void set_precompute_matrix ( bool  flag) [virtual, inherited]

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

Parameters:
flagif precompute_matrix

Definition at line 267 of file Distance.h.

virtual CSGObject* shallow_copy ( ) const [virtual, inherited]

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

Reimplemented in CGaussianKernel.

Definition at line 117 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 235 of file SGObject.cpp.

bool update_parameter_hash ( ) [virtual, inherited]

Updates the hash of current parameter combination.

Returns:
bool if parameter combination has changed since last update.

Definition at line 187 of file SGObject.cpp.


Member Data Documentation

SGIO* io [inherited]

io

Definition at line 473 of file SGObject.h.

CFeatures* lhs [protected, inherited]

feature vectors to occur on the left hand side

Definition at line 342 of file Distance.h.

parameters wrt which we can compute gradients

Definition at line 488 of file SGObject.h.

uint32_t m_hash [inherited]

Hash of parameter values

Definition at line 494 of file SGObject.h.

model selection parameters

Definition at line 485 of file SGObject.h.

map for different parameter versions

Definition at line 491 of file SGObject.h.

Parameter* m_parameters [inherited]

parameters

Definition at line 482 of file SGObject.h.

int32_t num_lhs [protected, inherited]

number of feature vectors on the left hand side

Definition at line 347 of file Distance.h.

int32_t num_rhs [protected, inherited]

number of feature vectors on the right hand side

Definition at line 349 of file Distance.h.

Parallel* parallel [inherited]

parallel

Definition at line 476 of file SGObject.h.

bool precompute_matrix [protected, inherited]

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

Definition at line 339 of file Distance.h.

float32_t* precomputed_matrix [protected, inherited]

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

Definition at line 334 of file Distance.h.

CFeatures* rhs [protected, inherited]

feature vectors to occur on the right hand side

Definition at line 344 of file Distance.h.

Version* version [inherited]

version

Definition at line 479 of file SGObject.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

SHOGUN Machine Learning Toolbox - Documentation