gstlrn::ConsItem Class Reference

#include <ConsItem.hpp>

Inheritance diagram for gstlrn::ConsItem:

Detailed Description

This class is used:

• to define the constraints for the Model Automatic Fitting (authAssign true)
• to define the non-stationary parameters of a Model

Public Member Functions
	ConsItem (const CovParamId &paramid, const EConsType &type=EConsType::fromKey("DEFAULT"), double value=0.)
	ConsItem (const ConsItem &m)
ConsItem &	operator= (const ConsItem &m)
virtual	~ConsItem ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	ICloneable interface.
const EConsElem &	getType () const
Id	getIGrf () const
Id	getICov () const
Id	getIV1 () const
Id	getIV2 () const
void	setValue (double value)
void	setIcase (const EConsType &type)
const EConsType &	getIcase () const
double	getValue () const
bool	matchIGrf (Id igrf0) const
bool	matchICov (Id icov0) const
bool	matchType (const EConsElem &type0) const
bool	matchIV1 (Id iv10) const
bool	matchIV2 (Id iv20) const
const CovParamId &	getParamId () 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
Public Member Functions inherited from gstlrn::ICloneable
	ICloneable ()
virtual	~ICloneable ()
virtual ICloneable *	clone () const =0
std::shared_ptr< ICloneable >	cloneShared () const
std::unique_ptr< ICloneable >	cloneUnique () const

Static Public Member Functions
static ConsItem *	create (const CovParamId &paramid, const EConsType &type=EConsType::fromKey("DEFAULT"), double value=0.)
static ConsItem *	createFromParamId (Id icov=0, const EConsElem &elem=EConsElem::fromKey("UNKNOWN"), const EConsType &type=EConsType::fromKey("DEFAULT"), double value=0., Id igrf=0, Id iv1=0, Id iv2=0)
static ConsItem	define (const EConsElem &elem=EConsElem::fromKey("UNKNOWN"), Id icov=0, Id iv1=0, Id iv2=0, const EConsType &type=EConsType::fromKey("DEFAULT"), double value=0.)

Constructor & Destructor Documentation

ConsItem() [1/2]

gstlrn::ConsItem::ConsItem	(	const CovParamId &	paramid,
		const EConsType &	type = EConsType::fromKey("DEFAULT"),
		double	value = 0.
	)

ConsItem() [2/2]

gstlrn::ConsItem::ConsItem

(

const ConsItem &

m

)

~ConsItem()

gstlrn::ConsItem::~ConsItem ( )

virtual

Member Function Documentation

create()

ConsItem * gstlrn::ConsItem::create ( const CovParamId &  paramid, const EConsType &  type = EConsType::fromKey("DEFAULT"), double  value = 0.  )

static

createFromParamId()

ConsItem * gstlrn::ConsItem::createFromParamId ( Id  icov = 0, const EConsElem &  elem = EConsElem::fromKey("UNKNOWN"), const EConsType &  type = EConsType::fromKey("DEFAULT"), double  value = 0., Id  igrf = 0, Id  iv1 = 0, Id  iv2 = 0  )

static

define()

ConsItem gstlrn::ConsItem::define ( const EConsElem &  elem = EConsElem::fromKey("UNKNOWN"), Id  icov = 0, Id  iv1 = 0, Id  iv2 = 0, const EConsType &  type = EConsType::fromKey("DEFAULT"), double  value = 0.  )

static

This function creates a constraints on a parameter This constraint will be used subsequently during the variogram fitting

Parameters

elem	The type of item on which the constraints applies (EConsElem.hpp)
icov	The rank of the covariance
iv1	The rank of the first variable
iv2	The rank of the second variable
type	The type of constraints (EConsType.hpp)
value	The value assigned to the constraint

Remarks

Do not forget to delete object after usage

Returns

getIcase()

const EConsType & gstlrn::ConsItem::getIcase ( ) const

inline

getICov()

Id gstlrn::ConsItem::getICov ( ) const

inline

getIGrf()

Id gstlrn::ConsItem::getIGrf ( ) const

inline

getIV1()

Id gstlrn::ConsItem::getIV1 ( ) const

inline

getIV2()

Id gstlrn::ConsItem::getIV2 ( ) const

inline

getParamId()

const CovParamId & gstlrn::ConsItem::getParamId ( ) const

inline

getType()

const EConsElem & gstlrn::ConsItem::getType ( ) const

inline

getValue()

double gstlrn::ConsItem::getValue ( ) const

inline

matchICov()

bool gstlrn::ConsItem::matchICov ( Id  icov0 ) const

inline

matchIGrf()

bool gstlrn::ConsItem::matchIGrf ( Id  igrf0 ) const

inline

matchIV1()

bool gstlrn::ConsItem::matchIV1 ( Id  iv10 ) const

inline

matchIV2()

bool gstlrn::ConsItem::matchIV2 ( Id  iv20 ) const

inline

matchType()

bool gstlrn::ConsItem::matchType ( const EConsElem &  type0 ) const

inline

operator=()

ConsItem & gstlrn::ConsItem::operator=

(

const ConsItem &

m

)

setIcase()

void gstlrn::ConsItem::setIcase ( const EConsType &  type )

inline

setValue()

void gstlrn::ConsItem::setValue ( double  value )

inline

toString()

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

overridevirtual

ICloneable interface.

AStringable Interface

Reimplemented from gstlrn::AStringable.

---

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

• include/Model/ConsItem.hpp
• src/Model/ConsItem.cpp