gstlrn::Constraints Class Reference

#include <Constraints.hpp>

Inheritance diagram for gstlrn::Constraints:

Public Member Functions
	Constraints (double constantSillValue=TEST, const 1 &constantSills=1())
	Constraints (const Constraints &m)
Constraints &	operator= (const Constraints &m)
virtual	~Constraints ()
String	toString (const AStringFormat *strfmt=nullptr) const override
void	addItem (const ConsItem *item)
void	addItemFromParamId (const EConsElem &elem=EConsElem::fromKey("UNKNOWN"), Id icov=0, Id iv1=0, Id iv2=0, const EConsType &type=EConsType::fromKey("DEFAULT"), double value=0.)
Id	isDefined () const
Id	isDefinedForSill () const
Id	getNConsItem () const
const std::vector< ConsItem * > &	getConsItems () const
const ConsItem *	getConsItems (Id i) const
void	modifyConstraintsForSill ()
double	getConstantSillValue () const
const &	getConstantSills () const
double	getConstantSills (Id ivar) const
void	setConstantSillValue (double value)
void	setConstantSills (const 1 &constantSills)
void	expandConstantSill (Id nvar)
bool	isConstraintSillDefined () const
void	setValue (Id item, double value)
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

Constructor & Destructor Documentation

Constraints() [1/2]

gstlrn::Constraints::Constraints	(	double	constantSillValue = TEST,
		const 1 &	constantSills = 1()
	)

Constraints() [2/2]

gstlrn::Constraints::Constraints

(

const Constraints &

m

)

~Constraints()

gstlrn::Constraints::~Constraints ( )

virtual

Member Function Documentation

addItem()

void gstlrn::Constraints::addItem

(

const ConsItem *

item

)

addItemFromParamId()

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

expandConstantSill()

void gstlrn::Constraints::expandConstantSill

(

Id

nvar

)

getConsItems() [1/2]

const std::vector< ConsItem * > & gstlrn::Constraints::getConsItems ( ) const

inline

getConsItems() [2/2]

const ConsItem * gstlrn::Constraints::getConsItems ( Id  i ) const

inline

getConstantSills() [1/2]

const & gstlrn::Constraints::getConstantSills ( ) const

inline

getConstantSills() [2/2]

double gstlrn::Constraints::getConstantSills ( Id  ivar ) const

inline

getConstantSillValue()

double gstlrn::Constraints::getConstantSillValue ( ) const

inline

getNConsItem()

Id gstlrn::Constraints::getNConsItem ( ) const

inline

isConstraintSillDefined()

bool gstlrn::Constraints::isConstraintSillDefined

(

)

const

isDefined()

Id gstlrn::Constraints::isDefined ( ) const

inline

isDefinedForSill()

Id gstlrn::Constraints::isDefinedForSill

(

)

const

modifyConstraintsForSill()

void gstlrn::Constraints::modifyConstraintsForSill

(

)

operator=()

Constraints & gstlrn::Constraints::operator=

(

const Constraints &

m

)

setConstantSills()

void gstlrn::Constraints::setConstantSills ( const 1 &  constantSills )

inline

setConstantSillValue()

void gstlrn::Constraints::setConstantSillValue ( double  value )

inline

setValue()

void gstlrn::Constraints::setValue	(	Id	item,
		double	value
	)

toString()

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

overridevirtual

Reimplemented from gstlrn::AStringable.

---

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

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