gstlrn::PCA Class Reference

#include <PCA.hpp>

Inheritance diagram for gstlrn::PCA:

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

Constructor & Destructor Documentation

PCA() [1/2]

gstlrn::PCA::PCA

(

Id

nvar = 0

)

PCA() [2/2]

gstlrn::PCA::PCA

(

const PCA &

m

)

~PCA()

gstlrn::PCA::~PCA ( )

virtual

Member Function Documentation

dbF2Z()

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

dbZ2F()

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

getC0()

const MatrixSymmetric & gstlrn::PCA::getC0 ( ) const

inline

getEigVal()

double gstlrn::PCA::getEigVal ( Id  ivar ) const

inline

getEigVals()

const & gstlrn::PCA::getEigVals ( ) const

inline

getEigVec()

double gstlrn::PCA::getEigVec ( Id  ivar, Id  jvar  ) const

inline

getEigVecs()

const MatrixDense & gstlrn::PCA::getEigVecs ( ) const

inline

getF2Zs()

const MatrixSquare & gstlrn::PCA::getF2Zs ( ) const

inline

getMean()

double gstlrn::PCA::getMean ( Id  ivar ) const

inline

getMeans()

const & gstlrn::PCA::getMeans ( ) const

inline

getNVar()

Id gstlrn::PCA::getNVar ( ) const

inline

getSigma()

double gstlrn::PCA::getSigma ( Id  ivar ) const

inline

getSigmas()

const & gstlrn::PCA::getSigmas ( ) const

inline

getVarianceRatio()

gstlrn::PCA::getVarianceRatio

(

)

const

getZ2Fs()

const MatrixSquare & gstlrn::PCA::getZ2Fs ( ) const

inline

init()

void gstlrn::PCA::init

(

Id

nvar

)

maf_compute()

Id gstlrn::PCA::maf_compute	(	Db *	db,
		const VarioParam &	varioparam,
		Id	ilag0 = 1,
		Id	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()

Id gstlrn::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()

gstlrn::PCA::mafOfIndex

(

)

const

operator=()

PCA & gstlrn::PCA::operator=

(

const PCA &

m

)

pca_compute()

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

setEigVal()

void gstlrn::PCA::setEigVal ( Id  ivar, double  eigval  )

inline

setEigVals()

void gstlrn::PCA::setEigVals ( 1 &  eigval )

inline

setEigVec()

void gstlrn::PCA::setEigVec ( Id  ivar, Id  jvar, double  eigvec  )

inline

setEigVecs()

void gstlrn::PCA::setEigVecs ( const MatrixDense &  eigvec )

inline

setF2Zs()

void gstlrn::PCA::setF2Zs ( const MatrixSquare &  f2z )

inline

setMeans()

void gstlrn::PCA::setMeans ( const 1 &  mean )

inline

setSigmas()

void gstlrn::PCA::setSigmas ( const 1 &  sigma )

inline

setZ2Fs()

void gstlrn::PCA::setZ2Fs ( const MatrixSquare &  z2f )

inline

toString()

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

overridevirtual

Interface for AStringable.

Reimplemented from gstlrn::AStringable.

---

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

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