gstlrn::KrigingAlgebraSimpleCase Class Reference

#include <KrigingAlgebraSimpleCase.hpp>

Public Member Functions
	KrigingAlgebraSimpleCase (bool flagDual=false, const RankHandler *rankhandler=nullptr, const 1 *Z=nullptr, const 1 &Means=1(), Id flagchol=false, bool neighUnique=OptCustom::query("unique", 1))
	KrigingAlgebraSimpleCase (KrigingAlgebraSimpleCase &r)
KrigingAlgebraSimpleCase &	operator= (const KrigingAlgebraSimpleCase &r)=delete
virtual	~KrigingAlgebraSimpleCase ()
Id	prepare ()
void	setDual (bool status)
void	setNeighUnique (bool nu=false)
void	resetNewData ()
	Method to be used when the data has changed (e.g. Moving Neighborhood)
void	setZ (std::shared_ptr< 1 > &Z)
Id	setData (const 1 *Z=nullptr, const RankHandler *rankhandler=nullptr, const 1 &Means=1())
	Modify the Data Values (and Means)
Id	setLHS (const MatrixSymmetric *Sigma=nullptr, const MatrixDense *X=nullptr)
	Modify the elements linked to the LHS.
Id	setRHS (MatrixDense *Sigma0=nullptr, MatrixDense *X0=nullptr)
Id	setVariance (const MatrixSymmetric *Sigma00=nullptr)
void	printStatus () const
void	dumpLHS (Id nbypas=5) const
void	dumpRHS () const
void	dumpWGT ()
void	dumpAux ()
&	getEstimation ()
const &	getStdv ()
double	getVarianceZstar (Id i)
	getVarianceZstar ()
const MatrixSymmetric *	getStdvMat ()
const MatrixSymmetric *	getVarianceZstarMat ()
const MatrixDense *	getLambda ()
const MatrixDense *	getLambda0 ()
const MatrixDense *	getMu ()
double	getLTerm ()
Id	updateRHS ()
bool	isDual () const
*	getZ ()
MatrixSymmetric *	getSigma ()
MatrixSymmetric *	getSigma00 ()
MatrixDense *	getX ()
MatrixDense *	getSigma0 ()
void	updateSampleRanks ()
void	updateRankHandler ()
MatrixDense *	getX0 ()
const *	getSampleRanks ()
*	getSampleRanksByVariable (Id ivar)
RankHandler *	getRankHandler ()
void	setRankHandler (std::shared_ptr< RankHandler > &rkh)
*	getNbgh ()
void	setMeans (const 1 &means)

Constructor & Destructor Documentation

KrigingAlgebraSimpleCase() [1/2]

gstlrn::KrigingAlgebraSimpleCase::KrigingAlgebraSimpleCase	(	bool	flagDual = false,
		const RankHandler *	rankhandler = nullptr,
		const 1 *	Z = nullptr,
		const 1 &	Means = 1(),
		Id	flagchol = false,
		bool	neighUnique = OptCustom::query("unique", 1)
	)

KrigingAlgebraSimpleCase() [2/2]

gstlrn::KrigingAlgebraSimpleCase::KrigingAlgebraSimpleCase

(

KrigingAlgebraSimpleCase &

r

)

~KrigingAlgebraSimpleCase()

gstlrn::KrigingAlgebraSimpleCase::~KrigingAlgebraSimpleCase ( )

virtual

Member Function Documentation

dumpAux()

void gstlrn::KrigingAlgebraSimpleCase::dumpAux

(

)

dumpLHS()

void gstlrn::KrigingAlgebraSimpleCase::dumpLHS

(

Id

nbypas = 5

)

const

dumpRHS()

void gstlrn::KrigingAlgebraSimpleCase::dumpRHS

(

)

const

dumpWGT()

void gstlrn::KrigingAlgebraSimpleCase::dumpWGT

(

)

getEstimation()

& gstlrn::KrigingAlgebraSimpleCase::getEstimation

(

)

getLambda()

const MatrixDense * gstlrn::KrigingAlgebraSimpleCase::getLambda

(

)

getLambda0()

const MatrixDense * gstlrn::KrigingAlgebraSimpleCase::getLambda0

(

)

getLTerm()

double gstlrn::KrigingAlgebraSimpleCase::getLTerm

(

)

getMu()

const MatrixDense * gstlrn::KrigingAlgebraSimpleCase::getMu

(

)

getNbgh()

* gstlrn::KrigingAlgebraSimpleCase::getNbgh ( )

inline

getRankHandler()

RankHandler * gstlrn::KrigingAlgebraSimpleCase::getRankHandler ( )

inline

getSampleRanks()

