aGrUM 3.1.1
a C++ library for (probabilistic) graphical models
gum::IBayesNetFactory Class Referenceabstract
Bayesian networks

IBayesNetFactory is the non-template interface for BayesNetFactory : many ways to build a BN do not depend on the specification of the GUM_SCALAR template argument (for instance for BN readers). More...

#include <agrum/BN/IBayesNetFactory.h>

Inheritance diagram for gum::IBayesNetFactory:
Collaboration diagram for gum::IBayesNetFactory:

Public Types

enum class  factory_state : char {
  NONE , NETWORK , VARIABLE , PARENTS ,
  RAW_CPT , FACT_CPT , FACT_ENTRY
}
 The enumeration of states in which the factory can be in. More...

Public Member Functions

 IBayesNetFactory ()
virtual ~IBayesNetFactory ()=default
verbosity control
void setVerbose ()
void resetVerbose ()
bool isVerbose ()
virtual const DiscreteVariable & varInBN (NodeId id)=0
 Please.
virtual factory_state state () const =0
 Please.
virtual NodeId variableId (std::string_view name) const =0
 Please.
virtual Size cptDomainSize (NodeId n) const =0
 Please.
virtual void startNetworkDeclaration ()=0
 Please.
virtual void addNetworkProperty (std::string_view propName, std::string_view propValue)=0
 Please.
virtual void endNetworkDeclaration ()=0
 Please.
virtual void startVariableDeclaration ()=0
 Please.
virtual void variableName (std::string_view name)=0
 Please.
virtual void variableDescription (std::string_view desc)=0
 Please.
virtual void variableType (const VarType &type)=0
 Please.
virtual void addModality (std::string_view name)=0
 Please.
virtual void addMin (const long &min)=0
 Please.
virtual void addMax (const long &max)=0
 Please.
virtual void setVariableCPTImplementation (MultiDimAdressable *impl)=0
 Please.
virtual NodeId endVariableDeclaration ()=0
 Please.
virtual void startParentsDeclaration (std::string_view var)=0
 Please.
virtual void addParent (std::string_view var)=0
 Please.
virtual void endParentsDeclaration ()=0
 Please.
virtual void startRawProbabilityDeclaration (std::string_view var)=0
 Please.
virtual void rawConditionalTable (const std::vector< std::string > &variables, const std::vector< float > &rawTable)=0
 Please.
virtual void rawConditionalTable (const std::vector< float > &rawTable)=0
 Please.
virtual void endRawProbabilityDeclaration ()=0
 Please.
virtual void startFactorizedProbabilityDeclaration (std::string_view var)=0
 Please.
virtual void startFactorizedEntry ()=0
 Please.
virtual void endFactorizedEntry ()=0
 Please.
virtual void setParentModality (std::string_view parent, std::string_view modality)=0
 Please.
virtual void setVariableValuesUnchecked (const std::vector< float > &values)=0
 Please.
virtual void setVariableValues (const std::vector< float > &values)=0
 Please.
virtual void endFactorizedProbabilityDeclaration ()=0
 Please.
virtual void setVariable (const DiscreteVariable &var)=0
 Please.
virtual void setVariableCPT (std::string_view varName, MultiDimAdressable *table, bool redefineParents)=0
 Please.

Private Attributes

bool _verbose_

Detailed Description

IBayesNetFactory is the non-template interface for BayesNetFactory : many ways to build a BN do not depend on the specification of the GUM_SCALAR template argument (for instance for BN readers).

Definition at line 70 of file IBayesNetFactory.h.

Member Enumeration Documentation

◆ factory_state

enum class gum::IBayesNetFactory::factory_state : char
strong

The enumeration of states in which the factory can be in.

Every documentation section's name indicates from which state you can call it's methods, and in which state it places the factory.

There is an exception for the delegated CPT definition methods which do not change the state of the factory.

Enumerator
NONE 
NETWORK 
VARIABLE 
PARENTS 
RAW_CPT 
FACT_CPT 
FACT_ENTRY 

Definition at line 81 of file IBayesNetFactory.h.

81 : char {
82 NONE,
83 NETWORK,
84 VARIABLE,
85 PARENTS,
86 RAW_CPT,
87 FACT_CPT,
88 FACT_ENTRY
89 };

Constructor & Destructor Documentation

◆ IBayesNetFactory()

INLINE gum::IBayesNetFactory::IBayesNetFactory ( )

Definition at line 48 of file IBayesNetFactory_inl.h.

48: _verbose_(false) {}

References _verbose_.

◆ ~IBayesNetFactory()

virtual gum::IBayesNetFactory::~IBayesNetFactory ( )
virtualdefault

Member Function Documentation

◆ addMax()

virtual void gum::IBayesNetFactory::addMax ( const long & max)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ addMin()

virtual void gum::IBayesNetFactory::addMin ( const long & min)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ addModality()

virtual void gum::IBayesNetFactory::addModality ( std::string_view name)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ addNetworkProperty()

virtual void gum::IBayesNetFactory::addNetworkProperty ( std::string_view propName,
std::string_view propValue )
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ addParent()

virtual void gum::IBayesNetFactory::addParent ( std::string_view var)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ cptDomainSize()

virtual Size gum::IBayesNetFactory::cptDomainSize ( NodeId n) const
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ endFactorizedEntry()

virtual void gum::IBayesNetFactory::endFactorizedEntry ( )
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ endFactorizedProbabilityDeclaration()

virtual void gum::IBayesNetFactory::endFactorizedProbabilityDeclaration ( )
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ endNetworkDeclaration()

virtual void gum::IBayesNetFactory::endNetworkDeclaration ( )
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ endParentsDeclaration()

virtual void gum::IBayesNetFactory::endParentsDeclaration ( )
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ endRawProbabilityDeclaration()

virtual void gum::IBayesNetFactory::endRawProbabilityDeclaration ( )
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ endVariableDeclaration()

virtual NodeId gum::IBayesNetFactory::endVariableDeclaration ( )
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ isVerbose()

INLINE bool gum::IBayesNetFactory::isVerbose ( )

Definition at line 54 of file IBayesNetFactory_inl.h.

54{ return _verbose_; }

References _verbose_.

◆ rawConditionalTable() [1/2]

virtual void gum::IBayesNetFactory::rawConditionalTable ( const std::vector< float > & rawTable)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ rawConditionalTable() [2/2]

virtual void gum::IBayesNetFactory::rawConditionalTable ( const std::vector< std::string > & variables,
const std::vector< float > & rawTable )
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ resetVerbose()

INLINE void gum::IBayesNetFactory::resetVerbose ( )

Definition at line 52 of file IBayesNetFactory_inl.h.

52{ _verbose_ = false; }

References _verbose_.

Referenced by gum::BayesNetFactory< GUM_SCALAR >::BayesNetFactory().

Here is the caller graph for this function:

◆ setParentModality()

virtual void gum::IBayesNetFactory::setParentModality ( std::string_view parent,
std::string_view modality )
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ setVariable()

virtual void gum::IBayesNetFactory::setVariable ( const DiscreteVariable & var)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ setVariableCPT()

virtual void gum::IBayesNetFactory::setVariableCPT ( std::string_view varName,
MultiDimAdressable * table,
bool redefineParents )
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ setVariableCPTImplementation()

virtual void gum::IBayesNetFactory::setVariableCPTImplementation ( MultiDimAdressable * impl)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ setVariableValues()

virtual void gum::IBayesNetFactory::setVariableValues ( const std::vector< float > & values)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ setVariableValuesUnchecked()

virtual void gum::IBayesNetFactory::setVariableValuesUnchecked ( const std::vector< float > & values)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ setVerbose()

INLINE void gum::IBayesNetFactory::setVerbose ( )

Definition at line 50 of file IBayesNetFactory_inl.h.

50{ _verbose_ = true; }

References _verbose_.

◆ startFactorizedEntry()

virtual void gum::IBayesNetFactory::startFactorizedEntry ( )
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ startFactorizedProbabilityDeclaration()

virtual void gum::IBayesNetFactory::startFactorizedProbabilityDeclaration ( std::string_view var)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ startNetworkDeclaration()

virtual void gum::IBayesNetFactory::startNetworkDeclaration ( )
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ startParentsDeclaration()

virtual void gum::IBayesNetFactory::startParentsDeclaration ( std::string_view var)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ startRawProbabilityDeclaration()

virtual void gum::IBayesNetFactory::startRawProbabilityDeclaration ( std::string_view var)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ startVariableDeclaration()

virtual void gum::IBayesNetFactory::startVariableDeclaration ( )
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ state()

virtual factory_state gum::IBayesNetFactory::state ( ) const
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ variableDescription()

virtual void gum::IBayesNetFactory::variableDescription ( std::string_view desc)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ variableId()

virtual NodeId gum::IBayesNetFactory::variableId ( std::string_view name) const
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ variableName()

virtual void gum::IBayesNetFactory::variableName ( std::string_view name)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ variableType()

virtual void gum::IBayesNetFactory::variableType ( const VarType & type)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

◆ varInBN()

virtual const DiscreteVariable & gum::IBayesNetFactory::varInBN ( NodeId id)
pure virtual

Please.

See also
BayesNetFactory<GUM_SCALAR> for documentation.

Implemented in gum::BayesNetFactory< GUM_SCALAR >.

Member Data Documentation

◆ _verbose_

bool gum::IBayesNetFactory::_verbose_
private

Definition at line 151 of file IBayesNetFactory.h.

Referenced by IBayesNetFactory(), isVerbose(), resetVerbose(), and setVerbose().

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

© PHW&CG&others - 2022
DoXyGeN 1.16.1