PCA Class Reference

#include <PCA.hpp>

Inheritance diagram for PCA:

Public Member Functions
	PCA (int nvar=0)
	PCA (const PCA &m)
PCA &	operator= (const PCA &m)
virtual	~PCA ()
virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface for AStringable. More...
void	init (int nvar)
const VectorDouble &	getEigVals () const
double	getEigVal (int ivar) const
const MatrixRectangular &	getEigVecs () const
double	getEigVec (int ivar, int jvar) const
VectorDouble	getVarianceRatio () const
const VectorDouble &	getMeans () const
double	getMean (int ivar) const
const MatrixSquareSymmetric &	getC0 () const
int	getNVar () const
const MatrixSquareGeneral &	getF2Zs () const
const MatrixSquareGeneral &	getZ2Fs () const
const VectorDouble &	getSigmas () const
double	getSigma (int ivar) const
void	setMeans (const VectorDouble &mean)
void	setSigmas (const VectorDouble &sigma)
void	setZ2Fs (const MatrixSquareGeneral &z2f)
void	setF2Zs (const MatrixSquareGeneral &f2z)
void	setEigVals (VectorDouble &eigval)
void	setEigVal (int ivar, double eigval)
void	setEigVecs (const MatrixRectangular &eigvec)
void	setEigVec (int ivar, int jvar, double eigvec)
int	pca_compute (const Db *db, bool verbose=false, bool optionPositive=true)
int	maf_compute (Db *db, const VarioParam &varioparam, int ilag0=1, int idir0=0, bool verbose=false)
int	maf_compute_interval (Db *db, double hmin, double hmax, bool verbose=false)
int	dbZ2F (Db *db, bool verbose=false, const NamingConvention &namconv=NamingConvention("F", false))
int	dbF2Z (Db *db, bool verbose=false, const NamingConvention &namconv=NamingConvention("Z", false))
VectorDouble	mafOfIndex () const
Public Member Functions inherited from AStringable
	AStringable ()
	AStringable (const AStringable &r)
AStringable &	operator= (const AStringable &r)
virtual	~AStringable ()
virtual void	display (const AStringFormat *strfmt=nullptr) const final
virtual void	display (int level) const final

Constructor & Destructor Documentation

PCA() [1/2]

PCA::PCA

(

int

nvar = 0

)

PCA() [2/2]

PCA::PCA

(

const PCA &

m

)

~PCA()

PCA::~PCA ( )

virtual

Member Function Documentation

dbF2Z()

int PCA::dbF2Z	(	Db *	db,
		bool	verbose = false,
		const NamingConvention &	namconv = NamingConvention("Z", false)
	)

dbZ2F()

int PCA::dbZ2F	(	Db *	db,
		bool	verbose = false,
		const NamingConvention &	namconv = NamingConvention("F", false)
	)

getC0()

const MatrixSquareSymmetric& PCA::getC0 ( ) const

inline

getEigVal()

double PCA::getEigVal ( int  ivar ) const

inline

getEigVals()

const VectorDouble& PCA::getEigVals ( ) const

inline

getEigVec()

double PCA::getEigVec ( int  ivar, int  jvar  ) const

inline

getEigVecs()

const MatrixRectangular& PCA::getEigVecs ( ) const

inline

getF2Zs()

const MatrixSquareGeneral& PCA::getF2Zs ( ) const

inline

getMean()

double PCA::getMean ( int  ivar ) const

inline

getMeans()

const VectorDouble& PCA::getMeans ( ) const

inline

getNVar()

int PCA::getNVar ( ) const

inline

getSigma()

double PCA::getSigma ( int  ivar ) const

inline

getSigmas()

const VectorDouble& PCA::getSigmas ( ) const

inline

getVarianceRatio()

VectorDouble PCA::getVarianceRatio

(

)

const

getZ2Fs()

const MatrixSquareGeneral& PCA::getZ2Fs ( ) const

inline

init()

void PCA::init

(

int

nvar

)

maf_compute()

int PCA::maf_compute	(	Db *	db,
		const VarioParam &	varioparam,
		int	ilag0 = 1,
		int	idir0 = 0,
		bool	verbose = false
	)

Evaluate the MAF

Returns

Error return code

Parameters

[in]	db	Db descriptor
[in]	varioparam	VarioParam structure
[in]	ilag0	Reference Lag
[in]	idir0	Reference direction
[in]	verbose	Verbose flag

maf_compute_interval()

int PCA::maf_compute_interval	(	Db *	db,
		double	hmin,
		double	hmax,
		bool	verbose = false
	)

Evaluate the MAF

Returns

Error return code

Parameters

[in]	db	Db descriptor
[in]	hmin	Lower bound on distance
[in]	hmax	Upper bound on distance
[in]	verbose	Verbose flag

mafOfIndex()

VectorDouble PCA::mafOfIndex

(

)

const

operator=()

PCA & PCA::operator=

(

const PCA &

m

)

pca_compute()

int PCA::pca_compute	(	const Db *	db,
		bool	verbose = false,
		bool	optionPositive = true
	)

setEigVal()

void PCA::setEigVal ( int  ivar, double  eigval  )

inline

setEigVals()

void PCA::setEigVals ( VectorDouble &  eigval )

inline

setEigVec()

void PCA::setEigVec ( int  ivar, int  jvar, double  eigvec  )

inline

setEigVecs()

void PCA::setEigVecs ( const MatrixRectangular &  eigvec )

inline

setF2Zs()

void PCA::setF2Zs ( const MatrixSquareGeneral &  f2z )

inline

setMeans()

void PCA::setMeans ( const VectorDouble &  mean )

inline

setSigmas()

void PCA::setSigmas ( const VectorDouble &  sigma )

inline

setZ2Fs()

void PCA::setZ2Fs ( const MatrixSquareGeneral &  z2f )

inline

toString()

String PCA::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

Interface for AStringable.

Reimplemented from AStringable.

---

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

• include/Stats/PCA.hpp
• src/Stats/PCA.cpp