CovContext Class Reference

#include <CovContext.hpp>

Inheritance diagram for CovContext:

Public Member Functions
	CovContext (int nvar=1, const ASpace *space=nullptr)
	CovContext (int nvar, int ndim, const VectorDouble &mean=VectorDouble(), const VectorDouble &covar0=VectorDouble())
	CovContext (const Db *db, const ASpace *space=nullptr)
	CovContext (const Vario *vario, const ASpace *space=nullptr)
	CovContext (const CovContext &r)
CovContext &	operator= (const CovContext &r)
virtual	~CovContext ()
virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	AStringable interface. More...
virtual bool	isConsistent (const ASpace *space) const override
	Indicate if I am consistent with the provided space. More...
bool	isEqual (const CovContext &r) const
int	getNVar () const
double	getField () const
const VectorDouble &	getMean () const
const VectorDouble &	getCovar0 () const
const ASpace *	getASpace () const
double	getMean (int ivar) const
double	getCovar0 (int ivar, int jvar) const
void	setNVar (int nvar)
void	setField (double field)
void	setMean (const VectorDouble &mean)
void	setMean (const double mean, int ivar=0)
void	setCovar0 (const VectorDouble &covar0)
void	setCovar0 (int ivar, int jvar, double covar0)
void	copyCovContext (const CovContext &ctxt, bool severe=false)
const CovContext *	createReduce (const VectorInt &validVars) const
Public Member Functions inherited from ASpaceObject
	ASpaceObject (const ASpace *space=nullptr)
	ASpaceObject (const ASpace &space)
	ASpaceObject (const ASpaceObject &r)
ASpaceObject &	operator= (const ASpaceObject &r)
virtual	~ASpaceObject ()
const ASpace *	getSpace () const
	Accessor to the current object space context. More...
bool	isConsistent () const
	Indicate if I am consistent with my current space context. More...
VectorDouble	getUnitaryVector () const
	Return unitary vector for the current space context. More...
unsigned int	getNDim () const
	Shortcuts to ASpace methods. More...
const VectorDouble &	getOrigin () const
	Return the current space context origin coordinates. More...
double	getDistance (const SpacePoint &p1, const SpacePoint &p2) const
	Return the distance between two space points for the current space context. More...
double	getDistance1D (const SpacePoint &p1, const SpacePoint &p2, int idim) const
	Return the distance along one direction between two space points. More...
VectorDouble	getIncrement (const SpacePoint &p1, const SpacePoint &p2) const
	Return the increment vector between two space points for the current space context. More...
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

Static Public Member Functions
static CovContext *	create (int nvar, int ndim)

Constructor & Destructor Documentation

CovContext() [1/5]

CovContext::CovContext	(	int	nvar = 1,
		const ASpace *	space = nullptr
	)

Create a covariances context giving the number dimensions of a predefined space RN

Parameters

nvar	Number of variables
space	Space definition

CovContext() [2/5]

CovContext::CovContext	(	int	nvar,
		int	ndim,
		const VectorDouble &	mean = VectorDouble(),
		const VectorDouble &	covar0 = VectorDouble()
	)

Create a covariances context giving the number dimensions of a predefined space RN

Parameters

nvar	Number of variables
ndim	Number of dimension of the euclidean space (RN)
mean	Vector of Means
covar0	Vector of variance-covariance

CovContext() [3/5]

CovContext::CovContext	(	const Db *	db,
		const ASpace *	space = nullptr
	)

TODO : check Db dimension vs provided space

CovContext() [4/5]

CovContext::CovContext	(	const Vario *	vario,
		const ASpace *	space = nullptr
	)

TODO : check vario dimension vs provided space

CovContext() [5/5]

CovContext::CovContext

(

const CovContext &

r

)

~CovContext()

CovContext::~CovContext ( )

virtual

Member Function Documentation

copyCovContext()

void CovContext::copyCovContext	(	const CovContext &	ctxt,
		bool	severe = false
	)

This operation sets the contents of the current CovContext class by copying the information from a source CovContext

Parameters

ctxt	Source CovContext
severe	When severe, does not allow modifying the number of variables

create()

CovContext * CovContext::create ( int  nvar, int  ndim  )

static

createReduce()

const CovContext * CovContext::createReduce

(

const VectorInt &

validVars

)

const

getASpace()

const ASpace* CovContext::getASpace ( ) const

inline

getCovar0() [1/2]

const VectorDouble& CovContext::getCovar0 ( ) const

inline

getCovar0() [2/2]

double CovContext::getCovar0	(	int	ivar,
		int	jvar
	)		const

getField()

double CovContext::getField ( ) const

inline

getMean() [1/2]

const VectorDouble& CovContext::getMean ( ) const

inline

getMean() [2/2]

double CovContext::getMean

(

int

ivar

)

const

getNVar()

int CovContext::getNVar ( ) const

inline

isConsistent()

bool CovContext::isConsistent ( const ASpace *  space ) const

overridevirtual

Indicate if I am consistent with the provided space.

TODO: Consistency of CovContext toward a space: Possible duplicate:

• CovFactory::_isValid
• ACovFunc::isConsistent

Implements ASpaceObject.

isEqual()

bool CovContext::isEqual

(

const CovContext &

r

)

const

Checks that two CovContext are 'similar'

Parameters

r	Secondary CovContext to be compared with this

Returns

operator=()

CovContext & CovContext::operator=

(

const CovContext &

r

)

setCovar0() [1/2]

void CovContext::setCovar0

(

const VectorDouble &

covar0

)

Define the covariance at the origin

Parameters

covar0

Values

setCovar0() [2/2]

void CovContext::setCovar0	(	int	ivar,
		int	jvar,
		double	covar0
	)

setField()

void CovContext::setField ( double  field )

inline

setMean() [1/2]

void CovContext::setMean	(	const double	mean,
		int	ivar = 0
	)

Define the Mean for one variable

Parameters

mean	Value for the mean
ivar	Rank of the variable (starting from 0)

setMean() [2/2]

void CovContext::setMean

(

const VectorDouble &

mean

)

setNVar()

void CovContext::setNVar ( int  nvar )

inline

toString()

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

overridevirtual

AStringable interface.

Reimplemented from ASpaceObject.

---

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

• include/Covariances/CovContext.hpp
• src/Covariances/CovContext.cpp