1.3.1
CCC
 
RuleProp Class Reference

#include <RuleProp.hpp>

Inheritance diagram for RuleProp:
AStringable

Public Member Functions

 RuleProp ()
 
 RuleProp (const RuleProp &m)
 
RulePropoperator= (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 DbgetDbprop () const
 
void setDbprop (const Db *dbprop)
 
bool isFlagStat () const
 
void setFlagStat (bool flagStat)
 
const VectorDoublegetPropCst () const
 
void setPropCst (const VectorDouble &propcst)
 
const RulegetRule (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)
 
AStringableoperator= (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 RulePropcreateFromDb (const Db *dbprop, const VectorDouble &propcst=VectorDouble())
 
static RulePropcreateFromRule (const Rule *rule, const VectorDouble &propcst=VectorDouble())
 
static RulePropcreateFromRuleAndDb (const Rule *rule, const Db *dbprop)
 
static RulePropcreateFromRules (const Rule *rule1, const Rule *rule2, const VectorDouble &propcst=VectorDouble())
 
static RulePropcreateFromRulesAndDb (const Rule *rule1, const Rule *rule2, const Db *dbprop)
 

Constructor & Destructor Documentation

◆ RuleProp() [1/2]

RuleProp::RuleProp ( )

◆ RuleProp() [2/2]

RuleProp::RuleProp ( const RuleProp m)

◆ ~RuleProp()

RuleProp::~RuleProp ( )
virtual

Member Function Documentation

◆ addRule()

void RuleProp::addRule ( const Rule rule)

◆ categoryToThresh()

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
dbPointer to the Db structure (in/out)
namconvNaming convention
Returns
Error return code

◆ clearRule()

void RuleProp::clearRule ( )

◆ computeAllThreshes()

int RuleProp::computeAllThreshes ( Db db,
const NamingConvention namconv = NamingConvention("Thresh") 
) const

Calculate all the thresholds at each sample of a Db

Parameters
dbPointer to the Db structure (in/out)
namconvNaming convention
Returns
Error return code

◆ createFromDb()

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

◆ createFromRule()

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

◆ createFromRuleAndDb()

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

◆ createFromRules()

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

◆ createFromRulesAndDb()

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

◆ fit()

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

◆ gaussToCategory()

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
dbPointer to the Db structure (in/out)
namconvNaming convention
Returns
Error return code
Remarks
The input variables must be locatorized Z or SIMU

◆ getDbprop()

const Db* RuleProp::getDbprop ( ) const
inline

◆ getPropCst()

const VectorDouble& RuleProp::getPropCst ( ) const
inline

◆ getRule()

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

◆ getRuleNumber()

int RuleProp::getRuleNumber ( ) const
inline

◆ isFlagStat()

bool RuleProp::isFlagStat ( ) const
inline

◆ operator=()

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

◆ resetFromDb()

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
dbpropDb containing the Proportion information (ELoc::P fields)
propcstVector of constant proportions

◆ resetFromRule()

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

◆ resetFromRuleAndDb()

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

◆ resetFromRules()

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

◆ resetFromRulesAndDb()

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

◆ setDbprop()

void RuleProp::setDbprop ( const Db dbprop)
inline

◆ setFlagStat()

void RuleProp::setFlagStat ( bool  flagStat)
inline

◆ setPropCst()

void RuleProp::setPropCst ( const VectorDouble propcst)
inline

◆ toString()

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: