SHOGUN  3.2.1
 全部  命名空间 文件 函数 变量 类型定义 枚举 枚举值 友元 宏定义  
所有成员列表 | Public 成员函数 | Public 属性 | Protected 成员函数 | Protected 属性
CStochasticProximityEmbedding类 参考

详细描述

class StochasticProximityEmbedding used to construct embeddings of data using the Stochastic Proximity algorithm.

Agrafiotis, D. K. (2002) Stochastic Proximity Embedding Retrieved from: http://www.dimitris-agrafiotis.com/Papers/jcc20078.pdf

This class provides two different strategies for the computation of the embedding. In each iteration, both strategies choose two sets of feature vectors whose representation in the embedded space is updated. The first set is randomly chosen in both strategies. However, the second set is obtained differently depending on the strategy used. In the SPE_GLOBAL strategy, the second set is still chosen at random. On the other hand, if SPE_LOCAL is used, first of all, the K-Nearest Neighbors of each of the feature vectors in the first set is obtained and secondly, a number of feature vectors among these K-Nearest Neighbors is chosen to form the second set.

The parameter K for K-Nearest Neighbors in SPE_LOCAL corresponds to the class member "m_k". Each of the two sets used on every iteration is formed by "m_nupdates" feature vectors. Therefore, the number of feature vectors given must be always at least two times the value of "m_nupdates".

In order to avoid problems with memory in case a large number of features vectors is to be embedded, the distance matrix is never computed explicitily. This has the drawback that it is likely that the same distances are computed several times during the process.

Uses implementation from the Tapkee library.

Only CEuclideanDistance distance is supported for the moment.

在文件 StochasticProximityEmbedding.h63 行定义.

类 CStochasticProximityEmbedding 继承关系图:
Inheritance graph
[图例]

Public 成员函数

 CStochasticProximityEmbedding ()
 
virtual ~CStochasticProximityEmbedding ()
 
virtual CFeaturesapply (CFeatures *features)
 
void set_k (int32_t k)
 
int32_t get_k () const
 
void set_strategy (ESPEStrategy strategy)
 
ESPEStrategy get_strategy () const
 
void set_tolerance (float32_t tolerance)
 
int32_t get_tolerance () const
 
void set_nupdates (int32_t nupdates)
 
int32_t get_nupdates () const
 
void set_max_iteration (const int32_t max_iteration)
 
int32_t get_max_iteration () const
 
virtual const char * get_name () const
 
virtual CDenseFeatures
< float64_t > * 
embed (CFeatures *features)
 
void set_target_dim (int32_t dim)
 
int32_t get_target_dim () const
 
void set_distance (CDistance *distance)
 
CDistanceget_distance () const
 
void set_kernel (CKernel *kernel)
 
CKernelget_kernel () const
 
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="", 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 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 属性

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_gradient_parameters
 
ParameterMapm_parameter_map
 
uint32_t m_hash
 

Protected 成员函数

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)
 

Protected 属性

int32_t m_target_dim
 
CDistancem_distance
 
CKernelm_kernel
 

构造及析构函数说明

constructor

在文件 StochasticProximityEmbedding.cpp19 行定义.

destructor

在文件 StochasticProximityEmbedding.cpp43 行定义.

成员函数说明

CFeatures * apply ( CFeatures features)
virtual

apply to features

参数
featuresfeatures to embed
返回
embedding features

实现了 CEmbeddingConverter.

在文件 StochasticProximityEmbedding.cpp112 行定义.

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.

参数
dictdictionary of parameters to be built.

在文件 SGObject.cpp1174 行定义.

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.

返回
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

在文件 SGObject.cpp1291 行定义.

virtual CSGObject* deep_copy ( ) const
virtualinherited

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

在文件 SGObject.h126 行定义.

CDenseFeatures< float64_t > * embed ( CFeatures features)
virtualinherited

embed given features, acts the same as apply, but returns DenseFeatures

参数
featuresfeatures to embed
返回
embedding simple features

在文件 EmbeddingConverter.cpp35 行定义.

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.

参数
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
返回
true if all parameters were equal, false if not

在文件 SGObject.cpp1195 行定义.

