KrigingAlgebraSimpleCase Class Reference

Perform the Algebra for Kriging and CoKriging. More...

#include <KrigingAlgebraSimpleCase.hpp>

Detailed Description

Perform the Algebra for Kriging and CoKriging.

It requires the definition of:

• the vector of Data values Z (possibly multivariate and heterotopic)
• the Covariance matrix at data points Sigma
• the Drift matrix at data points X (UK if defined, SK otherwise)
• the Covariance matrix at target Sigma00 (only for calculating variance)
• the Drift coefficients Beta (for SK)

Note: When using SK:

• the vector Z must be centered by the drift beforehand
• the vector beta corresponds to the vector of Means.

Public Member Functions
	KrigingAlgebraSimpleCase (bool flagDual=false, const VectorVectorInt *sampleRanks=nullptr, const VectorDouble *Z=nullptr, const VectorDouble &Means=VectorDouble(), int flagchol=false, bool neighUnique=OptCustom::query("unique", 1))
	KrigingAlgebraSimpleCase (KrigingAlgebraSimpleCase &r)
KrigingAlgebraSimpleCase &	operator= (const KrigingAlgebraSimpleCase &r)=delete
virtual	~KrigingAlgebraSimpleCase ()
int	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)
int	setData (const VectorDouble *Z=nullptr, const VectorVectorInt *indices=nullptr, const VectorDouble &Means=VectorDouble())
	Modify the Data Values (and Means)
int	setLHS (const MatrixSymmetric *Sigma=nullptr, const MatrixDense *X=nullptr)
	Modify the elements linked to the LHS.
int	setRHS (MatrixDense *Sigma0=nullptr, MatrixDense *X0=nullptr)
int	setVariance (const MatrixSymmetric *Sigma00=nullptr)
void	printStatus () const
void	dumpLHS (int nbypas=5) const
void	dumpRHS () const
void	dumpWGT ()
void	dumpAux ()
VectorDouble &	getEstimation ()
VectorDouble	getStdv ()
double	getVarianceZstar (int i)
VectorDouble	getVarianceZstar ()
const MatrixSymmetric *	getStdvMat ()
const MatrixSymmetric *	getVarianceZstarMat ()
const MatrixDense *	getLambda ()
const MatrixDense *	getLambda0 ()
const MatrixDense *	getMu ()
double	getLTerm ()
int	updateRHS ()
bool	isDual () const
VectorDouble *	getZ ()
MatrixSymmetric *	getSigma ()
MatrixSymmetric *	getSigma00 ()
MatrixDense *	getX ()
MatrixDense *	getSigma0 ()
void	updateSampleRanks ()
MatrixDense *	getX0 ()
VectorVectorInt *	getSampleRanks ()
VectorInt *	getNbgh ()
void	setMeans (const VectorDouble &means)

Constructor & Destructor Documentation

KrigingAlgebraSimpleCase() [1/2]

KrigingAlgebraSimpleCase::KrigingAlgebraSimpleCase	(	bool	flagDual = false,
		const VectorVectorInt *	sampleRanks = nullptr,
		const VectorDouble *	Z = nullptr,
		const VectorDouble &	Means = VectorDouble(),
		int	flagchol = false,
		bool	neighUnique = OptCustom::query("unique", 1)
	)

KrigingAlgebraSimpleCase() [2/2]

KrigingAlgebraSimpleCase::KrigingAlgebraSimpleCase

(

KrigingAlgebraSimpleCase &

r

)

~KrigingAlgebraSimpleCase()

KrigingAlgebraSimpleCase::~KrigingAlgebraSimpleCase ( )

virtual

Member Function Documentation

dumpAux()

void KrigingAlgebraSimpleCase::dumpAux

(

)

dumpLHS()

void KrigingAlgebraSimpleCase::dumpLHS

(

int

nbypas = 5

)

const

dumpRHS()

void KrigingAlgebraSimpleCase::dumpRHS

(

)

const

dumpWGT()

void KrigingAlgebraSimpleCase::dumpWGT

(

)

getEstimation()

VectorDouble & KrigingAlgebraSimpleCase::getEstimation

(

)

getLambda()

const MatrixDense * KrigingAlgebraSimpleCase::getLambda

(

)

getLambda0()

const MatrixDense * KrigingAlgebraSimpleCase::getLambda0

(

)

getLTerm()

double KrigingAlgebraSimpleCase::getLTerm

(

)

getMu()

const MatrixDense * KrigingAlgebraSimpleCase::getMu

(

)

getNbgh()

VectorInt * KrigingAlgebraSimpleCase::getNbgh ( )

inline

getSampleRanks()

VectorVectorInt * KrigingAlgebraSimpleCase::getSampleRanks ( )

inline

getSigma()

MatrixSymmetric * KrigingAlgebraSimpleCase::getSigma ( )

inline

getSigma0()

MatrixDense * KrigingAlgebraSimpleCase::getSigma0 ( )

inline

getSigma00()

MatrixSymmetric * KrigingAlgebraSimpleCase::getSigma00 ( )

inline

getStdv()

VectorDouble KrigingAlgebraSimpleCase::getStdv

(

)

getStdvMat()

const MatrixSymmetric * KrigingAlgebraSimpleCase::getStdvMat

(

)

getVarianceZstar() [1/2]

VectorDouble KrigingAlgebraSimpleCase::getVarianceZstar

(

)

getVarianceZstar() [2/2]

double KrigingAlgebraSimpleCase::getVarianceZstar

(

int

i

)

getVarianceZstarMat()

const MatrixSymmetric * KrigingAlgebraSimpleCase::getVarianceZstarMat

(

)

getX()

MatrixDense * KrigingAlgebraSimpleCase::getX ( )

inline

getX0()

MatrixDense * KrigingAlgebraSimpleCase::getX0 ( )

inline

getZ()

VectorDouble * KrigingAlgebraSimpleCase::getZ ( )

inline

isDual()

bool KrigingAlgebraSimpleCase::isDual ( ) const

inline

operator=()

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

delete

prepare()

int KrigingAlgebraSimpleCase::prepare

(

)

printStatus()

void KrigingAlgebraSimpleCase::printStatus

(

)

const

resetNewData()

void KrigingAlgebraSimpleCase::resetNewData

(

)

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

setData()

int KrigingAlgebraSimpleCase::setData	(	const VectorDouble *	Z = nullptr,
		const VectorVectorInt *	indices = nullptr,
		const VectorDouble &	Means = VectorDouble()
	)

Modify the Data Values (and Means)

Parameters

Z	Data flattened vector (possibly multivariate)
indices	Vector Of Vector of sample ranks
Means	Vector of known Drift coefficients (optional)

Returns

int

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 KrigingAlgebraSimpleCase::setDual

(

bool

status

)

setLHS()

int 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

int

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 KrigingAlgebraSimpleCase::setMeans

(

const VectorDouble &

means

)

setNeighUnique()

void KrigingAlgebraSimpleCase::setNeighUnique ( bool  nu = false )

inline

setRHS()

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

setVariance()

int KrigingAlgebraSimpleCase::setVariance

(

const MatrixSymmetric *

Sigma00 = nullptr

)

updateRHS()

int KrigingAlgebraSimpleCase::updateRHS

(

)

updateSampleRanks()

void KrigingAlgebraSimpleCase::updateSampleRanks

(

)

---

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

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