bpp::CorrespondenceAnalysis Class Reference

#include <Bpp/Numeric/Stat/Mva/CorrespondenceAnalysis.h>

Inheritance diagram for bpp::CorrespondenceAnalysis:

Collaboration diagram for bpp::CorrespondenceAnalysis:

Public Member Functions
	CorrespondenceAnalysis (const Matrix< double > &data, unsigned int nbAxes, double tol=0.0000001, bool verbose=true) throw (Exception)
	Build a new CorrespondenceAnalysis object. More...
virtual	~CorrespondenceAnalysis ()
CorrespondenceAnalysis *	clone () const
	Create a copy of this object and send a pointer to it. More...
double	getSumOfAllValues () const throw (Exception)
void	setData (const Matrix< double > &matrix, const std::vector< double > &rowWeights, const std::vector< double > &colWeights, unsigned int nbAxes, double tol=0.0000001, bool verbose=true) throw (Exception)
	Set the data and perform computations. More...
std::vector< double >	computeVariancePercentagePerAxis () throw (Exception)
size_t	getNbOfKeptAxes () const throw (Exception)
const std::vector< double >	getRowWeights () const throw (Exception)
const std::vector< double >	getColumnWeights () const throw (Exception)
const std::vector< double > &	getEigenValues () const throw (Exception)
const RowMatrix< double > &	getRowCoordinates () const throw (Exception)
const RowMatrix< double > &	getColCoordinates () const throw (Exception)
const RowMatrix< double > &	getPrincipalAxes () const throw (Exception)
const RowMatrix< double > &	getPrincipalComponents () const throw (Exception)

Private Attributes
double	n_

Detailed Description

Definition at line 57 of file CorrespondenceAnalysis.h.

Constructor & Destructor Documentation

CorrespondenceAnalysis()

CorrespondenceAnalysis::CorrespondenceAnalysis	(	const Matrix< double > &	data,
		unsigned int	nbAxes,
		double	tol = 0.0000001,
		bool	verbose = true
	)
throw	(	Exception
	)

Build a new CorrespondenceAnalysis object.

Parameters

data	The input data (a RowMatrix) to analyse.
nbAxes	The number of kept axes during the analysis.
tol	Tolerance threshold for null eigenvalues (a value less than tol times the first one is considered as null)
verbose	Should warnings be dispayed.

Exceptions

Exception

if an error occured.

Definition at line 48 of file CorrespondenceAnalysis.cpp.

References bpp::MatrixTools::hadamardMult(), and bpp::MatrixTools::scale().

Referenced by clone().

~CorrespondenceAnalysis()

virtual bpp::CorrespondenceAnalysis::~CorrespondenceAnalysis ( )

inlinevirtual

Definition at line 80 of file CorrespondenceAnalysis.h.

Member Function Documentation

clone()

CorrespondenceAnalysis* bpp::CorrespondenceAnalysis::clone ( ) const

inlinevirtual

Create a copy of this object and send a pointer to it.

Returns

A pointer toward the copy object.

Implements bpp::Clonable.

Definition at line 87 of file CorrespondenceAnalysis.h.

References CorrespondenceAnalysis().

computeVariancePercentagePerAxis()

std::vector<double> bpp::DualityDiagram::computeVariancePercentagePerAxis ( ) throw ( Exception )

inherited

getColCoordinates()

const RowMatrix<double>& bpp::DualityDiagram::getColCoordinates ( ) const throw ( Exception )

inlineinherited

Definition at line 151 of file DualityDiagram.h.

References bpp::DualityDiagram::colCoord_.

getColumnWeights()

const std::vector<double> bpp::DualityDiagram::getColumnWeights ( ) const throw ( Exception )

inlineinherited

Definition at line 148 of file DualityDiagram.h.

References bpp::DualityDiagram::colWeights_.

getEigenValues()

const std::vector<double>& bpp::DualityDiagram::getEigenValues ( ) const throw ( Exception )

inlineinherited

Definition at line 149 of file DualityDiagram.h.

References bpp::DualityDiagram::eigenValues_.

getNbOfKeptAxes()

size_t bpp::DualityDiagram::getNbOfKeptAxes ( ) const throw ( Exception )

inlineinherited

Definition at line 146 of file DualityDiagram.h.

References bpp::DualityDiagram::nbAxes_.

getPrincipalAxes()

const RowMatrix<double>& bpp::DualityDiagram::getPrincipalAxes ( ) const throw ( Exception )

inlineinherited

Definition at line 152 of file DualityDiagram.h.

References bpp::DualityDiagram::ppalAxes_.

getPrincipalComponents()

const RowMatrix<double>& bpp::DualityDiagram::getPrincipalComponents ( ) const throw ( Exception )

inlineinherited

Definition at line 153 of file DualityDiagram.h.

References bpp::DualityDiagram::ppalComponents_.

getRowCoordinates()

const RowMatrix<double>& bpp::DualityDiagram::getRowCoordinates ( ) const throw ( Exception )

inlineinherited

Definition at line 150 of file DualityDiagram.h.

References bpp::DualityDiagram::rowCoord_.

getRowWeights()

const std::vector<double> bpp::DualityDiagram::getRowWeights ( ) const throw ( Exception )

inlineinherited

Definition at line 147 of file DualityDiagram.h.

References bpp::DualityDiagram::rowWeights_.

getSumOfAllValues()

double bpp::CorrespondenceAnalysis::getSumOfAllValues ( ) const throw ( Exception )

inline

Definition at line 90 of file CorrespondenceAnalysis.h.

References n_.

setData()

void DualityDiagram::setData ( const Matrix< double > &  matrix, const std::vector< double > &  rowWeights, const std::vector< double > &  colWeights, unsigned int  nbAxes, double  tol = 0.0000001, bool  verbose = true  ) throw ( Exception )

inherited

Set the data and perform computations.

Parameters

matrix	The input data to analyse.
rowWeights	A vector of values specifying the weights of rows.
colWeights	A vector of values specifying the weights of columns.
nbAxes	The number of kept axes during the analysis.
tol	Tolerance threshold for null eigenvalues (a value less than tol times the first one is considered as null)
verbose	Should warnings be dispayed.

Exceptions

Exception

if an error occured.

Definition at line 100 of file DualityDiagram.cpp.

Member Data Documentation

n_

double bpp::CorrespondenceAnalysis::n_

private

Definition at line 61 of file CorrespondenceAnalysis.h.

Referenced by getSumOfAllValues().

---

The documentation for this class was generated from the following files:

• Bpp/Numeric/Stat/Mva/CorrespondenceAnalysis.h
• Bpp/Numeric/Stat/Mva/CorrespondenceAnalysis.cpp