CDistance * get_distance ( ) const
inherited

getter for distance

返回
distance

在文件 EmbeddingConverter.cpp58 行定义.

SGIO * get_global_io ( )
inherited

get the io object

返回
io object

在文件 SGObject.cpp174 行定义.

Parallel * get_global_parallel ( )
inherited

get the parallel object

返回
parallel object

在文件 SGObject.cpp215 行定义.

Version * get_global_version ( )
inherited

get the version object

返回
version object

在文件 SGObject.cpp228 行定义.

int32_t get_k ( ) const

getter for number of neighbors k in local strategy

返回
k value

在文件 StochasticProximityEmbedding.cpp55 行定义.

CKernel * get_kernel ( ) const
inherited

getter for kernel

返回
kernel

在文件 EmbeddingConverter.cpp71 行定义.

int32_t get_max_iteration ( ) const

getter for the maximum number of iterations

返回
the maximum number of iterations

在文件 StochasticProximityEmbedding.cpp102 行定义.

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

在文件 SGObject.cpp1066 行定义.

char * get_modsel_param_descr ( const char *  param_name)
inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

参数
param_namename of the parameter
返回
description of the parameter

在文件 SGObject.cpp1090 行定义.

index_t get_modsel_param_index ( const char *  param_name)
inherited

Returns index of model selection parameter with provided index

参数
param_namename of model selection parameter
返回
index of model selection parameter with provided name, -1 if there is no such

在文件 SGObject.cpp1103 行定义.

const char * get_name ( ) const
virtual

get name

重载 CEmbeddingConverter .

在文件 StochasticProximityEmbedding.cpp107 行定义.

int32_t get_nupdates ( ) const

getter for number of updates per iteration

返回
nupdates value

在文件 StochasticProximityEmbedding.cpp92 行定义.

ESPEStrategy get_strategy ( ) const

getter for type of SPE strategy

返回
strategy value

在文件 StochasticProximityEmbedding.cpp65 行定义.

int32_t get_target_dim ( ) const
inherited

getter for target dimension

返回
target dimension

在文件 EmbeddingConverter.cpp46 行定义.

int32_t get_tolerance ( ) const

getter for regularization parameter

返回
regularization value

在文件 StochasticProximityEmbedding.cpp79 行定义.

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.

参数
genericset to the type of the generic if returning TRUE
返回
TRUE if a class template.

在文件 SGObject.cpp234 行定义.

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)

参数
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
返回
(sorted) array of created TParameter instances with file data

在文件 SGObject.cpp639 行定义.

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

参数
param_infoinformation of parameter
file_versionparameter version of the file, must be <= provided parameter version
filefile to load from
prefixprefix for members
返回
new array with TParameter instances with the attached data

在文件 SGObject.cpp480 行定义.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
virtualinherited

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

参数
filewhere to load from
prefixprefix for members
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp311 行定义.

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.

异常
ShogunExceptionWill be thrown if an error occurres.

CWeightedDegreePositionStringKernel, CKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.

在文件 SGObject.cpp995 行定义.

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.

异常
ShogunExceptionWill be thrown if an error occurres.

CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp990 行定义.

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

参数
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

在文件 SGObject.cpp677 行定义.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo target 
)
protectedvirtualinherited

creates a new TParameter instance, which contains migrated data from the version that is provided. The provided parameter data base is used for migration, this base is a collection of all parameter data of the previous version. Migration is done FROM the data in param_base TO the provided param info Migration is always one version step. Method has to be implemented in subclasses, if no match is found, base method has to be called.

If there is an element in the param_base which equals the target, a copy of the element is returned. This represents the case when nothing has changed and therefore, the migrate method is not overloaded in a subclass

参数
param_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
返回
a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

在文件 SGObject.cpp884 行定义.

void one_to_one_migration_prepare ( DynArray< TParameter * > *  param_base,
const SGParamInfo target,
TParameter *&  replacement,
TParameter *&  to_migrate,
char *  old_name = NULL 
)
protectedvirtualinherited

