CovCalcMode Class Reference

#include <CovCalcMode.hpp>

Inheritance diagram for CovCalcMode:

Public Member Functions
	CovCalcMode (const ECalcMember &member=ECalcMember::fromKey("LHS"), bool asVario=false, bool normalized=false, bool filterNugget=false, unsigned int keepOnlyCovIdx=-1, bool unitary=false, int envelop=0, int orderVario=0)
	CovCalcMode (const CovCalcMode &r)
CovCalcMode &	operator= (const CovCalcMode &r)
virtual	~CovCalcMode ()
bool	isEqual (const CovCalcMode &r) const
void	update (const ECalcMember &member=ECalcMember::fromKey("LHS"), int nugget_opt=0, int nostd=0, int icov_r=-1, int flag_norm=0, int flag_cov=1)
const ECalcMember &	getMember () const
bool	getAsVario () const
bool	getNormalized () const
bool	isFilterNugget () const
int	getKeepOnlyCovIdx () const
bool	getUnitary () const
int	getOrderVario () const
int	getEnvelop () const
const VectorBool &	getCovFiltered () const
bool	getCovFiltered (int i) const
int	getIndexClass () const
void	setAsVario (bool asVario)
void	setMember (const ECalcMember &member)
void	setFilterNugget (bool filterNugget)
void	setKeepOnlyCovIdx (int keepOnlyCovIdx)
void	setUnitary (bool unitary)
void	setNormalized (bool normalized)
void	setEnvelop (int envelop)
void	setOrderVario (int orderVario)
void	setCovFiltered (const VectorBool &covFiltered)
void	setCovFiltered (int i, bool status)
void	setAllCovFiltered (int ncov, bool status)
void	setIndexClass (int indexClass)
Public Member Functions inherited from AStringable
	AStringable ()
	AStringable (const AStringable &r)
AStringable &	operator= (const AStringable &r)
virtual	~AStringable ()
virtual String	toString (const AStringFormat *strfmt=nullptr) const
virtual void	display (const AStringFormat *strfmt=nullptr) const final
virtual void	display (int level) const final

Private Attributes
ECalcMember	_member
bool	_asVario
bool	_normalized
bool	_filterNugget
int	_keepOnlyCovIdx
bool	_unitary
int	_envelop
int	_orderVario
int	_indexClass
VectorBool	_covFiltered

Constructor & Destructor Documentation

CovCalcMode() [1/2]

CovCalcMode::CovCalcMode	(	const ECalcMember &	member = ECalcMember::fromKey("LHS"),
		bool	asVario = false,
		bool	normalized = false,
		bool	filterNugget = false,
		unsigned int	keepOnlyCovIdx = -1,
		bool	unitary = false,
		int	envelop = 0,
		int	orderVario = 0
	)

CovCalcMode() [2/2]

CovCalcMode::CovCalcMode

(

const CovCalcMode &

r

)

~CovCalcMode()

CovCalcMode::~CovCalcMode ( )

virtual

Member Function Documentation

getAsVario()

bool CovCalcMode::getAsVario ( ) const

inline

getCovFiltered() [1/2]

const VectorBool& CovCalcMode::getCovFiltered ( ) const

inline

getCovFiltered() [2/2]

bool CovCalcMode::getCovFiltered

(

int

i

)

const

getEnvelop()

int CovCalcMode::getEnvelop ( ) const

inline

getIndexClass()

int CovCalcMode::getIndexClass ( ) const

inline

getKeepOnlyCovIdx()

int CovCalcMode::getKeepOnlyCovIdx ( ) const

inline

getMember()

const ECalcMember& CovCalcMode::getMember ( ) const

inline

getNormalized()

bool CovCalcMode::getNormalized ( ) const

inline

getOrderVario()

int CovCalcMode::getOrderVario ( ) const

inline

getUnitary()

bool CovCalcMode::getUnitary ( ) const

inline

isEqual()

bool CovCalcMode::isEqual

(

const CovCalcMode &

r

)

const

isFilterNugget()

bool CovCalcMode::isFilterNugget ( ) const

inline

operator=()

CovCalcMode & CovCalcMode::operator=

(

const CovCalcMode &

r

)

setAllCovFiltered()

void CovCalcMode::setAllCovFiltered	(	int	ncov,
		bool	status
	)

setAsVario()

void CovCalcMode::setAsVario ( bool  asVario )

inline

setCovFiltered() [1/2]

void CovCalcMode::setCovFiltered ( const VectorBool &  covFiltered )

inline

setCovFiltered() [2/2]

void CovCalcMode::setCovFiltered	(	int	i,
		bool	status
	)

setEnvelop()

void CovCalcMode::setEnvelop ( int  envelop )

inline

setFilterNugget()

void CovCalcMode::setFilterNugget ( bool  filterNugget )

inline

setIndexClass()

void CovCalcMode::setIndexClass ( int  indexClass )

inline

setKeepOnlyCovIdx()

void CovCalcMode::setKeepOnlyCovIdx ( int  keepOnlyCovIdx )

inline

setMember()

void CovCalcMode::setMember ( const ECalcMember &  member )

inline

setNormalized()

void CovCalcMode::setNormalized ( bool  normalized )

inline

setOrderVario()

void CovCalcMode::setOrderVario ( int  orderVario )

inline

setUnitary()

void CovCalcMode::setUnitary ( bool  unitary )

inline

update()

void CovCalcMode::update	(	const ECalcMember &	member = ECalcMember::fromKey("LHS"),
		int	nugget_opt = 0,
		int	nostd = 0,
		int	icov_r = -1,
		int	flag_norm = 0,
		int	flag_cov = 1
	)

Update the CovCalcMode structure according to the input arguments

Parameters

member	Member of the Kriging System (ECalcMember) (Default: ECalcMember::LHS)
nugget_opt	Option for nugget effect basic structure (Default: 0) 0 : no particular option 1 : discard the nugget effect -1 : only consider the nugget effect
nostd	0 standard; +-1 special; ITEST normalized (Default: 0)
icov_r	rank of the target covariance or -1 for all (Default: -1)
flag_norm	1 if the model is normalized (Default: 0)
flag_cov	1 if the result must be given in covariance (Default: 1)

Member Data Documentation

_asVario

bool CovCalcMode::_asVario

private

LHS (default), RHS or VAR(IANCE)

_covFiltered

VectorBool CovCalcMode::_covFiltered

private

Index of the working class (used when calculating Covariance)

_envelop

int CovCalcMode::_envelop

private

True to calculate covariance without sill (in Goulard)

_filterNugget

bool CovCalcMode::_filterNugget

private

Normalized variogram

_indexClass

int CovCalcMode::_indexClass

private

Higher Variogram Order (0: standard)

_keepOnlyCovIdx

int CovCalcMode::_keepOnlyCovIdx

private

True to filter nugget structure (default = false)

_member

ECalcMember CovCalcMode::_member

private

_normalized

bool CovCalcMode::_normalized

private

True to calculate variogram and not covariance (default = false)

_orderVario

int CovCalcMode::_orderVario

private

Envelop of Multivariate model: 1(upper) or -1(lower)

_unitary

bool CovCalcMode::_unitary

private

Index of the covariance to be kept (default is -1)

---

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

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