SHOGUN  4.1.0
所有成员列表 | Public 成员函数 | Public 属性 | Protected 成员函数 | Protected 属性
CRandomFourierGaussPreproc类 参考

详细描述

Preprocessor CRandomFourierGaussPreproc implements Random Fourier Features for the Gauss kernel a la Ali Rahimi and Ben Recht Nips2007 after preprocessing the features using them in a linear kernel approximates a gaussian kernel.

approximation quality depends on dimension of feature space, NOT on number of data.

effectively it requires two parameters for initialization: (A) the dimension of the input features stored in dim_input_space (B) the dimension of the output feature space

in order to make it work there are two ways: (1) if you have already previously computed random fourier features which you want to use together with newly computed ones, then you have to take the random coefficients from the previous computation and provide them via void set_randomcoefficients(...) for the new computation this case is important for example if you compute separately features on training and testing data in two feature objects

in this case you have to set 1a) void set_randomcoefficients(...)

(2) if you compute random fourier features from scratch in this case you have to set 2a) set_kernelwidth(...) 2b) void set_dim_feature_space(const int32_t dim); 2c) set_dim_input_space(const int32_t dim); 2d) init_randomcoefficients() or apply_to_feature_matrix(...)

在文件 RandomFourierGaussPreproc.h 第 48 行定义.

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

Public 成员函数

 CRandomFourierGaussPreproc ()
 
 CRandomFourierGaussPreproc (const CRandomFourierGaussPreproc &pr)
 
 ~CRandomFourierGaussPreproc ()
 
virtual SGMatrix< float64_t > apply_to_feature_matrix (CFeatures *features)
 
virtual SGVector< float64_t > apply_to_feature_vector (SGVector< float64_t > vector)
 
virtual EFeatureType get_feature_type ()
 
virtual EFeatureClass get_feature_class ()
 
virtual bool init (CFeatures *f)
 
void set_kernelwidth (const float64_t width)
 
float64_t get_kernelwidth () const
 
void get_randomcoefficients (float64_t **randomcoeff_additive2, float64_t **randomcoeff_multiplicative2, int32_t *dim_feature_space2, int32_t *dim_input_space2, float64_t *kernelwidth2) const
 
void set_randomcoefficients (float64_t *randomcoeff_additive2, float64_t *randomcoeff_multiplicative2, const int32_t dim_feature_space2, const int32_t dim_input_space2, const float64_t kernelwidth2)
 
void set_dim_input_space (const int32_t dim)
 
void set_dim_feature_space (const int32_t dim)
 
bool init_randomcoefficients ()
 
int32_t get_dim_input_space () const
 
int32_t get_dim_feature_space () const
 
void cleanup ()
 
virtual const char * get_name () const
 return the name of the preprocessor 更多...
 
virtual EPreprocessorType get_type () const
 return a type of preprocessor 更多...
 
virtual CFeatures * apply (CFeatures *features)
 
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)
 
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 属性

SGIO * io
 
Parallel * parallel
 
Version * version
 
Parameter * m_parameters
 
Parameter * m_model_selection_parameters
 
Parameter * m_gradient_parameters
 
uint32_t m_hash
 

Protected 成员函数

void copy (const CRandomFourierGaussPreproc &feats)
 
bool test_rfinited () const
 
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 属性

float64_t kernelwidth
 
float64_t cur_kernelwidth
 
int32_t dim_input_space
 
int32_t cur_dim_input_space
 
int32_t dim_feature_space
 
int32_t cur_dim_feature_space
 
float64_t * randomcoeff_additive
 
float64_t * randomcoeff_multiplicative
 

构造及析构函数说明

CRandomFourierGaussPreproc ( )

default constructor

在文件 RandomFourierGaussPreproc.cpp 第 65 行定义.

CRandomFourierGaussPreproc ( const CRandomFourierGaussPreproc &  pr)

alternative constructor

在文件 RandomFourierGaussPreproc.cpp 第 100 行定义.

~CRandomFourierGaussPreproc ( )

default destructor takes care for float64_t* randomcoeff_additive,float64_t* randomcoeff_multiplicative;

在文件 RandomFourierGaussPreproc.cpp 第 130 行定义.

成员函数说明

virtual CFeatures* apply ( CFeatures *  features)
virtualinherited

generic interface for applying the preprocessor. used as a wrapper for apply_to_feature_matrix() method

参数
featuresthe dense input features
返回
the result feature object after applying the preprocessor

实现了 CPreprocessor.

SGMatrix< float64_t > apply_to_feature_matrix ( CFeatures *  features)
virtual

default processing routine, inherited from base class

参数
featuresthe features to be processed, must be of type CDenseFeatures<float64_t>
返回
the processed feature matrix from the CDenseFeatures<float64_t> class in case (2) (see description above) this routine requires only steps 2a) and 2b), the rest is determined automatically

实现了 CDensePreprocessor< float64_t >.

在文件 RandomFourierGaussPreproc.cpp 第 371 行定义.

SGVector< float64_t > apply_to_feature_vector ( SGVector< float64_t >  vector)
virtual

alternative processing routine, inherited from base class

参数
vectorthe feature vector to be processed
返回
processed feature vector in order to work this routine requires the steps described above under cases (1) or two (2) before calling this routine

实现了 CDensePreprocessor< float64_t >.

在文件 RandomFourierGaussPreproc.cpp 第 353 行定义.

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.cpp 第 597 行定义.

void cleanup ( )
virtual

inherited from base class does nothing

实现了 CPreprocessor.

在文件 RandomFourierGaussPreproc.cpp 第 414 行定义.

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.cpp 第 714 行定义.

void copy ( const CRandomFourierGaussPreproc &  feats)
protected

helper for copy constructor and assignment operator=

在文件 RandomFourierGaussPreproc.cpp 第 20 行定义.

CSGObject * deep_copy ( ) const
virtualinherited

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

在文件 SGObject.cpp 第 198 行定义.

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.cpp 第 618 行定义.

int32_t get_dim_feature_space ( ) const

a getter

返回
the set value of protected member dim_feature_space

在文件 RandomFourierGaussPreproc.cpp 第 145 行定义.

int32_t get_dim_input_space ( ) const

a getter

返回
the set value of protected member dim_input_space

在文件 RandomFourierGaussPreproc.cpp 第 159 行定义.

EFeatureClass get_feature_class ( )
virtual

inherited from base class

返回
F_DREAL

重载 CDensePreprocessor< float64_t > .

在文件 RandomFourierGaussPreproc.cpp 第 137 行定义.

EFeatureType get_feature_type ( )
virtual

inherited from base class

返回
C_DENSE

重载 CDensePreprocessor< float64_t > .

在文件 RandomFourierGaussPreproc.cpp 第 141 行定义.

SGIO * get_global_io ( )
inherited

get the io object

返回
io object

在文件 SGObject.cpp 第 235 行定义.

Parallel * get_global_parallel ( )
inherited

get the parallel object

返回
parallel object

在文件 SGObject.cpp 第 277 行定义.

Version * get_global_version ( )
inherited

get the version object

返回
version object

在文件 SGObject.cpp 第 290 行定义.

float64_t get_kernelwidth ( ) const

getter for kernel width

返回
kernel width throws exception if kernelwidth <=0

在文件 RandomFourierGaussPreproc.cpp 第 171 行定义.

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

在文件 SGObject.cpp 第 498 行定义.

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.cpp 第 522 行定义.

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.cpp 第 535 行定义.

virtual const char* get_name ( ) const
virtual

return the name of the preprocessor

实现了 CSGObject.

在文件 RandomFourierGaussPreproc.h 第 168 行定义.

void get_randomcoefficients ( float64_t **  randomcoeff_additive2,
float64_t **  randomcoeff_multiplicative2,
int32_t *  dim_feature_space2,
int32_t *  dim_input_space2,
float64_t *  kernelwidth2 
) const

getter for the random coefficients necessary for creating random fourier features compatible to the current ones returns values of internal members randomcoeff_additive and randomcoeff_multiplicative

在文件 RandomFourierGaussPreproc.cpp 第 259 行定义.

virtual EPreprocessorType get_type ( ) const
virtual

return a type of preprocessor

重载 CDensePreprocessor< float64_t > .

在文件 RandomFourierGaussPreproc.h 第 171 行定义.

bool init ( CFeatures *  f)
virtual

initializer routine calls set_dim_input_space(const int32_t dim); with the proper value calls init_randomcoefficients(); this call does NOT override a previous call to void set_randomcoefficients(...) IF and ONLY IF the dimensions of input AND feature space are equal to the values from the previous call to void set_randomcoefficients(...)

参数
fthe features to be processed, must be of type CDenseFeatures<float64_t>
返回
true if new random coefficients were generated, false if old ones from a call to set_randomcoefficients(...) are kept

实现了 CPreprocessor.

在文件 RandomFourierGaussPreproc.cpp 第 321 行定义.

bool init_randomcoefficients ( )

computes new random coefficients IF test_rfinited() evaluates to false test_rfinited() evaluates to TRUE if void set_randomcoefficients(...) hase been called and the values set by set_dim_input_space(...) , set_dim_feature_space(...) and set_kernelwidth(...) are consistent to the call of void set_randomcoefficients(...)

throws shogun exception if dim_feature_space <= 0 or dim_input_space <= 0

返回
returns true if test_rfinited() evaluates to false and new coefficients are computed returns false if test_rfinited() evaluates to true and old random coefficients are kept which were set by a previous call to void set_randomcoefficients(...)

this function is useful if you want to use apply_to_feature_vector but cannot call before it init(CFeatures *f)

在文件 RandomFourierGaussPreproc.cpp 第 201 行定义.

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.cpp 第 296 行定义.

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

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