This method prepares everything for a one-to-one parameter migration. One to one here means that only ONE element of the parameter base is needed for the migration (the one with the same name as the target). Data is allocated for the target (in the type as provided in the target SGParamInfo), and a corresponding new TParameter instance is written to replacement. The to_migrate pointer points to the single needed TParameter instance needed for migration. If a name change happened, the old name may be specified by old_name. In addition, the m_delete_data flag of to_migrate is set to true. So if you want to migrate data, the only thing to do after this call is converting the data in the m_parameter fields. If unsure how to use - have a look into an example for this. (base_migration_type_conversion.cpp for example)

参数
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

在文件 SGObject.cpp824 行定义.

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

在文件 SGObject.cpp200 行定义.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp1042 行定义.

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

prints registered parameters out

参数
prefixprefix for members

在文件 SGObject.cpp246 行定义.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
virtualinherited

Save this object to file.

参数
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)
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp252 行定义.

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.

异常
ShogunExceptionWill be thrown if an error occurres.

CKernel 重载.

在文件 SGObject.cpp1005 行定义.

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.

异常
ShogunExceptionWill be thrown if an error occurres.

CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp1000 行定义.

void set_distance ( CDistance distance)
inherited

setter for distance

参数
distancedistance to set

在文件 EmbeddingConverter.cpp51 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp41 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp46 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp51 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp56 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp61 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp66 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp71 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp76 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp81 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp86 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp91 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp96 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp101 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp106 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp111 行定义.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO io)
inherited

set the io object

参数
ioio object to use

在文件 SGObject.cpp167 行定义.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

参数
parallelparallel object to use

在文件 SGObject.cpp180 行定义.

void set_global_version ( Version version)
inherited

set the version object

参数
versionversion object to use

在文件 SGObject.cpp221 行定义.

void set_k ( int32_t  k)

setter for number of neighbors k in local strategy

参数
kk value

在文件 StochasticProximityEmbedding.cpp47 行定义.

void set_kernel ( CKernel kernel)
inherited

setter for kernel

参数
kernelkernel to set

在文件 EmbeddingConverter.cpp64 行定义.

void set_max_iteration ( const int32_t  max_iteration)

setter for the maximum number of iterations

参数
max_iterationthe maximum number of iterations

在文件 StochasticProximityEmbedding.cpp97 行定义.

void set_nupdates ( int32_t  nupdates)

setter for number of updates per iteration

参数
nupdatesnumber of updates per SPE iteration

在文件 StochasticProximityEmbedding.cpp84 行定义.

void set_strategy ( ESPEStrategy  strategy)

setter for strategy parameter

参数
strategytype of SPE strategy

在文件 StochasticProximityEmbedding.cpp60 行定义.

void set_target_dim ( int32_t  dim)
inherited

setter for target dimension

参数
dimtarget dimension

在文件 EmbeddingConverter.cpp40 行定义.

void set_tolerance ( float32_t  tolerance)

setter for regularization parameter

参数
toleranceregularization value

在文件 StochasticProximityEmbedding.cpp70 行定义.

virtual CSGObject* shallow_copy ( ) const
virtualinherited

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

CGaussianKernel 重载.

在文件 SGObject.h117 行定义.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp241 行定义.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp187 行定义.

类成员变量说明

SGIO* io
inherited

io

在文件 SGObject.h473 行定义.

CDistance* m_distance
protectedinherited

distance to be used

在文件 EmbeddingConverter.h97 行定义.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

在文件 SGObject.h488 行定义.

uint32_t m_hash
inherited

Hash of parameter values

在文件 SGObject.h494 行定义.

CKernel* m_kernel
protectedinherited

kernel to be used

在文件 EmbeddingConverter.h100 行定义.

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h485 行定义.

ParameterMap* m_parameter_map
inherited

map for different parameter versions

在文件 SGObject.h491 行定义.

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h482 行定义.

int32_t m_target_dim
protectedinherited

target dim of dimensionality reduction preprocessor

在文件 EmbeddingConverter.h94 行定义.

Parallel* parallel
inherited

parallel

在文件 SGObject.h476 行定义.

Version* version
inherited

version

在文件 SGObject.h479 行定义.


该类的文档由以下文件生成:

SHOGUN 机器学习工具包 - 项目文档