gstlrn::RuleProp Class Reference

#include <RuleProp.hpp>

Inheritance diagram for gstlrn::RuleProp:

Public Member Functions
	RuleProp ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface to AStringable.
Id	resetFromDb (const Db *dbprop, const 1 &propcst=1())
Id	resetFromRule (const Rule *rule, const 1 &propcst=1())
Id	resetFromRuleAndDb (const Rule *rule, const Db *dbprop)
Id	resetFromRules (const Rule *rule1, const Rule *rule2, const 1 &propcst=1())
Id	resetFromRulesAndDb (const Rule *rule1, const Rule *rule2, const Db *dbprop)
const Db *	getDbprop () const
void	setDbprop (const Db *dbprop)
bool	isFlagStat () const
void	setFlagStat (bool flagStat)
const &	getPropCst () const
void	setPropCst (const 1 &propcst)
const Rule *	getRule (Id rank=0) const
void	addRule (const Rule &rule)
void	clearRule ()
Id	getNRule () const
std::vector< Rule >	fit (Db *db, const VarioParam *varioparam, Id ngrfmax, bool use_discrete=false, bool verbose=false)
	Returns the list of potential Rule arrangements, sorted by incrasing scores.
Id	gaussToCategory (Db *db, const NamingConvention &namconv=NamingConvention("Facies", true, true, true, ELoc::fromKey("FACIES"))) const
Id	categoryToThresh (Db *db, const NamingConvention &namconv=NamingConvention("Bounds")) const
Id	computeAllThreshes (Db *db, const NamingConvention &namconv=NamingConvention("Thresh")) 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
void	printConcreteClassName () const

Static Public Member Functions
static RuleProp *	createFromDb (const Db *dbprop, const 1 &propcst=1())
static RuleProp *	createFromRule (const Rule *rule, const 1 &propcst=1())
static RuleProp *	createFromRuleAndDb (const Rule *rule, const Db *dbprop)
static RuleProp *	createFromRules (const Rule *rule1, const Rule *rule2, const 1 &propcst=1())

Constructor & Destructor Documentation

RuleProp()

gstlrn::RuleProp::RuleProp

(

)

Member Function Documentation

addRule()

void gstlrn::RuleProp::addRule

(

const Rule &

rule

)

categoryToThresh()

Id gstlrn::RuleProp::categoryToThresh	(	Db *	db,
		const NamingConvention &	namconv = NamingConvention("Bounds")
	)		const

Derive the bounds variables for a Db (depending on the Category information of each sample)

Parameters

db	Pointer to the Db structure (in/out)
namconv	Naming convention

Returns

Error return code

clearRule()

void gstlrn::RuleProp::clearRule

(

)

computeAllThreshes()

Id gstlrn::RuleProp::computeAllThreshes	(	Db *	db,
		const NamingConvention &	namconv = NamingConvention("Thresh")
	)		const

Calculate all the thresholds at each sample of a Db

Parameters

db	Pointer to the Db structure (in/out)
namconv	Naming convention

Returns

Error return code

createFromDb()

RuleProp * gstlrn::RuleProp::createFromDb ( const Db *  dbprop, const 1 &  propcst = 1()  )

static

createFromRule()

RuleProp * gstlrn::RuleProp::createFromRule ( const Rule *  rule, const 1 &  propcst = 1()  )

static

createFromRuleAndDb()

RuleProp * gstlrn::RuleProp::createFromRuleAndDb ( const Rule *  rule, const Db *  dbprop  )

static

createFromRules()

RuleProp * gstlrn::RuleProp::createFromRules ( const Rule *  rule1, const Rule *  rule2, const 1 &  propcst = 1()  )

static

fit()

std::vector< Rule > gstlrn::RuleProp::fit	(	Db *	db,
		const VarioParam *	varioparam,
		Id	ngrfmax,
		bool	use_discrete = false,
		bool	verbose = false
	)

Returns the list of potential Rule arrangements, sorted by incrasing scores.

Parameters

db	Descritpion of the input Data Base
varioparam	Description of the manner to calculate the experimental indicator variograms
ngrfmax	Maximim number of GRFs to be tested in the optimal Rules
use_discrete	When True, use the numerical integration of Gaussian(s)
verbose	Verbose flag

Returns

List of potential Rule arrangements defined by pointers

gaussToCategory()

Id gstlrn::RuleProp::gaussToCategory	(	Db *	db,
		const NamingConvention &	namconv = NamingConvention("Facies", true, true, true, ELoc::fromKey("FACIES"))
	)		const

Convert a set of Gaussian vectors into the corresponding Facies in a Db

Parameters

db	Pointer to the Db structure (in/out)
namconv	Naming convention

Returns

Error return code

Remarks

The input variables must be locatorized Z or SIMU

getDbprop()

const Db * gstlrn::RuleProp::getDbprop ( ) const

inline

getNRule()

Id gstlrn::RuleProp::getNRule

(

)

const

getPropCst()

const & gstlrn::RuleProp::getPropCst ( ) const

inline

getRule()

const Rule * gstlrn::RuleProp::getRule

(

Id

rank = 0

)

const

isFlagStat()

bool gstlrn::RuleProp::isFlagStat ( ) const

inline

resetFromDb()

Id gstlrn::RuleProp::resetFromDb	(	const Db *	dbprop,
		const 1 &	propcst = 1()
	)

This constructor is used in the exceptional case where the Rule is not yet defined (typically when inferring the Rule)

Parameters

dbprop	Db containing the Proportion information (ELoc::P fields)
propcst	Vector of constant proportions

resetFromRule()

Id gstlrn::RuleProp::resetFromRule	(	const Rule *	rule,
		const 1 &	propcst = 1()
	)

resetFromRuleAndDb()

Id gstlrn::RuleProp::resetFromRuleAndDb	(	const Rule *	rule,
		const Db *	dbprop
	)

resetFromRules()

Id gstlrn::RuleProp::resetFromRules	(	const Rule *	rule1,
		const Rule *	rule2,
		const 1 &	propcst = 1()
	)

resetFromRulesAndDb()

Id gstlrn::RuleProp::resetFromRulesAndDb	(	const Rule *	rule1,
		const Rule *	rule2,
		const Db *	dbprop
	)

setDbprop()

void gstlrn::RuleProp::setDbprop ( const Db *  dbprop )

inline

setFlagStat()

void gstlrn::RuleProp::setFlagStat ( bool  flagStat )

inline

setPropCst()

void gstlrn::RuleProp::setPropCst ( const 1 &  propcst )

inline

toString()

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

overridevirtual

Interface to AStringable.

Reimplemented from gstlrn::AStringable.

---

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

• include/LithoRule/RuleProp.hpp
• src/LithoRule/RuleProp.cpp