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

详细描述

Preprocessor FisherLDA attempts to model the difference between the classes of data by performing linear discriminant analysis on input feature vectors/matrices. When the init method in FisherLDA is called with proper feature matrix X(say N number of vectors and D feature dimensions) supplied via apply_to_feature_matrix or apply_to_feature_vector methods, this creates a transformation whose outputs are the reduced T-Dimensional & class-specific distribution (where T<= number of unique classes-1). The transformation matrix is essentially a DxT matrix, the columns of which correspond to the specified number of eigenvectors which maximizes the ratio of between class matrix to within class matrix.

This class provides 3 method options to compute the transformation matrix :

CLASSIC_FLDA : This method selects W in such a way that the ratio of the between-class scatter and the within class scatter is maximized. The between class matrix is : \(\sum_b = \sum_{i=1}^C{\bf{(\mu_i-\mu)(\mu_i-\mu)^T}}\) The within class matrix is : \(\sum_w = \sum_{i=1}^C{\sum_{x_k\in}^c{\bf{(\mu_i-\mu)(\mu_i-\mu)^T}}}\) This should be choosen when N>D

CANVAR_FLDA : This method performs Canonical Variates which generalises Fisher's method to projection of more than one dimension. This is equipped to handle the cases where the within class matrix are non-invertible. Can be used for both cases(D>N or D<N). See the implementation in Bayesian Reasoning and Machine Learning by David Barber , Section 16.3

AUTO_FLDA : Automagically, the appropriate method is selected based on whether D>N (chooses CANVAR_FLDA) or D<N(chooses ::CLASSIC_FLDA)

在文件 FisherLDA.h92 行定义.

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

Public 成员函数

 CFisherLDA (EFLDAMethod method=AUTO_FLDA, float64_t thresh=0.01)
 
virtual ~CFisherLDA ()
 
virtual bool fit (CFeatures *features, CLabels *labels, int32_t num_dimensions=0)
 
virtual void cleanup ()
 
virtual SGMatrix< float64_tapply_to_feature_matrix (CFeatures *features)
 
virtual SGVector< float64_tapply_to_feature_vector (SGVector< float64_t > vector)
 
SGMatrix< float64_tget_transformation_matrix ()
 
SGVector< float64_tget_eigenvalues ()
 
SGVector< float64_tget_mean ()
 
virtual const char * get_name () const
 
virtual EPreprocessorType get_type () const
 
virtual bool init (CFeatures *data)
 
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 CFeaturesapply (CFeatures *features)
 
virtual EFeatureClass get_feature_class ()
 return that we are dense features (just fixed size matrices) 更多...
 
virtual EFeatureType get_feature_type ()
 return feature type 更多...
 
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="")
 
virtual bool load_serializable (CSerializableFile *file, const char *prefix="")
 
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
 
uint32_t m_hash
 

Protected 成员函数

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 属性

SGMatrix< float64_tm_transformation_matrix
 
int32_t m_num_dim
 
float64_t m_threshold
 
int32_t m_method
 
SGVector< float64_tm_mean_vector
 
SGVector< float64_tm_eigenvalues_vector
 
int32_t m_target_dim
 
CDistancem_distance
 
CKernelm_kernel
 
CEmbeddingConverterm_converter
 

构造及析构函数说明

CFisherLDA ( EFLDAMethod  method = AUTO_FLDA,
float64_t  thresh = 0.01 
)

standard constructor

参数
methodLDA based on : CLASSIC_FLDA/CANVAR_FLDA/AUTO_FLDA[default]
threshthreshold value for CANVAR_FLDA only. This is used to reject those basis whose singular values are less than the provided threshold. The default one is 0.01.

在文件 FisherLDA.cpp52 行定义.

~CFisherLDA ( )
virtual

destructor

在文件 FisherLDA.cpp76 行定义.

成员函数说明

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

apply preprocessor to feature matrix

参数
featureson which the learned tranformation has to be applied. Sometimes it is also referred as projecting the given features.
返回
processed feature matrix with reduced dimensions.

重载 CDimensionReductionPreprocessor .

在文件 FisherLDA.cpp294 行定义.

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

apply preprocessor to feature vector

参数
featureson which the learned transformation has to be applied.
返回
processed feature vector with reduced dimensions.

重载 CDimensionReductionPreprocessor .

在文件 FisherLDA.cpp331 行定义.

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.cpp597 行定义.

void cleanup ( )
virtual

cleanup

重载 CDimensionReductionPreprocessor .

在文件 FisherLDA.cpp287 行定义.

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.cpp714 行定义.

CSGObject * deep_copy ( ) const
virtualinherited

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

在文件 SGObject.cpp198 行定义.

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.cpp618 行定义.

bool fit ( CFeatures features,
CLabels labels,
int32_t  num_dimensions = 0 
)
virtual

fits fisher lda transformation using features and corresponding labels

参数
featuresusing which the transformation matrix will be formed
labelsof the given features which will be used here to find the transformation matrix unlike PCA where it is not needed.
dimensionsnumber of dimensions to retain

在文件 FisherLDA.cpp80 行定义.

CDistance * get_distance ( ) const
inherited

getter for distance

返回
distance

在文件 DimensionReductionPreprocessor.cpp88 行定义.

SGVector< float64_t > get_eigenvalues ( )
返回
get eigenvalues of LDA

在文件 FisherLDA.cpp350 行定义.

virtual EFeatureClass get_feature_class ( )
virtualinherited

return that we are dense features (just fixed size matrices)

实现了 CPreprocessor.

CRandomFourierGaussPreproc 重载.

virtual EFeatureType get_feature_type ( )
virtualinherited

return feature type

实现了 CPreprocessor.

CRandomFourierGaussPreproc 重载.

SGIO * get_global_io ( )
inherited

get the io object

返回
io object

在文件 SGObject.cpp235 行定义.

Parallel * get_global_parallel ( )
inherited

get the parallel object

返回
parallel object

在文件 SGObject.cpp277 行定义.

Version * get_global_version ( )
inherited

get the version object

返回
version object

在文件 SGObject.cpp290 行定义.

CKernel * get_kernel ( ) const
inherited

getter for kernel

返回
kernel

在文件 DimensionReductionPreprocessor.cpp101 行定义.

SGVector< float64_t > get_mean ( )
返回
get mean vector of the original data

在文件 FisherLDA.cpp355 行定义.

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

在文件 SGObject.cpp498 行定义.

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.cpp522 行定义.

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.cpp535 行定义.

virtual const char* get_name ( ) const
virtual
返回
object name

重载 CDimensionReductionPreprocessor .

在文件 FisherLDA.h144 行定义.

int32_t get_target_dim ( ) const
inherited

getter for target dimension

返回
target dimension

在文件 DimensionReductionPreprocessor.cpp76 行定义.

SGMatrix< float64_t > get_transformation_matrix ( )
返回
get transformation matrix which contains the required number of eigenvectors

在文件 FisherLDA.cpp345 行定义.

virtual EPreprocessorType get_type ( ) const
virtual
返回
a type of preprocessor

重载 CDimensionReductionPreprocessor .

在文件 FisherLDA.h147 行定义.

bool init ( CFeatures data)
virtualinherited

init set true by default, should be defined if dimension reduction preprocessor is using some initialization

实现了 CPreprocessor.

CPCA , 以及 CKernelPCA 重载.

在文件 DimensionReductionPreprocessor.cpp58 行定义.

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.cpp296 行定义.

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.cpp369 行定义.

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.cpp426 行定义.

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.cpp421 行定义.

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

在文件 SGObject.cpp262 行定义.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp474 行定义.

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

prints registered parameters out

参数
prefixprefix for members

在文件 SGObject.cpp308 行定义.

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.cpp314 行定义.

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.cpp436 行定义.

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.cpp431 行定义.

void set_distance ( CDistance distance)
inherited

setter for distance

参数
distancedistance to set

在文件 DimensionReductionPreprocessor.cpp81 行定义.

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.cpp228 行定义.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

参数
parallelparallel object to use

在文件 SGObject.cpp241 行定义.

void set_global_version ( Version version)
inherited

set the version object

参数
versionversion object to use

在文件 SGObject.cpp283 行定义.

void set_kernel ( CKernel kernel)
inherited

setter for kernel

参数
kernelkernel to set

在文件 DimensionReductionPreprocessor.cpp94 行定义.

void set_target_dim ( int32_t  dim)
inherited

setter for target dimension

参数
dimtarget dimension

在文件 DimensionReductionPreprocessor.cpp70 行定义.

CSGObject * shallow_copy ( ) const
virtualinherited

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

CGaussianKernel 重载.

在文件 SGObject.cpp192 行定义.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp303 行定义.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp248 行定义.

类成员变量说明

SGIO* io
inherited

io

在文件 SGObject.h369 行定义.

CEmbeddingConverter* m_converter
protectedinherited

embedding converter to be used

在文件 DimensionReductionPreprocessor.h127 行定义.

CDistance* m_distance
protectedinherited

distance to be used

在文件 DimensionReductionPreprocessor.h121 行定义.

SGVector<float64_t> m_eigenvalues_vector
protected

eigenvalues vector

在文件 FisherLDA.h167 行定义.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

在文件 SGObject.h384 行定义.

uint32_t m_hash
inherited

Hash of parameter values

在文件 SGObject.h387 行定义.

CKernel* m_kernel
protectedinherited

kernel to be used

在文件 DimensionReductionPreprocessor.h124 行定义.

SGVector<float64_t> m_mean_vector
protected

mean vector

在文件 FisherLDA.h165 行定义.

int32_t m_method
protected

m_method

在文件 FisherLDA.h163 行定义.

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h381 行定义.

int32_t m_num_dim
protected

num dim

在文件 FisherLDA.h159 行定义.

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h378 行定义.

int32_t m_target_dim
protectedinherited

target dim of dimensionality reduction preprocessor

在文件 DimensionReductionPreprocessor.h118 行定义.

float64_t m_threshold
protected

m_threshold

在文件 FisherLDA.h161 行定义.

SGMatrix<float64_t> m_transformation_matrix
protected

transformation matrix

在文件 FisherLDA.h157 行定义.

Parallel* parallel
inherited

parallel

在文件 SGObject.h372 行定义.

Version* version
inherited

version

在文件 SGObject.h375 行定义.


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

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