gstlrn::CovContext Class Reference

#include <CovContext.hpp>

Inheritance diagram for gstlrn::CovContext:

Public Member Functions
	CovContext (Id nvar=1, const ASpaceSharedPtr &space=ASpaceSharedPtr())
	CovContext (Id nvar, Id ndim, const 1 &covar0=1())
	CovContext (const Db *db, const ASpaceSharedPtr &space=ASpaceSharedPtr())
	CovContext (const Vario *vario)
	CovContext (const CovContext &r)
CovContext &	operator= (const CovContext &r)
virtual	~CovContext ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	AStringable interface.
bool	isConsistent (const ASpace *space) const override
	Indicate if I am consistent with the provided space.
bool	isEqual (const CovContext &r) const
Id	getNVar () const
double	getField () const
const &	getCovar0 () const
double	getCovar0 (Id ivar, Id jvar) const
void	setNVar (Id nvar)
void	setField (double field)
void	setCovar0s (const 1 &covar0)
void	setCovar0 (Id ivar, Id jvar, double covar0)
void	copyCovContext (const CovContext &ctxt, bool severe=false)
const CovContext *	createReduce (const 1 &validVars) const
Public Member Functions inherited from gstlrn::ASpaceObject
	ASpaceObject (const ASpaceSharedPtr &space=ASpaceSharedPtr())
	ASpaceObject (const ASpaceObject &r)
ASpaceObject &	operator= (const ASpaceObject &r)
virtual	~ASpaceObject ()
ASpaceSharedPtr	getSpace () const
	Accessor to the current object space context.
bool	isConsistent () const
	Indicate if I am consistent with my current space context.
void	setSpace (ASpaceSharedPtr &&space)
	getUnitaryVector () const
	Return unitary vector for the current space context.
bool	isConsistent (const ASpaceSharedPtr &space) const
	Indicate if I am consistent with the provided space.
size_t	getNDim (Id ispace=-1) const
	Shortcuts to ASpace methods.
const &	getOrigin (Id ispace=-1) const
	Return the current space context origin coordinates.
double	getDistance (const SpacePoint &p1, const SpacePoint &p2, Id ispace=0) const
	Return the distance between two space points for the current space context.
	getDistances (const SpacePoint &p1, const SpacePoint &p2) const
	Return all the distances (space composits) between two space points for the current space context.
	getIncrement (const SpacePoint &p1, const SpacePoint &p2, Id ispace=0) const
	Return the increment vector between two space points for the current space context.
void	getIncrementInPlace (const SpacePoint &p1, const SpacePoint &p2, 1 &ptemp, Id ispace=-1) 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

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

Constructor & Destructor Documentation

CovContext() [1/5]

gstlrn::CovContext::CovContext	(	Id	nvar = 1,
		const ASpaceSharedPtr &	space = ASpaceSharedPtr()
	)

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

Parameters

nvar	Number of variables
space	Space definition

CovContext() [2/5]

gstlrn::CovContext::CovContext	(	Id	nvar,
		Id	ndim,
		const 1 &	covar0 = 1()
	)

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)
covar0	Vector of variance-covariance

CovContext() [3/5]

gstlrn::CovContext::CovContext	(	const Db *	db,
		const ASpaceSharedPtr &	space = ASpaceSharedPtr()
	)

TODO : check Db dimension vs provided space

CovContext() [4/5]

gstlrn::CovContext::CovContext

(

const Vario *

vario

)

TODO : check vario dimension vs provided space

CovContext() [5/5]

gstlrn::CovContext::CovContext

(

const CovContext &

r

)

~CovContext()

gstlrn::CovContext::~CovContext ( )

virtual

Member Function Documentation

copyCovContext()

void gstlrn::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 * gstlrn::CovContext::create ( Id  nvar, Id  ndim  )

static

createReduce()

const CovContext * gstlrn::CovContext::createReduce

(

const 1 &

validVars

)

const

getCovar0() [1/2]

const & gstlrn::CovContext::getCovar0 ( ) const

inline

getCovar0() [2/2]

double gstlrn::CovContext::getCovar0	(	Id	ivar,
		Id	jvar
	)		const

getField()

double gstlrn::CovContext::getField ( ) const

inline

getNVar()

Id gstlrn::CovContext::getNVar ( ) const

inline

isConsistent()

bool gstlrn::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 gstlrn::ASpaceObject.

isEqual()

bool gstlrn::CovContext::isEqual

(

const CovContext &

r

)

const

Checks that two CovContext are 'similar'

Parameters

r	Secondary CovContext to be compared with this

Returns

operator=()

CovContext & gstlrn::CovContext::operator=

(

const CovContext &

r

)

setCovar0()

void gstlrn::CovContext::setCovar0	(	Id	ivar,
		Id	jvar,
		double	covar0
	)

setCovar0s()

void gstlrn::CovContext::setCovar0s

(

const 1 &

covar0

)

Define the covariance at the origin

Parameters

covar0

Values

setField()

void gstlrn::CovContext::setField ( double  field )

inline

setNVar()

void gstlrn::CovContext::setNVar ( Id  nvar )

inline

toString()

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

overridevirtual

AStringable interface.

Reimplemented from gstlrn::ASpaceObject.

---

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

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