const * gstlrn::KrigingAlgebraSimpleCase::getSampleRanks ( )

inline

getSampleRanksByVariable()

* gstlrn::KrigingAlgebraSimpleCase::getSampleRanksByVariable ( Id  ivar )

inline

getSigma()

MatrixSymmetric * gstlrn::KrigingAlgebraSimpleCase::getSigma ( )

inline

getSigma0()

MatrixDense * gstlrn::KrigingAlgebraSimpleCase::getSigma0 ( )

inline

getSigma00()

MatrixSymmetric * gstlrn::KrigingAlgebraSimpleCase::getSigma00 ( )

inline

getStdv()

const & gstlrn::KrigingAlgebraSimpleCase::getStdv

(

)

getStdvMat()

const MatrixSymmetric * gstlrn::KrigingAlgebraSimpleCase::getStdvMat

(

)

getVarianceZstar() [1/2]

gstlrn::KrigingAlgebraSimpleCase::getVarianceZstar

(

)

getVarianceZstar() [2/2]

double gstlrn::KrigingAlgebraSimpleCase::getVarianceZstar

(

Id

i

)

getVarianceZstarMat()

const MatrixSymmetric * gstlrn::KrigingAlgebraSimpleCase::getVarianceZstarMat

(

)

getX()

MatrixDense * gstlrn::KrigingAlgebraSimpleCase::getX ( )

inline

getX0()

MatrixDense * gstlrn::KrigingAlgebraSimpleCase::getX0 ( )

inline

getZ()

* gstlrn::KrigingAlgebraSimpleCase::getZ ( )

inline

isDual()

bool gstlrn::KrigingAlgebraSimpleCase::isDual ( ) const

inline

operator=()

KrigingAlgebraSimpleCase & gstlrn::KrigingAlgebraSimpleCase::operator= ( const KrigingAlgebraSimpleCase &  r )

delete

prepare()

Id gstlrn::KrigingAlgebraSimpleCase::prepare

(

)

printStatus()

void gstlrn::KrigingAlgebraSimpleCase::printStatus

(

)

const

resetNewData()

void gstlrn::KrigingAlgebraSimpleCase::resetNewData

(

)

Method to be used when the data has changed (e.g. Moving Neighborhood)

setData()

Id gstlrn::KrigingAlgebraSimpleCase::setData	(	const 1 *	Z = nullptr,
		const RankHandler *	rankhandler = nullptr,
		const 1 &	Means = 1()
	)

Modify the Data Values (and Means)

Parameters

Z	Data flattened vector (possibly multivariate)
rankhandler	rank handler
Means	Vector of known Drift coefficients (optional)

Returns

Id

Note

If one element is not provided, its address (if already defined) is

kept unchanged (even if its contents may have been updated)

setDual()

void gstlrn::KrigingAlgebraSimpleCase::setDual

(

bool

status

)

setLHS()

Id gstlrn::KrigingAlgebraSimpleCase::setLHS	(	const MatrixSymmetric *	Sigma = nullptr,
		const MatrixDense *	X = nullptr
	)

Modify the elements linked to the LHS.

Parameters

Sigma	Data-Data Covariance matrix
X	Data Drift Matrix

Returns

Id

Note

If one element is not provided, its address (if already defined) is

kept unchanged (even if its contents may have been updated)

setMeans()

void gstlrn::KrigingAlgebraSimpleCase::setMeans

(

const 1 &

means

)

setNeighUnique()

void gstlrn::KrigingAlgebraSimpleCase::setNeighUnique ( bool  nu = false )

inline

setRankHandler()

void gstlrn::KrigingAlgebraSimpleCase::setRankHandler ( std::shared_ptr< RankHandler > &  rkh )

inline

setRHS()

Id gstlrn::KrigingAlgebraSimpleCase::setRHS	(	MatrixDense *	Sigma0 = nullptr,
		MatrixDense *	X0 = nullptr
	)

setVariance()

Id gstlrn::KrigingAlgebraSimpleCase::setVariance

(

const MatrixSymmetric *

Sigma00 = nullptr

)

setZ()

void gstlrn::KrigingAlgebraSimpleCase::setZ

(

std::shared_ptr< 1 > &

Z

)

updateRankHandler()

void gstlrn::KrigingAlgebraSimpleCase::updateRankHandler

(

)

updateRHS()

Id gstlrn::KrigingAlgebraSimpleCase::updateRHS

(

)

updateSampleRanks()

void gstlrn::KrigingAlgebraSimpleCase::updateSampleRanks

(

)

---

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

• include/Estimation/KrigingAlgebraSimpleCase.hpp
• src/Estimation/KrigingAlgebraSimpleCase.cpp