参数
filewhere to load from
prefixprefix for members
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 369 行定义.

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

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

在文件 SGObject.cpp 第 426 行定义.

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

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

在文件 SGObject.cpp 第 421 行定义.

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

在文件 SGObject.cpp 第 262 行定义.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp 第 474 行定义.

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

prints registered parameters out

参数
prefixprefix for members

在文件 SGObject.cpp 第 308 行定义.

bool save_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
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
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 314 行定义.

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

被 CKernel 重载.

在文件 SGObject.cpp 第 436 行定义.

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

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

在文件 SGObject.cpp 第 431 行定义.

void set_dim_feature_space ( const int32_t  dim)

a setter

参数
dimthe value of protected member dim_feature_space throws a shogun exception if dim<=0

在文件 RandomFourierGaussPreproc.cpp 第 149 行定义.

void set_dim_input_space ( const int32_t  dim)

a setter

参数
dimthe value of protected member dim_input_space throws a shogun exception if dim<=0

在文件 RandomFourierGaussPreproc.cpp 第 175 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 41 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 46 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 51 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 56 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 61 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 66 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 71 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 76 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 81 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 86 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 91 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 96 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 101 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 106 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 111 行定义.

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.cpp 第 228 行定义.

void set_global_parallel ( Parallel *  parallel)
inherited

set the parallel object

参数
parallelparallel object to use

在文件 SGObject.cpp 第 241 行定义.

void set_global_version ( Version *  version)
inherited

set the version object

参数
versionversion object to use

在文件 SGObject.cpp 第 283 行定义.

void set_kernelwidth ( const float64_t  width)

setter for kernel width

参数
widthkernel width to be set

在文件 RandomFourierGaussPreproc.cpp 第 163 行定义.

void set_randomcoefficients ( float64_t *  randomcoeff_additive2,
float64_t *  randomcoeff_multiplicative2,
const int32_t  dim_feature_space2,
const int32_t  dim_input_space2,
const float64_t  kernelwidth2 
)

setter for the random coefficients necessary for creating random fourier features compatible to the previous ones sets values of internal members randomcoeff_additive and randomcoeff_multiplicative simply use as input what you got from get_random_coefficients(...)

在文件 RandomFourierGaussPreproc.cpp 第 291 行定义.

CSGObject * shallow_copy ( ) const
virtualinherited

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

被 CGaussianKernel 重载.

在文件 SGObject.cpp 第 192 行定义.

bool test_rfinited ( ) const
protected

tests whether rf features have already been initialized

在文件 RandomFourierGaussPreproc.cpp 第 185 行定义.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp 第 303 行定义.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp 第 248 行定义.

类成员变量说明

int32_t cur_dim_feature_space
protected

actual dimension of output features as set by bool init_randomcoefficients() or void set_randomcoefficients

在文件 RandomFourierGaussPreproc.h 第 210 行定义.

int32_t cur_dim_input_space
protected

actual dimension of input features as set by bool init_randomcoefficients() or void set_randomcoefficients

在文件 RandomFourierGaussPreproc.h 第 199 行定义.

float64_t cur_kernelwidth
protected

dimension of input features width of gaussian kernel in the form of exp(-x^2 / (2.0 kernelwidth^2) ) NOTE the 2.0 and the power ^2 !

在文件 RandomFourierGaussPreproc.h 第 189 行定义.

int32_t dim_feature_space
protected

desired dimension of output features as set by void set_dim_feature_space(const int32_t dim)

在文件 RandomFourierGaussPreproc.h 第 205 行定义.

int32_t dim_input_space
protected

desired dimension of input features as set by void set_dim_input_space(const int32_t dim)

在文件 RandomFourierGaussPreproc.h 第 194 行定义.

SGIO* io
inherited

io

在文件 SGObject.h 第 369 行定义.

float64_t kernelwidth
protected

dimension of input features width of gaussian kernel in the form of exp(-x^2 / (2.0 kernelwidth^2) ) NOTE the 2.0 and the power ^2 !

在文件 RandomFourierGaussPreproc.h 第 184 行定义.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

在文件 SGObject.h 第 384 行定义.

uint32_t m_hash
inherited

Hash of parameter values

在文件 SGObject.h 第 387 行定义.

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h 第 381 行定义.

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h 第 378 行定义.

Parallel* parallel
inherited

parallel

在文件 SGObject.h 第 372 行定义.

float64_t* randomcoeff_additive
protected

random coefficient length = cur_dim_feature_space

在文件 RandomFourierGaussPreproc.h 第 221 行定义.

float64_t* randomcoeff_multiplicative
protected

random coefficient length = cur_dim_feature_space* cur_dim_input_space

在文件 RandomFourierGaussPreproc.h 第 227 行定义.

Version* version
inherited

version

在文件 SGObject.h 第 375 行定义.

该类的文档由以下文件生成:
SHOGUN 机器学习工具包 - 项目文档