#include <RuleProp.hpp>

Inheritance diagram for RuleProp:

Public Member Functions
	RuleProp ()

	RuleProp (const RuleProp &m)

RuleProp &	operator= (const RuleProp &m)

virtual	~RuleProp ()

virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface to AStringable. More...

int	resetFromDb (const Db *dbprop, const VectorDouble &propcst=VectorDouble())

int	resetFromRule (const Rule *rule, const VectorDouble &propcst=VectorDouble())

int	resetFromRuleAndDb (const Rule rule, const Db dbprop)

int	resetFromRules (const Rule rule1, const Rule rule2, const VectorDouble &propcst=VectorDouble())

int	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 VectorDouble &	getPropCst () const

void	setPropCst (const VectorDouble &propcst)

const Rule *	getRule (int rank=0) const

void	addRule (const Rule *rule)

void	clearRule ()

int	getRuleNumber () const

int	fit (Db db, const VarioParam varioparam, int ngrfmax=1, bool verbose=false)

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

int	categoryToThresh (Db *db, const NamingConvention &namconv=NamingConvention("Bounds")) const

int	computeAllThreshes (Db *db, const NamingConvention &namconv=NamingConvention("Thresh")) const

Public Member Functions inherited from 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 (int level) const final

Static Public Member Functions
static RuleProp *	createFromDb (const Db *dbprop, const VectorDouble &propcst=VectorDouble())

static RuleProp *	createFromRule (const Rule *rule, const VectorDouble &propcst=VectorDouble())

static RuleProp *	createFromRuleAndDb (const Rule rule, const Db dbprop)

static RuleProp *	createFromRules (const Rule rule1, const Rule rule2, const VectorDouble &propcst=VectorDouble())

static RuleProp *	createFromRulesAndDb (const Rule rule1, const Rule rule2, const Db *dbprop)

Constructor & Destructor Documentation

RuleProp::RuleProp ( )

RuleProp::RuleProp ( const RuleProp & m )

RuleProp::~RuleProp ( )

virtual

Member Function Documentation

void RuleProp::addRule ( const Rule * rule )

int 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

void RuleProp::clearRule ( )

int 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

RuleProp * RuleProp::createFromDb	(	const Db *	dbprop,
		const VectorDouble &	propcst = `VectorDouble()`
	)

static

RuleProp * RuleProp::createFromRule	(	const Rule *	rule,
		const VectorDouble &	propcst = `VectorDouble()`
	)

static

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

static

RuleProp * RuleProp::createFromRules	(	const Rule *	rule1,
		const Rule *	rule2,
		const VectorDouble &	propcst = `VectorDouble()`
	)

static

RuleProp * RuleProp::createFromRulesAndDb	(	const Rule *	rule1,
		const Rule *	rule2,
		const Db *	dbprop
	)

static

int RuleProp::fit	(	Db *	db,
		const VarioParam *	varioparam,
		int	ngrfmax = `1`,
		bool	verbose = `false`
	)

int 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

const Db* RuleProp::getDbprop ( ) const

inline

const VectorDouble& RuleProp::getPropCst ( ) const

inline

const Rule * RuleProp::getRule ( int rank = 0 ) const

int RuleProp::getRuleNumber ( ) const

inline

bool RuleProp::isFlagStat ( ) const

inline

RuleProp & RuleProp::operator= ( const RuleProp & m )

int RuleProp::resetFromDb	(	const Db *	dbprop,
		const VectorDouble &	propcst = `VectorDouble()`
	)

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

int RuleProp::resetFromRule	(	const Rule *	rule,
		const VectorDouble &	propcst = `VectorDouble()`
	)

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

int RuleProp::resetFromRules	(	const Rule *	rule1,
		const Rule *	rule2,
		const VectorDouble &	propcst = `VectorDouble()`
	)

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

void RuleProp::setDbprop ( const Db * dbprop )

inline

void RuleProp::setFlagStat ( bool flagStat )

inline

void RuleProp::setPropCst ( const VectorDouble & propcst )

inline

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

overridevirtual

Interface to AStringable.

Reimplemented from AStringable.

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

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

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation