gum::GibbsSampling< GUM_SCALAR > Class Template Reference

<agrum/BN/inference/gibbsSampling.h> More...

#include <GibbsSampling.h>

Inheritance diagram for gum::GibbsSampling< GUM_SCALAR >:

Collaboration diagram for gum::GibbsSampling< GUM_SCALAR >:

Public Attributes
Signaler3< Size, double, double >	onProgress
	Progression, error and time. More...
Signaler1< std::string >	onStop
	Criteria messageApproximationScheme. More...

Public Member Functions
	GibbsSampling (const IBayesNet< GUM_SCALAR > *bn)
	Default constructor. More...
	~GibbsSampling () override
	Destructor. More...
void	setBurnIn (Size b)
	Number of burn in for one iteration. More...
Size	burnIn () const
	Returns the number of burn in. More...
virtual void	contextualize ()
	Simplifying the Bayesian network with relevance reasonning to lighten the computational charge. More...
Potential< GUM_SCALAR >	evidenceImpact (NodeId target, const NodeSet &evs)
	Create a gum::Potential for P(target|evs) (for all instanciation of target and evs) More...
Potential< GUM_SCALAR >	evidenceImpact (const std::string &target, const std::vector< std::string > &evs)
	Create a gum::Potential for P(target|evs) (for all instanciation of target and evs) More...
Size	nbrDrawnVar () const
	Getters and setters. More...
void	setNbrDrawnVar (Size nbr)
bool	isDrawnAtRandom () const
void	setDrawnAtRandom (bool atRandom)
Instantiation	monteCarloSample ()
	draws a Monte Carlo sample More...
Instantiation	nextSample (Instantiation prev)
	draws next sample of Gibbs sampling More...
Constructors / Destructors
const Potential< GUM_SCALAR > &	currentPosterior (NodeId id)
	Computes and returns the actual estimation of the posterior of a node. More...
const Potential< GUM_SCALAR > &	currentPosterior (const std::string &name)
	Computes and returns the actual estimation of the posterior of a node by its name. More...
Probability computations
const IBayesNet< GUM_SCALAR > &	samplingBN ()
	get the BayesNet which is used to really perform the sampling More...
const Potential< GUM_SCALAR > &	posterior_ (NodeId id) override
	Computes and returns the posterior of a node. More...
Estimator objects initializing
virtual void	setEstimatorFromBN_ ()
	Initializes the estimators object linked to the simulation. More...
virtual void	setEstimatorFromLBP_ (LoopyBeliefPropagation< GUM_SCALAR > *lbp, GUM_SCALAR virtualLBPSize)
	Initializes the estimators object linked to the simulation. More...
Probability computations
virtual const Potential< GUM_SCALAR > &	posterior (NodeId node)
	Computes and returns the posterior of a node. More...
virtual const Potential< GUM_SCALAR > &	posterior (const std::string &nodeName)
	Computes and returns the posterior of a node. More...
Targets
virtual void	eraseAllTargets ()
	Clear all previously defined targets. More...
virtual void	addAllTargets () final
	adds all nodes as targets More...
virtual void	addTarget (NodeId target) final
	Add a marginal target to the list of targets. More...
virtual void	addTarget (const std::string &nodeName) final
	Add a marginal target to the list of targets. More...
virtual void	eraseTarget (NodeId target) final
	removes an existing (marginal) target More...
virtual void	eraseTarget (const std::string &nodeName) final
	removes an existing (marginal) target More...
virtual bool	isTarget (NodeId node) const final
	return true if variable is a (marginal) target More...
virtual bool	isTarget (const std::string &nodeName) const final
	return true if variable is a (marginal) target More...
virtual const Size	nbrTargets () const noexcept final
	returns the number of marginal targets More...
virtual const NodeSet &	targets () const noexcept final
	returns the list of marginal targets More...
Information Theory related functions
virtual GUM_SCALAR	H (NodeId X) final
	Entropy Compute Shanon's entropy of a node given the observation. More...
virtual GUM_SCALAR	H (const std::string &nodeName) final
	Entropy Compute Shanon's entropy of a node given the observation. More...
Accessors / Modifiers
virtual void	setBN (const IBayesNet< GUM_SCALAR > *bn)
	assigns a new BN to the inference engine More...
virtual const IBayesNet< GUM_SCALAR > &	BN () const final
	Returns a constant reference over the IBayesNet referenced by this class. More...
Accessors / Modifiers
virtual const GraphicalModel &	model () const final
	Returns a constant reference over the IBayesNet referenced by this class. More...
virtual const NodeProperty< Size > &	domainSizes () const final
	get the domain sizes of the random variables of the model More...
virtual bool	isInferenceReady () const noexcept final
	returns whether the inference object is in a ready state More...
virtual bool	isInferenceOutdatedStructure () const noexcept final
	returns whether the inference object is in a OutdatedStructure state More...
virtual bool	isInferenceOutdatedPotentials () const noexcept final
	returns whether the inference object is in a OutdatedPotential state More...
virtual bool	isInferenceDone () const noexcept final
	returns whether the inference object is in a InferenceDone state More...
virtual void	prepareInference () final
	prepare the internal inference structures for the next inference More...
virtual void	makeInference () final
	perform the heavy computations needed to compute the targets' posteriors More...
virtual void	clear ()
	clears all the data structures allocated for the last inference More...
virtual StateOfInference	state () const noexcept final
	returns the state of the inference engine More...
Evidence
virtual void	addEvidence (NodeId id, const Idx val) final
	adds a new hard evidence on node id More...
virtual void	addEvidence (const std::string &nodeName, const Idx val) final
	adds a new hard evidence on node named nodeName More...
virtual void	addEvidence (NodeId id, const std::string &label) final
	adds a new hard evidence on node id More...
virtual void	addEvidence (const std::string &nodeName, const std::string &label) final
	adds a new hard evidence on node named nodeName More...
virtual void	addEvidence (NodeId id, const std::vector< GUM_SCALAR > &vals) final
	adds a new evidence on node id (might be soft or hard) More...
virtual void	addEvidence (const std::string &nodeName, const std::vector< GUM_SCALAR > &vals) final
	adds a new evidence on node named nodeName (might be soft or hard) More...
virtual void	addEvidence (const Potential< GUM_SCALAR > &pot) final
	adds a new evidence on node id (might be soft or hard) More...
virtual void	addEvidence (Potential< GUM_SCALAR > &&pot) final
	adds a new evidence on node id (might be soft or hard) More...
virtual void	addSetOfEvidence (const Set< const Potential< GUM_SCALAR > * > &potset) final
	adds a new set of evidence More...
virtual void	addListOfEvidence (const List< const Potential< GUM_SCALAR > * > &potlist) final
	adds a new list of evidence More...
virtual void	chgEvidence (NodeId id, const Idx val) final
	change the value of an already existing hard evidence More...
virtual void	chgEvidence (const std::string &nodeName, const Idx val) final
	change the value of an already existing hard evidence More...
virtual void	chgEvidence (NodeId id, const std::string &label) final
	change the value of an already existing hard evidence More...
virtual void	chgEvidence (const std::string &nodeName, const std::string &label) final
	change the value of an already existing hard evidence More...
virtual void	chgEvidence (NodeId id, const std::vector< GUM_SCALAR > &vals) final
	change the value of an already existing evidence (might be soft or hard) More...
virtual void	chgEvidence (const std::string &nodeName, const std::vector< GUM_SCALAR > &vals) final
	change the value of an already existing evidence (might be soft or hard) More...
virtual void	chgEvidence (const Potential< GUM_SCALAR > &pot) final
	change the value of an already existing evidence (might be soft or hard) More...
virtual void	eraseAllEvidence () final
	removes all the evidence entered into the network More...
virtual void	eraseEvidence (NodeId id) final
	removed the evidence, if any, corresponding to node id More...
virtual void	eraseEvidence (const std::string &nodeName) final
	removed the evidence, if any, corresponding to node of name nodeName More...
virtual bool	hasEvidence () const final
	indicates whether some node(s) have received evidence More...
virtual bool	hasEvidence (NodeId id) const final
	indicates whether node id has received an evidence More...
virtual bool	hasEvidence (const std::string &nodeName) const final
	indicates whether node id has received an evidence More...
virtual bool	hasHardEvidence (NodeId id) const final
	indicates whether node id has received a hard evidence More...
virtual bool	hasHardEvidence (const std::string &nodeName) const final
	indicates whether node id has received a hard evidence More...
virtual bool	hasSoftEvidence (NodeId id) const final
	indicates whether node id has received a soft evidence More...
virtual bool	hasSoftEvidence (const std::string &nodeName) const final
	indicates whether node id has received a soft evidence More...
virtual Size	nbrEvidence () const final
	returns the number of evidence entered into the Bayesian network More...
virtual Size	nbrHardEvidence () const final
	returns the number of hard evidence entered into the Bayesian network More...
virtual Size	nbrSoftEvidence () const final
	returns the number of soft evidence entered into the Bayesian network More...
const NodeProperty< const Potential< GUM_SCALAR > *> &	evidence () const
	returns the set of evidence More...
const NodeSet &	softEvidenceNodes () const
	returns the set of nodes with soft evidence More...
const NodeSet &	hardEvidenceNodes () const
	returns the set of nodes with hard evidence More...
const NodeProperty< Idx > &	hardEvidence () const
	indicate for each node with hard evidence which value it took More...
Getters and setters
void	setEpsilon (double eps)
	Given that we approximate f(t), stopping criterion on |f(t+1)-f(t)|. More...
double	epsilon () const
	Returns the value of epsilon. More...
void	disableEpsilon ()
	Disable stopping criterion on epsilon. More...
void	enableEpsilon ()
	Enable stopping criterion on epsilon. More...
bool	isEnabledEpsilon () const
	Returns true if stopping criterion on epsilon is enabled, false otherwise. More...
void	setMinEpsilonRate (double rate)
	Given that we approximate f(t), stopping criterion on d/dt(|f(t+1)-f(t)|). More...
double	minEpsilonRate () const
	Returns the value of the minimal epsilon rate. More...
void	disableMinEpsilonRate ()
	Disable stopping criterion on epsilon rate. More...
void	enableMinEpsilonRate ()
	Enable stopping criterion on epsilon rate. More...
bool	isEnabledMinEpsilonRate () const
	Returns true if stopping criterion on epsilon rate is enabled, false otherwise. More...
void	setMaxIter (Size max)
	Stopping criterion on number of iterations. More...
Size	maxIter () const
	Returns the criterion on number of iterations. More...
void	disableMaxIter ()
	Disable stopping criterion on max iterations. More...
void	enableMaxIter ()
	Enable stopping criterion on max iterations. More...
bool	isEnabledMaxIter () const
	Returns true if stopping criterion on max iterations is enabled, false otherwise. More...
void	setMaxTime (double timeout)
	Stopping criterion on timeout. More...
double	maxTime () const
	Returns the timeout (in seconds). More...
double	currentTime () const
	Returns the current running time in second. More...
void	disableMaxTime ()
	Disable stopping criterion on timeout. More...
void	enableMaxTime ()
	Enable stopping criterion on timeout. More...
bool	isEnabledMaxTime () const
	Returns true if stopping criterion on timeout is enabled, false otherwise. More...
void	setPeriodSize (Size p)
	How many samples between two stopping is enable. More...
Size	periodSize () const
	Returns the period size. More...
void	setVerbosity (bool v)
	Set the verbosity on (true) or off (false). More...
bool	verbosity () const
	Returns true if verbosity is enabled. More...
ApproximationSchemeSTATE	stateApproximationScheme () const
	Returns the approximation scheme state. More...
Size	nbrIterations () const
	Returns the number of iterations. More...
const std::vector< double > &	history () const
	Returns the scheme history. More...
void	initApproximationScheme ()
	Initialise the scheme. More...
bool	startOfPeriod ()
	Returns true if we are at the beginning of a period (compute error is mandatory). More...
void	updateApproximationScheme (unsigned int incr=1)
	Update the scheme w.r.t the new error and increment steps. More...
Size	remainingBurnIn ()
	Returns the remaining burn in. More...
void	stopApproximationScheme ()
	Stop the approximation scheme. More...
bool	continueApproximationScheme (double error)
	Update the scheme w.r.t the new error. More...
Getters and setters
std::string	messageApproximationScheme () const
	Returns the approximation scheme message. More...

Public Types
enum	StateOfInference { StateOfInference::OutdatedStructure, StateOfInference::OutdatedPotentials, StateOfInference::ReadyForInference, StateOfInference::Done }
	current state of the inference More...
enum	ApproximationSchemeSTATE : char {   ApproximationSchemeSTATE::Undefined, ApproximationSchemeSTATE::Continue, ApproximationSchemeSTATE::Epsilon, ApproximationSchemeSTATE::Rate,   ApproximationSchemeSTATE::Limit, ApproximationSchemeSTATE::TimeLimit, ApproximationSchemeSTATE::Stopped }
	The different state of an approximation scheme. More...

Protected Attributes
Estimator< GUM_SCALAR >	_estimator_
	Estimator object designed to approximate target posteriors. More...
bool	isSetEstimator = false
	whether the Estimator object has been initialized More...
bool	isContextualized = false
	whether the referenced Bayesian network has been "contextualized" More...
double	current_epsilon_
	Current epsilon. More...
double	last_epsilon_
	Last epsilon value. More...
double	current_rate_
	Current rate. More...
Size	current_step_
	The current step. More...
Timer	timer_
	The timer. More...
ApproximationSchemeSTATE	current_state_
	The current state. More...
std::vector< double >	history_
	The scheme history, used only if verbosity == true. More...
double	eps_
	Threshold for convergence. More...
bool	enabled_eps_
	If true, the threshold convergence is enabled. More...
double	min_rate_eps_
	Threshold for the epsilon rate. More...
bool	enabled_min_rate_eps_
	If true, the minimal threshold for epsilon rate is enabled. More...
double	max_time_
	The timeout. More...
bool	enabled_max_time_
	If true, the timeout is enabled. More...
Size	max_iter_
	The maximum iterations. More...
bool	enabled_max_iter_
	If true, the maximum iterations stopping criterion is enabled. More...
Size	burn_in_
	Number of iterations before checking stopping criteria. More...
Size	period_size_
	Checking criteria frequency. More...
bool	verbosity_
	If true, verbosity is enabled. More...
Size	counting_
const IBayesNet< GUM_SCALAR > &	samplingBn_
const NodeProperty< Idx > *	hardEv_
Sequence< NodeId >	samplingNodes_
Size	nbr_
bool	atRandom_

Protected Member Functions
Instantiation	burnIn_ () override
	draws a defined number of samples without updating the estimators More...
Instantiation	draw_ (GUM_SCALAR *w, Instantiation prev) override
	draws a sample given previous one according to Gibbs sampling More...
Instantiation	monteCarloSample_ ()
	draws a Monte Carlo sample More...
void	makeInference_ () override
	makes the inference by generating samples More...
void	loopApproxInference_ ()
virtual void	addVarSample_ (NodeId nod, Instantiation *I)
	adds a node to current instantiation More...
virtual void	onContextualize_ (BayesNetFragment< GUM_SCALAR > *bn)
	fired when Bayesian network is contextualized More...
void	onEvidenceAdded_ (const NodeId id, bool isHardEvidence) override
	fired after a new evidence is inserted More...
void	onEvidenceErased_ (const NodeId id, bool isHardEvidence) override
	fired before an evidence is removed More...
void	onAllEvidenceErased_ (bool contains_hard_evidence) override
	fired before all the evidence are erased More...
void	onEvidenceChanged_ (const NodeId id, bool hasChangedSoftHard) override
	fired after an evidence is changed, in particular when its status (soft/hard) changes More...
void	onModelChanged_ (const GraphicalModel *bn) override
	fired after a new Bayes net has been assigned to the engine More...
void	updateOutdatedStructure_ () override
	prepares inference when the latter is in OutdatedStructure state More...
void	updateOutdatedPotentials_ () override
	prepares inference when the latter is in OutdatedPotentials state More...
void	onMarginalTargetAdded_ (const NodeId id) override
	fired after a new marginal target is inserted More...
void	onMarginalTargetErased_ (const NodeId id) override
	fired before a marginal target is removed More...
void	onAllMarginalTargetsAdded_ () override
	fired after all the nodes of the BN are added as marginal targets More...
void	onAllMarginalTargetsErased_ () override
	fired before a all marginal targets are removed More...
void	onStateChanged_ () override
	fired when the stage is changed More...
void	setTargetedMode_ ()
bool	isTargetedMode_ () const
void	setOutdatedStructureState_ ()
	put the inference into an outdated model structure state More...
void	setOutdatedPotentialsState_ ()
	puts the inference into an OutdatedPotentials state if it is not already in an OutdatedStructure state More...
virtual void	setState_ (const StateOfInference state) final
	set the state of the inference engine and call the notification onStateChanged_ when necessary (i.e. when the state has effectively changed). More...
void	setModel_ (const GraphicalModel *model)
void	setModelDuringConstruction_ (const GraphicalModel *model)
	assigns a model during the inference engine construction More...
bool	hasNoModel_ () const

Detailed Description

template<typename GUM_SCALAR>
class gum::GibbsSampling< GUM_SCALAR >

<agrum/BN/inference/gibbsSampling.h>

class for making Gibbs sampling inference in Bayesian networks.

This class overrides pure function declared in the inherited class ApproximateInference. It defines the way Gibbs sampling draws a sample. It also inherits GibbsOperator which contains Gibbs sampling methods.

Definition at line 54 of file GibbsSampling.h.

Member Enumeration Documentation

ApproximationSchemeSTATE

enum gum::IApproximationSchemeConfiguration::ApproximationSchemeSTATE : char

stronginherited

The different state of an approximation scheme.

Enumerator
Undefined
Continue
Epsilon
Rate
Limit
TimeLimit
Stopped

Definition at line 64 of file IApproximationSchemeConfiguration.h.

                                        : char
    {
      Undefined,
      Continue,
      Epsilon,
      Rate,
      Limit,
      TimeLimit,
      Stopped
    };

StateOfInference

template<typename GUM_SCALAR >

enum gum::GraphicalModelInference::StateOfInference

stronginherited

current state of the inference

graphicalModelInference can be in one of 4 different states:

• OutdatedStructure: in this state, the inference is fully unprepared to be applied because some events changed the "logical" structure of the model: for instance a node received a hard evidence, which implies that its outgoing arcs can be removed from the model, hence involving a structural change in the model.
• OutdatedPotentials: in this state, the structure of the model remains unchanged, only some potentials stored in it have changed. Therefore, the inference probably just needs to invalidate some already computed potentials to be ready. Only a light amount of preparation is needed to be able to perform inference.
• Ready4Inference: in this state, all the data structures are ready for inference. There just remains to perform the inference computations.
• Done: the heavy computations of inference have been done. There might still remain a few light computations to perform to get the posterior potentials we need.

Enumerator
OutdatedStructure
OutdatedPotentials
ReadyForInference
Done

Definition at line 106 of file graphicalModelInference.h.

    {
      OutdatedStructure,
      OutdatedPotentials,
      ReadyForInference,
      Done
    };

Constructor & Destructor Documentation

GibbsSampling()

template<typename GUM_SCALAR >

gum::GibbsSampling< GUM_SCALAR >::GibbsSampling ( const IBayesNet< GUM_SCALAR > *  bn )

explicit

Default constructor.

default constructor

Definition at line 42 of file GibbsSampling_tpl.h.

                                                                              :
      SamplingInference< GUM_SCALAR >(bn),
      GibbsOperator< GUM_SCALAR >(*bn,
                                  &this->hardEvidence(),
                                  1 + (bn->size() * GIBBS_SAMPLING_POURCENT_DRAWN_SAMPLE / 100),
                                  GIBBS_SAMPLING_DRAWN_AT_RANDOM) {
    GUM_CONSTRUCTOR(GibbsSampling);

    this->setEpsilon(GIBBS_SAMPLING_DEFAULT_EPSILON);
    this->setMinEpsilonRate(GIBBS_SAMPLING_DEFAULT_MIN_EPSILON_RATE);
    this->setBurnIn(GIBBS_SAMPLING_DEFAULT_BURNIN);
  }

~GibbsSampling()

template<typename GUM_SCALAR >

gum::GibbsSampling< GUM_SCALAR >::~GibbsSampling ( )

override

Destructor.

destructor

Definition at line 57 of file GibbsSampling_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                              {
    GUM_DESTRUCTOR(GibbsSampling);
  }

Here is the call graph for this function:

Member Function Documentation

addAllTargets()

template<typename GUM_SCALAR >

void gum::MarginalTargetedInference< GUM_SCALAR >::addAllTargets ( )

finalvirtualinherited

adds all nodes as targets

Definition at line 130 of file marginalTargetedInference_tpl.h.

                                                              {
    // check if the node belongs to the Bayesian network
    if (this->hasNoModel_())
      GUM_ERROR(NullElement,
                "No Bayes net has been assigned to the "
                "inference algorithm");


    setTargetedMode_();   // does nothing if already in targeted mode
    for (const auto target: this->BN().dag()) {
      if (!_targets_.contains(target)) {
        _targets_.insert(target);
        onMarginalTargetAdded_(target);
        this->setState_(GraphicalModelInference< GUM_SCALAR >::StateOfInference::OutdatedStructure);
      }
    }
  }

addEvidence() [1/8]

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::addEvidence ( NodeId  id, const Idx  val  )

finalvirtualinherited

adds a new hard evidence on node id

Exceptions

UndefinedElement	if id does not belong to the Bayesian network
InvalidArgument	if val is not a value for id
InvalidArgument	if id already has an evidence

Definition at line 228 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                         {
    addEvidence(_createHardEvidence_(id, val));
  }

Here is the call graph for this function:

addEvidence() [2/8]

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::addEvidence ( const std::string &  nodeName, const Idx  val  )

finalvirtualinherited

adds a new hard evidence on node named nodeName

Exceptions

UndefinedElement	if nodeName does not belong to the Bayesian network
InvalidArgument	if val is not a value for id
InvalidArgument	if nodeName already has an evidence

Definition at line 234 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                         {
    addEvidence(this->model().idFromName(nodeName), val);
  }

Here is the call graph for this function:

addEvidence() [3/8]

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::addEvidence ( NodeId  id, const std::string &  label  )

finalvirtualinherited

adds a new hard evidence on node id

Exceptions

UndefinedElement	if id does not belong to the Bayesian network
InvalidArgument	if val is not a value for id
InvalidArgument	if id already has an evidence

Definition at line 241 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                         {
    addEvidence(id, this->model().variable(id)[label]);
  }

Here is the call graph for this function:

addEvidence() [4/8]

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::addEvidence ( const std::string &  nodeName, const std::string &  label  )

finalvirtualinherited

adds a new hard evidence on node named nodeName

Exceptions

UndefinedElement	if nodeName does not belong to the Bayesian network
InvalidArgument	if val is not a value for id
InvalidArgument	if nodeName already has an evidence

Definition at line 248 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                         {
    NodeId id = this->model().idFromName(nodeName);
    addEvidence(id, this->model().variable(id)[label]);
  }

Here is the call graph for this function:

addEvidence() [5/8]

template<typename GUM_SCALAR >

void gum::GraphicalModelInference< GUM_SCALAR >::addEvidence ( NodeId  id, const std::vector< GUM_SCALAR > &  vals  )

finalvirtualinherited

adds a new evidence on node id (might be soft or hard)

Exceptions

UndefinedElement	if id does not belong to the Bayesian network
InvalidArgument	if id already has an evidence
FatalError	if vals=[0,0,...,0]
InvalidArgument	if the size of vals is different from the domain size of node id

Definition at line 256 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                               {
    // checks that the evidence is meaningful
    if (_model_ == nullptr)
      GUM_ERROR(NullElement,
                "No Bayes net has been assigned to the "
                "inference algorithm");

    if (!_model_->exists(id)) { GUM_ERROR(UndefinedElement, id << " is not a NodeId in the model") }

    if (_model_->variable(id).domainSize() != vals.size()) {
      GUM_ERROR(InvalidArgument,
                "node " << _model_->variable(id)
                        << " and its evidence vector have different sizes.");
    }

    Potential< GUM_SCALAR > pot;
    pot.add(_model_->variable(id));
    pot.fillWith(vals);
    addEvidence(std::move(pot));
  }

Here is the call graph for this function:

addEvidence() [6/8]

template<typename GUM_SCALAR >

void gum::GraphicalModelInference< GUM_SCALAR >::addEvidence ( const std::string &  nodeName, const std::vector< GUM_SCALAR > &  vals  )

finalvirtualinherited

adds a new evidence on node named nodeName (might be soft or hard)

Exceptions

UndefinedElement	if id does not belong to the Bayesian network
InvalidArgument	if nodeName already has an evidence
FatalError	if vals=[0,0,...,0]
InvalidArgument	if the size of vals is different from the domain size of node nodeName

Definition at line 280 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                               {
    addEvidence(this->model().idFromName(nodeName), vals);
  }

Here is the call graph for this function:

addEvidence() [7/8]

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::addEvidence ( const Potential< GUM_SCALAR > &  pot )

finalvirtualinherited

adds a new evidence on node id (might be soft or hard)

Exceptions

UndefinedElement	if the potential is defined over several nodes
UndefinedElement	if the node on which the potential is defined does not belong to the Bayesian network
InvalidArgument	if the node of the potential already has an evidence
FatalError	if pot=[0,0,...,0]

Definition at line 325 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                          {
    Potential< GUM_SCALAR > new_pot(pot);
    addEvidence(std::move(new_pot));
  }

Here is the call graph for this function:

addEvidence() [8/8]

template<typename GUM_SCALAR >

void gum::GraphicalModelInference< GUM_SCALAR >::addEvidence ( Potential< GUM_SCALAR > &&  pot )

finalvirtualinherited

adds a new evidence on node id (might be soft or hard)

Exceptions

UndefinedElement	if the potential is defined over several nodes
UndefinedElement	if the node on which the potential is defined does not belong to the Bayesian network
InvalidArgument	if the node of the potential already has an evidence
FatalError	if pot=[0,0,...,0]

Definition at line 287 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                       {
    // check if the potential corresponds to an evidence
    if (pot.nbrDim() != 1) { GUM_ERROR(InvalidArgument, pot << " is not mono-dimensional.") }
    if (_model_ == nullptr)
      GUM_ERROR(NullElement,
                "No Bayes net has been assigned to the "
                "inference algorithm");

    NodeId id = _model_->nodeId(pot.variable(0));

    if (hasEvidence(id)) {
      GUM_ERROR(InvalidArgument,
                " node " << id << " already has an evidence. Please use chgEvidence().");
    }

    // check whether we have a hard evidence (and also check whether the
    // potential only contains 0 (in this case, this will automatically raise
    // an exception) )
    Idx  val;
    bool is_hard_evidence = _isHardEvidence_(pot, val);

    // insert the evidence
    _evidence_.insert(id,
                      new Potential< GUM_SCALAR >(std::forward< Potential< GUM_SCALAR > >(pot)));
    if (is_hard_evidence) {   // pot is deterministic
      _hard_evidence_.insert(id, val);
      _hard_evidence_nodes_.insert(id);
    } else {
      _soft_evidence_nodes_.insert(id);
    }
    setState_(StateOfInference::OutdatedStructure);
    onEvidenceAdded_(id, is_hard_evidence);
  }

Here is the call graph for this function:

addListOfEvidence()

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::addListOfEvidence ( const List< const Potential< GUM_SCALAR > * > &  potlist )

finalvirtualinherited

adds a new list of evidence

Exceptions

UndefinedElement	if some potential is defined over several nodes
UndefinedElement	if the node on which some potential is defined does not belong to the Bayesian network
InvalidArgument	if the node of some potential already has an evidence
FatalError	if pot=[0,0,...,0]

Definition at line 333 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                            {
    for (const auto pot: potlist)
      addEvidence(*pot);
  }

Here is the call graph for this function:

addSetOfEvidence()

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::addSetOfEvidence ( const Set< const Potential< GUM_SCALAR > * > &  potset )

finalvirtualinherited

adds a new set of evidence

Exceptions

UndefinedElement	if some potential is defined over several nodes
UndefinedElement	if the node on which some potential is defined does not belong to the Bayesian network
InvalidArgument	if the node of some potential already has an evidence
FatalError	if pot=[0,0,...,0]

Definition at line 342 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                          {
    for (const auto pot: potset)
      addEvidence(*pot);
  }

Here is the call graph for this function:

addTarget() [1/2]

template<typename GUM_SCALAR >

void gum::MarginalTargetedInference< GUM_SCALAR >::addTarget ( NodeId  target )

finalvirtualinherited

Add a marginal target to the list of targets.

Exceptions

UndefinedElement

if target is not a NodeId in the Bayes net

Definition at line 107 of file marginalTargetedInference_tpl.h.

                                                                       {
    // check if the node belongs to the Bayesian network
    if (this->hasNoModel_())
      GUM_ERROR(NullElement,
                "No Bayes net has been assigned to the "
                "inference algorithm");

    if (!this->BN().dag().exists(target)) {
      GUM_ERROR(UndefinedElement, target << " is not a NodeId in the bn")
    }

    setTargetedMode_();   // does nothing if already in targeted mode
    // add the new target
    if (!_targets_.contains(target)) {
      _targets_.insert(target);
      onMarginalTargetAdded_(target);
      this->setState_(GraphicalModelInference< GUM_SCALAR >::StateOfInference::OutdatedStructure);
    }
  }

addTarget() [2/2]

template<typename GUM_SCALAR >

void gum::MarginalTargetedInference< GUM_SCALAR >::addTarget ( const std::string &  nodeName )

finalvirtualinherited

Add a marginal target to the list of targets.

Exceptions

UndefinedElement

if target is not a NodeId in the Bayes net

Definition at line 151 of file marginalTargetedInference_tpl.h.

                                                                                   {
    // check if the node belongs to the Bayesian network
    if (this->hasNoModel_())
      GUM_ERROR(NullElement,
                "No Bayes net has been assigned to the "
                "inference algorithm");

    addTarget(this->BN().idFromName(nodeName));
  }

addVarSample_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::addVarSample_ ( NodeId  nod, Instantiation *  I  )

protectedvirtualinherited

adds a node to current instantiation

Parameters

nod	the node to add to the sample
I	the current sample

generates random value based on the BN's CPT's and adds the node to the Instantiation with that value

Definition at line 180 of file samplingInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                  {
    gum::Instantiation Itop = gum::Instantiation(*I);

    I->add(samplingBN().variable(nod));
    I->chgVal(samplingBN().variable(nod), samplingBN().cpt(nod).extract(Itop).draw());
  }

Here is the call graph for this function:

BN()

template<typename GUM_SCALAR >

INLINE const IBayesNet< GUM_SCALAR > & gum::BayesNetInference< GUM_SCALAR >::BN ( ) const

finalvirtualinherited

Returns a constant reference over the IBayesNet referenced by this class.

Exceptions

UndefinedElement

is raised if no Bayes net has been assigned to the inference.

Definition at line 57 of file BayesNetInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                  {
    return static_cast< const IBayesNet< GUM_SCALAR >& >(this->model());
  }

Here is the call graph for this function:

burnIn()

template<typename GUM_SCALAR >

Size gum::GibbsSampling< GUM_SCALAR >::burnIn ( ) const

inline

Returns the number of burn in.

Returns

Returns the number of burn in.

Definition at line 77 of file GibbsSampling.h.

{ return this->burn_in_; };

burnIn_()

template<typename GUM_SCALAR >

Instantiation gum::GibbsSampling< GUM_SCALAR >::burnIn_ ( )

overrideprotectedvirtual

draws a defined number of samples without updating the estimators

Implements gum::SamplingInference< GUM_SCALAR >.

Definition at line 69 of file GibbsSampling_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                     {
    gum::Instantiation Ip;
    if (this->burnIn() == 0) return Ip;

    GUM_SCALAR w = 1.0f;
    Ip           = monteCarloSample_();
    for (Size i = 1; i < this->burnIn(); i++)
      Ip = this->draw_(&w, Ip);

    return Ip;
  }

Here is the call graph for this function:

chgEvidence() [1/7]

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::chgEvidence ( NodeId  id, const Idx  val  )

finalvirtualinherited

change the value of an already existing hard evidence

Exceptions

UndefinedElement	if id does not belong to the Bayesian network
InvalidArgument	if val is not a value for id
InvalidArgument	if id does not already have an evidence

Definition at line 402 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                         {
    chgEvidence(_createHardEvidence_(id, val));
  }

Here is the call graph for this function:

chgEvidence() [2/7]

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::chgEvidence ( const std::string &  nodeName, const Idx  val  )

finalvirtualinherited

change the value of an already existing hard evidence

Exceptions

UndefinedElement	if nodeName does not belong to the Bayesian network
InvalidArgument	if val is not a value for id
InvalidArgument	if id does not already have an evidence

Definition at line 408 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                         {
    chgEvidence(this->model().idFromName(nodeName), val);
  }

Here is the call graph for this function:

chgEvidence() [3/7]

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::chgEvidence ( NodeId  id, const std::string &  label  )

finalvirtualinherited

change the value of an already existing hard evidence

Exceptions

UndefinedElement	if id does not belong to the Bayesian network
InvalidArgument	if val is not a value for id
InvalidArgument	if id does not already have an evidence

Definition at line 415 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                         {
    chgEvidence(id, this->model().variable(id)[label]);
  }

Here is the call graph for this function:

chgEvidence() [4/7]

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::chgEvidence ( const std::string &  nodeName, const std::string &  label  )

finalvirtualinherited

change the value of an already existing hard evidence

Exceptions

UndefinedElement	if nodeName does not belong to the Bayesian network
InvalidArgument	if val is not a value for id
InvalidArgument	if id does not already have an evidence

Definition at line 422 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                         {
    NodeId id = this->model().idFromName(nodeName);
    chgEvidence(id, this->model().variable(id)[label]);
  }

Here is the call graph for this function:

chgEvidence() [5/7]

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::chgEvidence ( NodeId  id, const std::vector< GUM_SCALAR > &  vals  )

finalvirtualinherited

change the value of an already existing evidence (might be soft or hard)

Exceptions

UndefinedElement	if id does not belong to the Bayesian network
InvalidArgument	if the node does not already have an evidence
FatalError	if vals=[0,0,...,0]
InvalidArgument	if the size of vals is different from the domain size of node id

Definition at line 431 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                             {
    // check whether this corresponds to an evidence
    if (_model_ == nullptr)
      GUM_ERROR(NullElement,
                "No Bayes net has been assigned to the "
                "inference algorithm");

    if (!_model_->exists(id)) { GUM_ERROR(UndefinedElement, id << " is not a NodeId in the model") }

    if (_model_->variable(id).domainSize() != vals.size()) {
      GUM_ERROR(InvalidArgument,
                "node " << _model_->variable(id) << " and its evidence have different sizes.");
    }

    // create the potential corresponding to vals
    Potential< GUM_SCALAR > pot;
    pot.add(_model_->variable(id));
    pot.fillWith(vals);
    chgEvidence(pot);
  }

Here is the call graph for this function:

chgEvidence() [6/7]

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::chgEvidence ( const std::string &  nodeName, const std::vector< GUM_SCALAR > &  vals  )

finalvirtualinherited

change the value of an already existing evidence (might be soft or hard)

Exceptions

UndefinedElement	if nodeName does not belong to the Bayesian network
InvalidArgument	if the node does not already have an evidence
FatalError	if vals=[0,0,...,0]
InvalidArgument	if the size of vals is different from the domain size of node id

Definition at line 456 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                             {
    chgEvidence(this->model().idFromName(nodeName), vals);
  }

Here is the call graph for this function:

chgEvidence() [7/7]

template<typename GUM_SCALAR >

void gum::GraphicalModelInference< GUM_SCALAR >::chgEvidence ( const Potential< GUM_SCALAR > &  pot )

finalvirtualinherited

change the value of an already existing evidence (might be soft or hard)

Exceptions

UndefinedElement	if the potential is defined over several nodes
UndefinedElement	if the node on which the potential is defined does not belong to the Bayesian network
InvalidArgument	if the node of the potential does not already have an evidence
FatalError	if pot=[0,0,...,0]

Definition at line 464 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                            {
    // check if the potential corresponds to an evidence
    if (pot.nbrDim() != 1) {
      GUM_ERROR(InvalidArgument, pot << " is not a mono-dimensional potential.")
    }
    if (_model_ == nullptr)
      GUM_ERROR(NullElement,
                "No Bayes net has been assigned to the "
                "inference algorithm");

    NodeId id = _model_->nodeId(pot.variable(0));

    if (!hasEvidence(id)) {
      GUM_ERROR(InvalidArgument, id << " has no evidence. Please use addEvidence().")
    }

    // check whether we have a hard evidence (and also check whether the
    // potential only contains 0 (in this case, this will automatically raise
    // an exception) )
    Idx  val;
    bool is_hard_evidence = _isHardEvidence_(pot, val);

    // modify the evidence already stored
    const Potential< GUM_SCALAR >* localPot = _evidence_[id];
    Instantiation                  I(pot);
    for (I.setFirst(); !I.end(); I.inc()) {
      localPot->set(I, pot[I]);
    }

    // the inference state will be different
    // whether evidence change from Hard to Soft or not.
    bool hasChangedSoftHard = false;

    if (is_hard_evidence) {
      if (!hasHardEvidence(id)) {
        hasChangedSoftHard = true;
        _hard_evidence_.insert(id, val);
        _hard_evidence_nodes_.insert(id);
        _soft_evidence_nodes_.erase(id);
      } else {
        _hard_evidence_[id] = val;
      }
    } else {
      if (hasHardEvidence(id)) {   // evidence was hard
        _hard_evidence_.erase(id);
        _hard_evidence_nodes_.erase(id);
        _soft_evidence_nodes_.insert(id);
        hasChangedSoftHard = true;
      }
    }

    if (hasChangedSoftHard) {
      setState_(StateOfInference::OutdatedStructure);
    } else {
      if (!isInferenceOutdatedStructure()) { setState_(StateOfInference::OutdatedPotentials); }
    }

    onEvidenceChanged_(id, hasChangedSoftHard);
  }

Here is the call graph for this function:

clear()

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::clear ( )

virtualinherited

clears all the data structures allocated for the last inference

Reimplemented in gum::ShaferShenoyLIMIDInference< GUM_SCALAR >.

Definition at line 139 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                           {
    eraseAllEvidence();
    setState_(StateOfInference::OutdatedStructure);
  }

Here is the call graph for this function:

contextualize()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::contextualize ( )

virtualinherited

Simplifying the Bayesian network with relevance reasonning to lighten the computational charge.

Sets the reference Bayesian network as a BayesNetFragment after having eliminated nodes that are idle for simulation and computation, such as barren or d-separated nodes. Eliminates the arcs from evidence nodes to it's children, after setting new CPT's for them.

Definition at line 109 of file samplingInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                      {
    // Finding Barren nodes

    BarrenNodesFinder barr_nodes = BarrenNodesFinder(&this->BN().dag());
    barr_nodes.setTargets(&this->targets());
    barr_nodes.setEvidence(&this->hardEvidenceNodes());
    const NodeSet& barren = barr_nodes.barrenNodes();

    // creating BN fragment
    _samplingBN_ = new BayesNetFragment< GUM_SCALAR >(this->BN());
    for (const auto elmt: this->BN().dag().asNodeSet() - barren)
      _samplingBN_->installNode(elmt);

    // D-separated nodes

    dSeparation dsep = gum::dSeparation();
    NodeSet     requisite;
    dsep.requisiteNodes(this->BN().dag(),
                        this->BN().nodes().asNodeSet(),   // no target for approximateInference
                        this->hardEvidenceNodes(),
                        this->softEvidenceNodes(),   // should be empty
                        requisite);
    requisite += this->hardEvidenceNodes();

    auto nonRequisite = this->BN().dag().asNodeSet() - requisite;

    for (const auto elmt: nonRequisite)
      _samplingBN_->uninstallNode(elmt);
    for (const auto hard: this->hardEvidenceNodes()) {
      gum::Instantiation I;
      I.add(this->BN().variable(hard));
      I.chgVal(this->BN().variable(hard), this->hardEvidence()[hard]);

      for (const auto& child: this->BN().children(hard)) {
        _samplingBN_->installCPT(child, this->BN().cpt(child).extract(I));
      }
    }

    this->isContextualized = true;
    this->onContextualize_(_samplingBN_);
  }

Here is the call graph for this function:

continueApproximationScheme()

INLINE bool gum::ApproximationScheme::continueApproximationScheme ( double  error )

inherited

Update the scheme w.r.t the new error.

Test the stopping criterion that are enabled.

Parameters

error

The new error value.

Returns

false if state become != ApproximationSchemeSTATE::Continue

Exceptions

OperationNotAllowed

Raised if state != ApproximationSchemeSTATE::Continue.

Definition at line 208 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                           {
    // For coherence, we fix the time used in the method

    double timer_step = timer_.step();

    if (enabled_max_time_) {
      if (timer_step > max_time_) {
        stopScheme_(ApproximationSchemeSTATE::TimeLimit);
        return false;
      }
    }

    if (!startOfPeriod()) { return true; }

    if (current_state_ != ApproximationSchemeSTATE::Continue) {
      GUM_ERROR(OperationNotAllowed,
                "state of the approximation scheme is not correct : "
                   + messageApproximationScheme());
    }

    if (verbosity()) { history_.push_back(error); }

    if (enabled_max_iter_) {
      if (current_step_ > max_iter_) {
        stopScheme_(ApproximationSchemeSTATE::Limit);
        return false;
      }
    }

    last_epsilon_    = current_epsilon_;
    current_epsilon_ = error;   // eps rate isEnabled needs it so affectation was
    // moved from eps isEnabled below

    if (enabled_eps_) {
      if (current_epsilon_ <= eps_) {
        stopScheme_(ApproximationSchemeSTATE::Epsilon);
        return false;
      }
    }

    if (last_epsilon_ >= 0.) {
      if (current_epsilon_ > .0) {
        // ! current_epsilon_ can be 0. AND epsilon
        // isEnabled can be disabled !
        current_rate_ = std::fabs((current_epsilon_ - last_epsilon_) / current_epsilon_);
      }
      // limit with current eps ---> 0 is | 1 - ( last_eps / 0 ) | --->
      // infinity the else means a return false if we isEnabled the rate below,
      // as we would have returned false if epsilon isEnabled was enabled
      else {
        current_rate_ = min_rate_eps_;
      }

      if (enabled_min_rate_eps_) {
        if (current_rate_ <= min_rate_eps_) {
          stopScheme_(ApproximationSchemeSTATE::Rate);
          return false;
        }
      }
    }

    if (stateApproximationScheme() == ApproximationSchemeSTATE::Continue) {
      if (onProgress.hasListener()) {
        GUM_EMIT3(onProgress, current_step_, current_epsilon_, timer_step);
      }

      return true;
    } else {
      return false;
    }
  }

Here is the call graph for this function:

currentPosterior() [1/2]

template<typename GUM_SCALAR >

const Potential< GUM_SCALAR > & gum::SamplingInference< GUM_SCALAR >::currentPosterior ( NodeId  id )

inherited

Computes and returns the actual estimation of the posterior of a node.

Returns

a const ref to the posterior probability of the node.

Parameters

id	the node for which we need a posterior probability

Warning

for efficiency reasons, the potential is returned by reference. In order to ensure that the potential may still exist even if the Inference object is destroyed, the user has to copy it explicitly.

Exceptions

UndefinedElement	if node is not in the set of targets.
NotFound	if node is not in the BN.

Definition at line 93 of file samplingInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                            {
    return _estimator_.posterior(this->BN().variable(id));
  }

Here is the call graph for this function:

currentPosterior() [2/2]

template<typename GUM_SCALAR >

const Potential< GUM_SCALAR > & gum::SamplingInference< GUM_SCALAR >::currentPosterior ( const std::string &  name )

inherited

Computes and returns the actual estimation of the posterior of a node by its name.

Returns

a const ref to the posterior probability of the node referred by name.

Parameters

name	the name of the node for which we need a posterior probability

Warning

for efficiency reasons, the potential is returned by reference. In order to ensure that the potential may still exist even if the Inference object is destroyed, the user has to copy it explicitly.

Exceptions

UndefinedElement	if node corresponding to name is not in the set of targets.
NotFound	if node corresponding to name is not in the BN.

Definition at line 99 of file samplingInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                            {
    return currentPosterior(this->BN().idFromName(name));
  }

Here is the call graph for this function:

currentTime()

INLINE double gum::ApproximationScheme::currentTime ( ) const

virtualinherited

Returns the current running time in second.

Returns

Returns the current running time in second.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 115 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return timer_.step(); }

Here is the call graph for this function:

disableEpsilon()

INLINE void gum::ApproximationScheme::disableEpsilon ( )

virtualinherited

Disable stopping criterion on epsilon.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 53 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ enabled_eps_ = false; }

Here is the call graph for this function:

disableMaxIter()

INLINE void gum::ApproximationScheme::disableMaxIter ( )

virtualinherited

Disable stopping criterion on max iterations.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 94 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ enabled_max_iter_ = false; }

Here is the call graph for this function:

disableMaxTime()

INLINE void gum::ApproximationScheme::disableMaxTime ( )

virtualinherited

Disable stopping criterion on timeout.

Returns

Disable stopping criterion on timeout.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 118 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ enabled_max_time_ = false; }

Here is the call graph for this function:

disableMinEpsilonRate()

INLINE void gum::ApproximationScheme::disableMinEpsilonRate ( )

virtualinherited

Disable stopping criterion on epsilon rate.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 74 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ enabled_min_rate_eps_ = false; }

Here is the call graph for this function:

domainSizes()

template<typename GUM_SCALAR >

INLINE const NodeProperty< Size > & gum::GraphicalModelInference< GUM_SCALAR >::domainSizes ( ) const

finalvirtualinherited

get the domain sizes of the random variables of the model

Definition at line 159 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                              {
    return _domain_sizes_;
  }

Here is the call graph for this function:

draw_()

template<typename GUM_SCALAR >

Instantiation gum::GibbsSampling< GUM_SCALAR >::draw_ ( GUM_SCALAR *  w, Instantiation  prev  )

overrideprotectedvirtual

draws a sample given previous one according to Gibbs sampling

draws next sample for gibbs sampling

Parameters

w	the weight of sample being generated
prev	the previous sample generated
bn	the Bayesian network containing the evidence
hardEvNodes	hard evidence nodes
hardEv	hard evidences values

Uses the Gibbs sampling method to generate a new sample given the previous one. The method is implemented in the inherited class GibbsOperator. This function only makes the call to it. It consists of choosing one node x to sample, given the instantiation of all other nodes. It requires computing of P( x instantiation_markovblanket(x)).

Implements gum::SamplingInference< GUM_SCALAR >.

Definition at line 84 of file GibbsSampling_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                    {
    *w = 1.0;
    return GibbsOperator< GUM_SCALAR >::nextSample(prev);
  }

Here is the call graph for this function:

enableEpsilon()

INLINE void gum::ApproximationScheme::enableEpsilon ( )

virtualinherited

Enable stopping criterion on epsilon.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 56 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ enabled_eps_ = true; }

Here is the call graph for this function:

enableMaxIter()

INLINE void gum::ApproximationScheme::enableMaxIter ( )

virtualinherited

Enable stopping criterion on max iterations.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 97 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ enabled_max_iter_ = true; }

Here is the call graph for this function:

enableMaxTime()

INLINE void gum::ApproximationScheme::enableMaxTime ( )

virtualinherited

Enable stopping criterion on timeout.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 121 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ enabled_max_time_ = true; }

Here is the call graph for this function:

enableMinEpsilonRate()

INLINE void gum::ApproximationScheme::enableMinEpsilonRate ( )

virtualinherited

Enable stopping criterion on epsilon rate.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 77 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ enabled_min_rate_eps_ = true; }

Here is the call graph for this function:

epsilon()

INLINE double gum::ApproximationScheme::epsilon ( ) const

virtualinherited

Returns the value of epsilon.

Returns

Returns the value of epsilon.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 50 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return eps_; }

Here is the call graph for this function:

eraseAllEvidence()

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::eraseAllEvidence ( )

finalvirtualinherited

removes all the evidence entered into the network

Definition at line 553 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                      {
    bool has_hard_evidence = !_hard_evidence_.empty();
    this->onAllEvidenceErased_(has_hard_evidence);

    for (const auto& pair: _evidence_) {
      if (pair.second != nullptr) { delete (pair.second); }
    }

    _evidence_.clear();
    _hard_evidence_.clear();
    _hard_evidence_nodes_.clear();
    _soft_evidence_nodes_.clear();

    if (has_hard_evidence) {
      setState_(StateOfInference::OutdatedStructure);
    } else {
      if (!isInferenceOutdatedStructure()) { setState_(StateOfInference::OutdatedPotentials); }
    }
  }

Here is the call graph for this function:

eraseAllTargets()

template<typename GUM_SCALAR >

INLINE void gum::MarginalTargetedInference< GUM_SCALAR >::eraseAllTargets ( )

virtualinherited

Clear all previously defined targets.

Reimplemented in gum::JointTargetedInference< GUM_SCALAR >.

Definition at line 95 of file marginalTargetedInference_tpl.h.

                                                                       {
    onAllMarginalTargetsErased_();

    _targets_.clear();
    setTargetedMode_();   // does nothing if already in targeted mode

    this->setState_(GraphicalModelInference< GUM_SCALAR >::StateOfInference::OutdatedStructure);
  }

eraseEvidence() [1/2]

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::eraseEvidence ( NodeId  id )

finalvirtualinherited

removed the evidence, if any, corresponding to node id

Definition at line 527 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                            {
    if (hasEvidence(id)) {
      if (hasHardEvidence(id)) {
        onEvidenceErased_(id, true);
        _hard_evidence_.erase(id);
        _hard_evidence_nodes_.erase(id);
        setState_(StateOfInference::OutdatedStructure);
      } else {
        onEvidenceErased_(id, false);
        _soft_evidence_nodes_.erase(id);
        if (!isInferenceOutdatedStructure()) { setState_(StateOfInference::OutdatedPotentials); }
      }

      delete (_evidence_[id]);
      _evidence_.erase(id);
    }
  }

Here is the call graph for this function:

eraseEvidence() [2/2]

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::eraseEvidence ( const std::string &  nodeName )

finalvirtualinherited

removed the evidence, if any, corresponding to node of name nodeName

Definition at line 546 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                            {
    eraseEvidence(this->model().idFromName(nodeName));
  }

Here is the call graph for this function:

eraseTarget() [1/2]

template<typename GUM_SCALAR >

void gum::MarginalTargetedInference< GUM_SCALAR >::eraseTarget ( NodeId  target )

finalvirtualinherited

removes an existing (marginal) target

Warning

If the target does not already exist, the method does nothing. In particular, it does not raise any exception.

Definition at line 164 of file marginalTargetedInference_tpl.h.

                                                                         {
    // check if the node belongs to the Bayesian network
    if (this->hasNoModel_())
      GUM_ERROR(NullElement,
                "No Bayes net has been assigned to the "
                "inference algorithm");

    if (!this->BN().dag().exists(target)) {
      GUM_ERROR(UndefinedElement, target << " is not a NodeId in the bn")
    }


    if (_targets_.contains(target)) {
      _targeted_mode_ = true;   // we do not use setTargetedMode_ because we do not
                                // want to clear the targets
      onMarginalTargetErased_(target);
      _targets_.erase(target);
      this->setState_(GraphicalModelInference< GUM_SCALAR >::StateOfInference::OutdatedStructure);
    }
  }

eraseTarget() [2/2]

template<typename GUM_SCALAR >

void gum::MarginalTargetedInference< GUM_SCALAR >::eraseTarget ( const std::string &  nodeName )

finalvirtualinherited

removes an existing (marginal) target

Warning

If the target does not already exist, the method does nothing. In particular, it does not raise any exception.

Definition at line 188 of file marginalTargetedInference_tpl.h.

                                                                                     {
    // check if the node belongs to the Bayesian network
    if (this->hasNoModel_())
      GUM_ERROR(NullElement,
                "No Bayes net has been assigned to the "
                "inference algorithm");

    eraseTarget(this->BN().idFromName(nodeName));
  }

evidence()

template<typename GUM_SCALAR >

INLINE const NodeProperty< const Potential< GUM_SCALAR > *> & gum::GraphicalModelInference< GUM_SCALAR >::evidence ( ) const

inherited

returns the set of evidence

Definition at line 605 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                     {
    return _evidence_;
  }

Here is the call graph for this function:

evidenceImpact() [1/2]

template<typename GUM_SCALAR >

Potential< GUM_SCALAR > gum::MarginalTargetedInference< GUM_SCALAR >::evidenceImpact ( NodeId  target, const NodeSet &  evs  )

inherited

Create a gum::Potential for P(target|evs) (for all instanciation of target and evs)

Warning

If some evs are d-separated, they are not included in the Potential

Parameters

bn	the BayesNet
target	the nodeId of the targetted variable
evs	the vector of nodeId of the observed variables

Returns

a Potential

Definition at line 268 of file marginalTargetedInference_tpl.h.

                                                                                              {
    const auto& vtarget = this->BN().variable(target);

    if (evs.contains(target)) {
      GUM_ERROR(InvalidArgument,
                "Target <" << vtarget.name() << "> (" << target << ") can not be in evs (" << evs
                           << ").");
    }
    auto condset = this->BN().minimalCondSet(target, evs);

    Potential< GUM_SCALAR > res;
    this->eraseAllTargets();
    this->eraseAllEvidence();
    res.add(this->BN().variable(target));
    this->addTarget(target);
    for (const auto& n: condset) {
      res.add(this->BN().variable(n));
      this->addEvidence(n, 0);
    }

    Instantiation inst(res);
    for (inst.setFirst(); !inst.end(); inst.incNotVar(vtarget)) {
      // inferring
      for (const auto& n: condset)
        this->chgEvidence(n, inst.val(this->BN().variable(n)));
      this->makeInference();
      // populate res
      for (inst.setFirstVar(vtarget); !inst.end(); inst.incVar(vtarget)) {
        res.set(inst, this->posterior(target)[inst]);
      }
      inst.setFirstVar(vtarget);   // remove inst.end() flag
    }

    return res;
  }

evidenceImpact() [2/2]

template<typename GUM_SCALAR >

Potential< GUM_SCALAR > gum::MarginalTargetedInference< GUM_SCALAR >::evidenceImpact ( const std::string &  target, const std::vector< std::string > &  evs  )

inherited

Create a gum::Potential for P(target|evs) (for all instanciation of target and evs)

Warning

If some evs are d-separated, they are not included in the Potential

Parameters

target	the nodeId of the target variable
evs	the nodeId of the observed variable

Returns

a Potential

Definition at line 306 of file marginalTargetedInference_tpl.h.

                                        {
    const auto& bn = this->BN();
    return evidenceImpact(bn.idFromName(target), bn.nodeset(evs));
  }

H() [1/2]

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::MarginalTargetedInference< GUM_SCALAR >::H ( NodeId  X )

finalvirtualinherited

Entropy Compute Shanon's entropy of a node given the observation.

See also

http://en.wikipedia.org/wiki/Information_entropy

Definition at line 253 of file marginalTargetedInference_tpl.h.

                                                                       {
    return posterior(X).entropy();
  }

H() [2/2]

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::MarginalTargetedInference< GUM_SCALAR >::H ( const std::string &  nodeName )

finalvirtualinherited

Entropy Compute Shanon's entropy of a node given the observation.

See also

http://en.wikipedia.org/wiki/Information_entropy

Definition at line 261 of file marginalTargetedInference_tpl.h.

                                                                                        {
    return H(this->BN().idFromName(nodeName));
  }

hardEvidence()

template<typename GUM_SCALAR >

INLINE const NodeProperty< Idx > & gum::GraphicalModelInference< GUM_SCALAR >::hardEvidence ( ) const

inherited

indicate for each node with hard evidence which value it took

Definition at line 597 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                              {
    return _hard_evidence_;
  }

Here is the call graph for this function:

hardEvidenceNodes()

template<typename GUM_SCALAR >

INLINE const NodeSet & gum::GraphicalModelInference< GUM_SCALAR >::hardEvidenceNodes ( ) const

inherited

returns the set of nodes with hard evidence

the set of nodes that received hard evidence

Definition at line 619 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                       {
    return _hard_evidence_nodes_;
  }

Here is the call graph for this function:

hasEvidence() [1/3]

template<typename GUM_SCALAR >

INLINE bool gum::GraphicalModelInference< GUM_SCALAR >::hasEvidence ( ) const

finalvirtualinherited

indicates whether some node(s) have received evidence

Definition at line 351 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                       {
    return !_evidence_.empty();
  }

Here is the call graph for this function:

hasEvidence() [2/3]

template<typename GUM_SCALAR >

INLINE bool gum::GraphicalModelInference< GUM_SCALAR >::hasEvidence ( NodeId  id ) const

finalvirtualinherited

indicates whether node id has received an evidence

Definition at line 358 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                {
    return _evidence_.exists(id);
  }

Here is the call graph for this function:

hasEvidence() [3/3]

template<typename GUM_SCALAR >

INLINE bool gum::GraphicalModelInference< GUM_SCALAR >::hasEvidence ( const std::string &  nodeName ) const

finalvirtualinherited

indicates whether node id has received an evidence

Definition at line 380 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                       {
    return hasEvidence(this->model().idFromName(nodeName));
  }

Here is the call graph for this function:

hasHardEvidence() [1/2]

template<typename GUM_SCALAR >

INLINE bool gum::GraphicalModelInference< GUM_SCALAR >::hasHardEvidence ( NodeId  id ) const

finalvirtualinherited

indicates whether node id has received a hard evidence

Definition at line 365 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                    {
    return _hard_evidence_nodes_.exists(id);
  }

Here is the call graph for this function:

hasHardEvidence() [2/2]

template<typename GUM_SCALAR >

INLINE bool gum::GraphicalModelInference< GUM_SCALAR >::hasHardEvidence ( const std::string &  nodeName ) const

finalvirtualinherited

indicates whether node id has received a hard evidence

Definition at line 388 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                           {
    return hasHardEvidence(this->model().idFromName(nodeName));
  }

Here is the call graph for this function:

hasNoModel_()

template<typename GUM_SCALAR >

bool gum::GraphicalModelInference< GUM_SCALAR >::hasNoModel_ ( ) const

inlineprotectedinherited

Definition at line 527 of file graphicalModelInference.h.

{ return _model_ == nullptr; };

hasSoftEvidence() [1/2]

template<typename GUM_SCALAR >

INLINE bool gum::GraphicalModelInference< GUM_SCALAR >::hasSoftEvidence ( NodeId  id ) const

finalvirtualinherited

indicates whether node id has received a soft evidence

Definition at line 372 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                    {
    return _soft_evidence_nodes_.exists(id);
  }

Here is the call graph for this function:

hasSoftEvidence() [2/2]

template<typename GUM_SCALAR >

INLINE bool gum::GraphicalModelInference< GUM_SCALAR >::hasSoftEvidence ( const std::string &  nodeName ) const

finalvirtualinherited

indicates whether node id has received a soft evidence

Definition at line 396 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                           {
    return hasSoftEvidence(this->model().idFromName(nodeName));
  }

Here is the call graph for this function:

history()

INLINE const std::vector< double > & gum::ApproximationScheme::history ( ) const

virtualinherited

Returns the scheme history.

Returns

Returns the scheme history.

Exceptions

OperationNotAllowed

Raised if the scheme did not performed or if verbosity is set to false.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 157 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                       {
    if (stateApproximationScheme() == ApproximationSchemeSTATE::Undefined) {
      GUM_ERROR(OperationNotAllowed, "state of the approximation scheme is udefined")
    }

    if (verbosity() == false) { GUM_ERROR(OperationNotAllowed, "No history when verbosity=false") }

    return history_;
  }

Here is the call graph for this function:

initApproximationScheme()

INLINE void gum::ApproximationScheme::initApproximationScheme ( )

inherited

Initialise the scheme.

Definition at line 168 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                           {
    current_state_   = ApproximationSchemeSTATE::Continue;
    current_step_    = 0;
    current_epsilon_ = current_rate_ = -1.0;
    history_.clear();
    timer_.reset();
  }

Here is the call graph for this function:

isDrawnAtRandom()

template<typename GUM_SCALAR >

bool gum::GibbsOperator< GUM_SCALAR >::isDrawnAtRandom ( ) const

inlineinherited

Definition at line 69 of file gibbsOperator.h.

References gum::GibbsOperator< GUM_SCALAR >::atRandom_.

{ return atRandom_; }

isEnabledEpsilon()

INLINE bool gum::ApproximationScheme::isEnabledEpsilon ( ) const

virtualinherited

Returns true if stopping criterion on epsilon is enabled, false otherwise.

Returns

Returns true if stopping criterion on epsilon is enabled, false otherwise.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 60 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return enabled_eps_; }

Here is the call graph for this function:

isEnabledMaxIter()

INLINE bool gum::ApproximationScheme::isEnabledMaxIter ( ) const

virtualinherited

Returns true if stopping criterion on max iterations is enabled, false otherwise.

Returns

Returns true if stopping criterion on max iterations is enabled, false otherwise.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 101 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return enabled_max_iter_; }

Here is the call graph for this function:

isEnabledMaxTime()

INLINE bool gum::ApproximationScheme::isEnabledMaxTime ( ) const

virtualinherited

Returns true if stopping criterion on timeout is enabled, false otherwise.

Returns

Returns true if stopping criterion on timeout is enabled, false otherwise.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 125 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return enabled_max_time_; }

Here is the call graph for this function:

isEnabledMinEpsilonRate()

INLINE bool gum::ApproximationScheme::isEnabledMinEpsilonRate ( ) const

virtualinherited

Returns true if stopping criterion on epsilon rate is enabled, false otherwise.

Returns

Returns true if stopping criterion on epsilon rate is enabled, false otherwise.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 81 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return enabled_min_rate_eps_; }

Here is the call graph for this function:

isInferenceDone()

template<typename GUM_SCALAR >

INLINE bool gum::GraphicalModelInference< GUM_SCALAR >::isInferenceDone ( ) const

finalvirtualnoexceptinherited

returns whether the inference object is in a InferenceDone state

The inference object is in a done state when the posteriors can be retrieved without performing a new inference, i.e., all the heavy computations have already been performed. Typically, in a junction tree algorithm, this corresponds to a situation in which all the messages needed in the JT have been computed and sent.

Definition at line 84 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                    {
    return (_state_ == StateOfInference::Done);
  }

Here is the call graph for this function:

isInferenceOutdatedPotentials()

template<typename GUM_SCALAR >

INLINE bool gum::GraphicalModelInference< GUM_SCALAR >::isInferenceOutdatedPotentials ( ) const

finalvirtualnoexceptinherited

returns whether the inference object is in a OutdatedPotential state

Definition at line 79 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                         {
    return (_state_ == StateOfInference::OutdatedPotentials);
  }

Here is the call graph for this function:

isInferenceOutdatedStructure()

template<typename GUM_SCALAR >

INLINE bool gum::GraphicalModelInference< GUM_SCALAR >::isInferenceOutdatedStructure ( ) const

finalvirtualnoexceptinherited

returns whether the inference object is in a OutdatedStructure state

Definition at line 73 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                                 {
    return (_state_ == StateOfInference::OutdatedStructure);
  }

Here is the call graph for this function:

isInferenceReady()

template<typename GUM_SCALAR >

INLINE bool gum::GraphicalModelInference< GUM_SCALAR >::isInferenceReady ( ) const

finalvirtualnoexceptinherited

returns whether the inference object is in a ready state

Definition at line 68 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                     {
    return (_state_ == StateOfInference::ReadyForInference);
  }

Here is the call graph for this function:

isTarget() [1/2]

template<typename GUM_SCALAR >

INLINE bool gum::MarginalTargetedInference< GUM_SCALAR >::isTarget ( NodeId  node ) const

finalvirtualinherited

return true if variable is a (marginal) target

Definition at line 73 of file marginalTargetedInference_tpl.h.

                                                                                 {
    // check that the variable belongs to the bn
    if (this->hasNoModel_())
      GUM_ERROR(NullElement,
                "No Bayes net has been assigned to the "
                "inference algorithm");
    if (!this->BN().dag().exists(node)) {
      GUM_ERROR(UndefinedElement, node << " is not a NodeId in the bn")
    }

    return _targets_.contains(node);
  }

isTarget() [2/2]

template<typename GUM_SCALAR >

INLINE bool gum::MarginalTargetedInference< GUM_SCALAR >::isTarget ( const std::string &  nodeName ) const

finalvirtualinherited

return true if variable is a (marginal) target

Definition at line 88 of file marginalTargetedInference_tpl.h.

                                                                                               {
    return isTarget(this->BN().idFromName(nodeName));
  }

isTargetedMode_()

template<typename GUM_SCALAR >

INLINE bool gum::MarginalTargetedInference< GUM_SCALAR >::isTargetedMode_ ( ) const

protectedinherited

Definition at line 315 of file marginalTargetedInference_tpl.h.

                                                                             {
    return _targeted_mode_;
  }

loopApproxInference_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::loopApproxInference_ ( )

protectedinherited

Definition at line 159 of file samplingInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                             {
    //@todo This should be in  _prepareInference_
    if (!isContextualized) { this->contextualize(); }

    this->initApproximationScheme();
    gum::Instantiation Ip;
    GUM_SCALAR         w = .0;   //

    // Burn in
    Ip = this->burnIn_();
    do {
      Ip = this->draw_(&w, Ip);
      _estimator_.update(Ip, w);
      this->updateApproximationScheme();
    } while (this->continueApproximationScheme(_estimator_.confidence()));

    this->isSetEstimator = false;
  }

Here is the call graph for this function:

makeInference()

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::makeInference ( )

finalvirtualinherited

perform the heavy computations needed to compute the targets' posteriors

In a Junction tree propagation scheme, for instance, the heavy computations are those of the messages sent in the JT. This is precisely what makeInference should compute. Later, the computations of the posteriors can be done "lightly" by multiplying and projecting those messages.

Definition at line 664 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                   {
    if (isInferenceDone()) { return; }

    if (!isInferenceReady()) { prepareInference(); }

    makeInference_();

    setState_(StateOfInference::Done);
  }

Here is the call graph for this function:

makeInference_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::makeInference_ ( )

overrideprotectedvirtualinherited

makes the inference by generating samples

Implements gum::GraphicalModelInference< GUM_SCALAR >.

Definition at line 153 of file samplingInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                       {
    if (!isSetEstimator) this->setEstimatorFromBN_();
    loopApproxInference_();
  }

Here is the call graph for this function:

maxIter()

INLINE Size gum::ApproximationScheme::maxIter ( ) const

virtualinherited

Returns the criterion on number of iterations.

Returns

Returns the criterion on number of iterations.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 91 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return max_iter_; }

Here is the call graph for this function:

maxTime()

INLINE double gum::ApproximationScheme::maxTime ( ) const

virtualinherited

Returns the timeout (in seconds).

Returns

Returns the timeout (in seconds).

Implements gum::IApproximationSchemeConfiguration.

Definition at line 112 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return max_time_; }

Here is the call graph for this function:

messageApproximationScheme()

INLINE std::string gum::IApproximationSchemeConfiguration::messageApproximationScheme ( ) const

inherited

Returns the approximation scheme message.

Returns

Returns the approximation scheme message.

Definition at line 38 of file IApproximationSchemeConfiguration_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                {
    std::stringstream s;

    switch (stateApproximationScheme()) {
      case ApproximationSchemeSTATE::Continue:
        s << "in progress";
        break;

      case ApproximationSchemeSTATE::Epsilon:
        s << "stopped with epsilon=" << epsilon();
        break;

      case ApproximationSchemeSTATE::Rate:
        s << "stopped with rate=" << minEpsilonRate();
        break;

      case ApproximationSchemeSTATE::Limit:
        s << "stopped with max iteration=" << maxIter();
        break;

      case ApproximationSchemeSTATE::TimeLimit:
        s << "stopped with timeout=" << maxTime();
        break;

      case ApproximationSchemeSTATE::Stopped:
        s << "stopped on request";
        break;

      case ApproximationSchemeSTATE::Undefined:
        s << "undefined state";
        break;
    };

    return s.str();
  }

Here is the call graph for this function:

minEpsilonRate()

INLINE double gum::ApproximationScheme::minEpsilonRate ( ) const

virtualinherited

Returns the value of the minimal epsilon rate.

Returns

Returns the value of the minimal epsilon rate.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 71 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return min_rate_eps_; }

Here is the call graph for this function:

model()

template<typename GUM_SCALAR >

INLINE const GraphicalModel & gum::GraphicalModelInference< GUM_SCALAR >::model ( ) const

finalvirtualinherited

Returns a constant reference over the IBayesNet referenced by this class.

Exceptions

UndefinedElement

is raised if no Bayes net has been assigned to the inference.

Definition at line 107 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                  {
    if (_model_ == nullptr)
      GUM_ERROR(UndefinedElement,
                "No Bayes net has been assigned to "
                "the inference algorithm.");
    return *_model_;
  }

Here is the call graph for this function:

monteCarloSample()

template<typename GUM_SCALAR >

Instantiation gum::GibbsOperator< GUM_SCALAR >::monteCarloSample ( )

inherited

draws a Monte Carlo sample

returns a MC sample This is not a really sample since we take into account evidence without care about parent of evidence, etc. This is just a not-so-bad first sample for GibbsSampler

Definition at line 67 of file gibbsOperator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                              {
    gum::Instantiation I;

    for (const auto nod: samplingBn_.topologicalOrder()) {
      I.add(samplingBn_.variable(nod));
      if (hardEv_ != nullptr && hardEv_->exists(nod)) {
        I.chgVal(samplingBn_.variable(nod), (*hardEv_)[nod]);
      } else {
        _drawVarMonteCarlo_(nod, &I);
      }
    }
    return I;
  }

Here is the call graph for this function:

monteCarloSample_()

template<typename GUM_SCALAR >

Instantiation gum::GibbsSampling< GUM_SCALAR >::monteCarloSample_ ( )

protected

draws a Monte Carlo sample

Parameters

bn	the reference Bayesian network

This Monte Carlo sample generates a good starting point for Gibbs sampling, because it returns a sample consistent with the evidence, but it differs from the one implemented in the inherited class Approximate Inference because it also initializes attributes needed for Gibbs sampling.

Definition at line 63 of file GibbsSampling_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                               {
    return GibbsOperator< GUM_SCALAR >::monteCarloSample();
  }

Here is the call graph for this function:

nbrDrawnVar()

template<typename GUM_SCALAR >

Size gum::GibbsOperator< GUM_SCALAR >::nbrDrawnVar ( ) const

inlineinherited

Getters and setters.

Definition at line 65 of file gibbsOperator.h.

{ return nbr_; }

nbrEvidence()

template<typename GUM_SCALAR >

INLINE Size gum::GraphicalModelInference< GUM_SCALAR >::nbrEvidence ( ) const

finalvirtualinherited

returns the number of evidence entered into the Bayesian network

Definition at line 576 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                       {
    return _evidence_.size();
  }

Here is the call graph for this function:

nbrHardEvidence()

template<typename GUM_SCALAR >

INLINE Size gum::GraphicalModelInference< GUM_SCALAR >::nbrHardEvidence ( ) const

finalvirtualinherited

returns the number of hard evidence entered into the Bayesian network

Definition at line 583 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                           {
    return _hard_evidence_nodes_.size();
  }

Here is the call graph for this function:

nbrIterations()

INLINE Size gum::ApproximationScheme::nbrIterations ( ) const

virtualinherited

Returns the number of iterations.

Returns

Returns the number of iterations.

Exceptions

OperationNotAllowed

Raised if the scheme did not perform.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 148 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                       {
    if (stateApproximationScheme() == ApproximationSchemeSTATE::Undefined) {
      GUM_ERROR(OperationNotAllowed, "state of the approximation scheme is undefined")
    }

    return current_step_;
  }

Here is the call graph for this function:

nbrSoftEvidence()

template<typename GUM_SCALAR >

INLINE Size gum::GraphicalModelInference< GUM_SCALAR >::nbrSoftEvidence ( ) const

finalvirtualinherited

returns the number of soft evidence entered into the Bayesian network

Definition at line 590 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                           {
    return _soft_evidence_nodes_.size();
  }

Here is the call graph for this function:

nbrTargets()

template<typename GUM_SCALAR >

INLINE const Size gum::MarginalTargetedInference< GUM_SCALAR >::nbrTargets ( ) const

finalvirtualnoexceptinherited

returns the number of marginal targets

Definition at line 207 of file marginalTargetedInference_tpl.h.

                                                                                       {
    return _targets_.size();
  }

nextSample()

template<typename GUM_SCALAR >

Instantiation gum::GibbsOperator< GUM_SCALAR >::nextSample ( Instantiation  prev )

inherited

draws next sample of Gibbs sampling

Definition at line 90 of file gibbsOperator_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                          {
    for (Idx i = 0; i < nbr_; i++) {
      auto pos
         = atRandom_ ? randomValue(samplingNodes_.size()) : (counting_ % samplingNodes_.size());
      this->_GibbsSample_(samplingNodes_[pos], &prev);
      counting_++;
    }
    return prev;
  }

Here is the call graph for this function:

onAllEvidenceErased_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::onAllEvidenceErased_ ( bool  contains_hard_evidence )

overrideprotectedvirtualinherited

fired before all the evidence are erased

Implements gum::GraphicalModelInference< GUM_SCALAR >.

Definition at line 202 of file samplingInference_tpl.h.

{}

onAllMarginalTargetsAdded_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::onAllMarginalTargetsAdded_ ( )

overrideprotectedvirtualinherited

fired after all the nodes of the BN are added as marginal targets

Implements gum::MarginalTargetedInference< GUM_SCALAR >.

Definition at line 228 of file samplingInference_tpl.h.

{}

onAllMarginalTargetsErased_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::onAllMarginalTargetsErased_ ( )

overrideprotectedvirtualinherited

fired before a all marginal targets are removed

Implements gum::MarginalTargetedInference< GUM_SCALAR >.

Definition at line 231 of file samplingInference_tpl.h.

{}

onContextualize_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::onContextualize_ ( BayesNetFragment< GUM_SCALAR > *  bn )

protectedvirtualinherited

fired when Bayesian network is contextualized

Parameters

bn	the contextualized BayesNetFragment
targets	inference target variables
hardEvNodes	hard evidence nodes
hardEv	hard evidences values

Reimplemented in gum::ImportanceSampling< GUM_SCALAR >.

Definition at line 188 of file samplingInference_tpl.h.

{}

onEvidenceAdded_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::onEvidenceAdded_ ( const NodeId  id, bool  isHardEvidence  )

overrideprotectedvirtualinherited

fired after a new evidence is inserted

Implements gum::GraphicalModelInference< GUM_SCALAR >.

Definition at line 192 of file samplingInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                             {
    if (!isHardEvidence) {
      GUM_ERROR(FatalError, "Approximated inference only accept hard evidence")
    }
  }

Here is the call graph for this function:

onEvidenceChanged_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::onEvidenceChanged_ ( const NodeId  id, bool  hasChangedSoftHard  )

overrideprotectedvirtualinherited

fired after an evidence is changed, in particular when its status (soft/hard) changes

Parameters

nodeId	the node of the changed evidence
hasChangedSoftHard	true if the evidence has changed from Soft to Hard or from Hard to Soft

Implements gum::GraphicalModelInference< GUM_SCALAR >.

Definition at line 205 of file samplingInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                            {
    if (hasChangedSoftHard) {
      GUM_ERROR(FatalError, "Approximated inference only accept hard evidence")
    }
  }

Here is the call graph for this function:

onEvidenceErased_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::onEvidenceErased_ ( const NodeId  id, bool  isHardEvidence  )

overrideprotectedvirtualinherited

fired before an evidence is removed

Implements gum::GraphicalModelInference< GUM_SCALAR >.

Definition at line 199 of file samplingInference_tpl.h.

{}

onMarginalTargetAdded_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::onMarginalTargetAdded_ ( const NodeId  id )

overrideprotectedvirtualinherited

fired after a new marginal target is inserted

Parameters

id	The target variable's id.

Implements gum::MarginalTargetedInference< GUM_SCALAR >.

Definition at line 222 of file samplingInference_tpl.h.

{}

onMarginalTargetErased_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::onMarginalTargetErased_ ( const NodeId  id )

overrideprotectedvirtualinherited

fired before a marginal target is removed

Parameters

id	The target variable's id.

Implements gum::MarginalTargetedInference< GUM_SCALAR >.

Definition at line 225 of file samplingInference_tpl.h.

{}

onModelChanged_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::onModelChanged_ ( const GraphicalModel *  bn )

overrideprotectedvirtualinherited

fired after a new Bayes net has been assigned to the engine

Reimplemented from gum::MarginalTargetedInference< GUM_SCALAR >.

Definition at line 213 of file samplingInference_tpl.h.

{}

onStateChanged_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::onStateChanged_ ( )

overrideprotectedvirtualinherited

fired when the stage is changed

Implements gum::GraphicalModelInference< GUM_SCALAR >.

Definition at line 234 of file samplingInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                        {
    if (this->isInferenceReady()) {
      _estimator_.clear();
      this->initApproximationScheme();
    }
  }

Here is the call graph for this function:

periodSize()

INLINE Size gum::ApproximationScheme::periodSize ( ) const

virtualinherited

Returns the period size.

Returns

Returns the period size.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 134 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return period_size_; }

Here is the call graph for this function:

posterior() [1/2]

template<typename GUM_SCALAR >

const Potential< GUM_SCALAR > & gum::MarginalTargetedInference< GUM_SCALAR >::posterior ( NodeId  node )

virtualinherited

Computes and returns the posterior of a node.

Returns

a const ref to the posterior probability of the node.

Parameters

node	the node for which we need a posterior probability

Warning

for efficiency reasons, the potential is stored into the inference engine and is returned by reference. In order to ensure that the potential may still exist even if the Inference object is destroyed, the user has to copy it explicitly.

prepareInference and makeInference may be applied if needed by the posterior method.

Exceptions

UndefinedElement

if node is not in the set of targets

Reimplemented in gum::JointTargetedInference< GUM_SCALAR >.

Definition at line 229 of file marginalTargetedInference_tpl.h.

                                                                                               {
    if (this->hardEvidenceNodes().contains(node)) { return *(this->evidence()[node]); }

    if (!isTarget(node)) {
      // throws UndefinedElement if var is not a target
      GUM_ERROR(UndefinedElement, node << " is not a target node")
    }

    if (!this->isInferenceDone()) { this->makeInference(); }

    return posterior_(node);
  }

posterior() [2/2]

template<typename GUM_SCALAR >

const Potential< GUM_SCALAR > & gum::MarginalTargetedInference< GUM_SCALAR >::posterior ( const std::string &  nodeName )

virtualinherited

Computes and returns the posterior of a node.

Returns

a const ref to the posterior probability of the node.

Parameters

nodeName

the anme of the node for which we need a posterior probability

Warning

for efficiency reasons, the potential is stored into the inference engine and is returned by reference. In order to ensure that the potential may still exist even if the Inference object is destroyed, the user has to copy it explicitly.

prepareInference and makeInference may be applied if needed by the posterior method.

Exceptions

UndefinedElement

if node is not in the set of targets

Reimplemented in gum::JointTargetedInference< GUM_SCALAR >.

Definition at line 245 of file marginalTargetedInference_tpl.h.

                                                                                 {
    return posterior(this->BN().idFromName(nodeName));
  }

posterior_()

template<typename GUM_SCALAR >

const Potential< GUM_SCALAR > & gum::SamplingInference< GUM_SCALAR >::posterior_ ( NodeId  id )

overridevirtualinherited

Computes and returns the posterior of a node.

Returns

a const ref to the posterior probability of the node.

Parameters

id	the node for which we need a posterior probability

Warning

for efficiency reasons, the potential is returned by reference. In order to ensure that the potential may still exist even if the Inference object is destroyed, the user has to copy it explicitly.

Exceptions

UndefinedElement	if node is not in the set of targets.
NotFound	if node is not in the BN.

Implements gum::MarginalTargetedInference< GUM_SCALAR >.

Definition at line 104 of file samplingInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                      {
    return _estimator_.posterior(this->BN().variable(id));
  }

Here is the call graph for this function:

prepareInference()

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::prepareInference ( )

finalvirtualinherited

prepare the internal inference structures for the next inference

Definition at line 645 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                      {
    if (isInferenceReady() || isInferenceDone()) { return; }

    if (_model_ == nullptr)
      GUM_ERROR(NullElement,
                "No model been assigned to the "
                "inference algorithm");

    if (_state_ == StateOfInference::OutdatedStructure)
      updateOutdatedStructure_();
    else
      updateOutdatedPotentials_();

    setState_(StateOfInference::ReadyForInference);
  }

Here is the call graph for this function:

remainingBurnIn()

INLINE Size gum::ApproximationScheme::remainingBurnIn ( )

inherited

Returns the remaining burn in.

Returns

Returns the remaining burn in.

Definition at line 191 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                   {
    if (burn_in_ > current_step_) {
      return burn_in_ - current_step_;
    } else {
      return 0;
    }
  }

Here is the call graph for this function:

samplingBN()

template<typename GUM_SCALAR >

INLINE const IBayesNet< GUM_SCALAR > & gum::SamplingInference< GUM_SCALAR >::samplingBN ( )

inherited

get the BayesNet which is used to really perform the sampling

Definition at line 70 of file samplingInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                    {
    this->prepareInference();
    if (_samplingBN_ == nullptr)
      return this->BN();
    else
      return *_samplingBN_;
  }

Here is the call graph for this function:

setBN()

template<typename GUM_SCALAR >

void gum::BayesNetInference< GUM_SCALAR >::setBN ( const IBayesNet< GUM_SCALAR > *  bn )

virtualinherited

assigns a new BN to the inference engine

Assigns a new BN to the BayesNetInference engine and sends messages to the descendants of BayesNetInference to inform them that the BN has changed.

Warning

By default, all the nodes of the Bayes net are targets.

note that, by aGrUM's rule, the bn is not copied into the inference engine but only referenced.

Definition at line 64 of file BayesNetInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                               {
    this->setModel_(bn);
  }

Here is the call graph for this function:

setBurnIn()

template<typename GUM_SCALAR >

void gum::GibbsSampling< GUM_SCALAR >::setBurnIn ( Size  b )

inline

Number of burn in for one iteration.

Parameters

b	The number of burn in.

Exceptions

OutOfLowerBound

Raised if b < 1.

Definition at line 71 of file GibbsSampling.h.

{ this->burn_in_ = b; };

setDrawnAtRandom()

template<typename GUM_SCALAR >

void gum::GibbsOperator< GUM_SCALAR >::setDrawnAtRandom ( bool  atRandom )

inlineinherited

Definition at line 71 of file gibbsOperator.h.

References gum::GibbsOperator< GUM_SCALAR >::atRandom_.

{ atRandom_ = atRandom; }

setEpsilon()

INLINE void gum::ApproximationScheme::setEpsilon ( double  eps )

virtualinherited

Given that we approximate f(t), stopping criterion on |f(t+1)-f(t)|.

If the criterion was disabled it will be enabled.

Parameters

eps	The new epsilon value.

Exceptions

OutOfLowerBound

Raised if eps < 0.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 42 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                        {
    if (eps < 0.) { GUM_ERROR(OutOfLowerBound, "eps should be >=0") }

    eps_         = eps;
    enabled_eps_ = true;
  }

Here is the call graph for this function:

setEstimatorFromBN_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::setEstimatorFromBN_ ( )

virtualinherited

Initializes the estimators object linked to the simulation.

Initializes the estimator object by creating a hashtable between non evidence nodes and a 0-filled potential which will approximate the node's posterior

Definition at line 78 of file samplingInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                            {
    _estimator_.setFromBN(&samplingBN(), this->hardEvidenceNodes());
    this->isSetEstimator = true;
  }

Here is the call graph for this function:

setEstimatorFromLBP_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::setEstimatorFromLBP_ ( LoopyBeliefPropagation< GUM_SCALAR > *  lbp, GUM_SCALAR  virtualLBPSize  )

virtualinherited

Initializes the estimators object linked to the simulation.

Parameters

lbp	a LoopyBeliefPropagation object
virtualLBPSize	the size of the equivalent sampling by LBP

Initializes the estimator object by creating a hashtable between non evidence nodes and the current approximation of the node's posterior obtained by running LoopyBeliefPropagation algorithm

Definition at line 84 of file samplingInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                           {
    _estimator_.setFromLBP(lbp, this->hardEvidenceNodes(), virtualLBPSize);
    this->isSetEstimator = true;
  }

Here is the call graph for this function:

setMaxIter()

INLINE void gum::ApproximationScheme::setMaxIter ( Size  max )

virtualinherited

Stopping criterion on number of iterations.

If the criterion was disabled it will be enabled.

Parameters

max	The maximum number of iterations.

Exceptions

OutOfLowerBound

Raised if max <= 1.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 84 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                      {
    if (max < 1) { GUM_ERROR(OutOfLowerBound, "max should be >=1") }
    max_iter_         = max;
    enabled_max_iter_ = true;
  }

Here is the call graph for this function:

setMaxTime()

INLINE void gum::ApproximationScheme::setMaxTime ( double  timeout )

virtualinherited

Stopping criterion on timeout.

If the criterion was disabled it will be enabled.

Parameters

timeout

The timeout value in seconds.

Exceptions

OutOfLowerBound

Raised if timeout <= 0.0.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 105 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                            {
    if (timeout <= 0.) { GUM_ERROR(OutOfLowerBound, "timeout should be >0.") }
    max_time_         = timeout;
    enabled_max_time_ = true;
  }

Here is the call graph for this function:

setMinEpsilonRate()

INLINE void gum::ApproximationScheme::setMinEpsilonRate ( double  rate )

virtualinherited

Given that we approximate f(t), stopping criterion on d/dt(|f(t+1)-f(t)|).

If the criterion was disabled it will be enabled

Parameters

rate	The minimal epsilon rate.

Exceptions

OutOfLowerBound

if rate<0

Implements gum::IApproximationSchemeConfiguration.

Definition at line 63 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                {
    if (rate < 0) { GUM_ERROR(OutOfLowerBound, "rate should be >=0") }

    min_rate_eps_         = rate;
    enabled_min_rate_eps_ = true;
  }

Here is the call graph for this function:

setModel_()

template<typename GUM_SCALAR >

void gum::GraphicalModelInference< GUM_SCALAR >::setModel_ ( const GraphicalModel *  model )

protectedinherited

Definition at line 118 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                   {
    clear();
    _model_ = model;
    _computeDomainSizes_();
    onModelChanged_(model);
    setState_(StateOfInference::OutdatedStructure);
  }

Here is the call graph for this function:

setModelDuringConstruction_()

template<typename GUM_SCALAR >

void gum::GraphicalModelInference< GUM_SCALAR >::setModelDuringConstruction_ ( const GraphicalModel *  model )

protectedinherited

assigns a model during the inference engine construction

Definition at line 129 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                  {
    _model_ = model;
    _computeDomainSizes_();
    setState_(StateOfInference::OutdatedStructure);
  }

Here is the call graph for this function:

setNbrDrawnVar()

template<typename GUM_SCALAR >

void gum::GibbsOperator< GUM_SCALAR >::setNbrDrawnVar ( Size  nbr )

inlineinherited

Definition at line 67 of file gibbsOperator.h.

{ nbr_ = nbr; }

setOutdatedPotentialsState_()

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::setOutdatedPotentialsState_ ( )

protectedinherited

puts the inference into an OutdatedPotentials state if it is not already in an OutdatedStructure state

OutdatedPotentials: in this state, the structure of the model remains unchanged, only some potentials stored in it have changed. Therefore, the inference probably just needs to invalidate some already computed potentials to be ready. Only a light amount of preparation is needed to be able to perform inference.

Definition at line 638 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                 {
    setState_(StateOfInference::OutdatedPotentials);
  }

Here is the call graph for this function:

setOutdatedStructureState_()

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::setOutdatedStructureState_ ( )

protectedinherited

put the inference into an outdated model structure state

OutdatedStructure: in this state, the inference is fully unprepared to be applied because some events changed the "logical" structure of the model: for instance a node received a hard evidence, which implies that its outgoing arcs can be removed from the model, hence involving a structural change in the model. As a consequence, the (incremental) inference (probably) needs a significant amount of preparation to be ready for the next inference. In a Lazy propagation, for instance, this step amounts to compute a new join tree, hence a new structure in which inference will be applied. Note that classes that inherit from graphicalModelInference may be smarter than graphicalModelInference and may, in some situations, find out that their data structures are still ok for inference and, therefore, only resort to perform the actions related to the OutdatedPotentials state. As an example, consider a LazyPropagation inference in Bayes Net A->B->C->D->E in which C has received hard evidence e_C and E is the only target. In this case, A and B are not needed for inference, the only potentials that matter are P(D|e_C) and P(E|D). So the smallest join tree needed for inference contains only one clique DE. Now, adding new evidence e_A on A has no impact on E given hard evidence e_C. In this case, LazyPropagation can be smart and not update its join tree.

Definition at line 630 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                {
    setState_(StateOfInference::OutdatedStructure);
  }

Here is the call graph for this function:

setPeriodSize()

INLINE void gum::ApproximationScheme::setPeriodSize ( Size  p )

virtualinherited

How many samples between two stopping is enable.

Parameters

p	The new period value.

Exceptions

OutOfLowerBound

Raised if p < 1.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 128 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                       {
    if (p < 1) { GUM_ERROR(OutOfLowerBound, "p should be >=1") }

    period_size_ = p;
  }

Here is the call graph for this function:

setState_()

template<typename GUM_SCALAR >

INLINE void gum::GraphicalModelInference< GUM_SCALAR >::setState_ ( const StateOfInference  state )

finalprotectedvirtualinherited

set the state of the inference engine and call the notification onStateChanged_ when necessary (i.e. when the state has effectively changed).

Definition at line 98 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                           {
    if (_state_ != state) {
      _state_ = state;
      onStateChanged_();
    }
  }

Here is the call graph for this function:

setTargetedMode_()

template<typename GUM_SCALAR >

INLINE void gum::MarginalTargetedInference< GUM_SCALAR >::setTargetedMode_ ( )

protectedinherited

Definition at line 319 of file marginalTargetedInference_tpl.h.

                                                                        {
    if (!_targeted_mode_) {
      _targets_.clear();
      _targeted_mode_ = true;
    }
  }

setVerbosity()

INLINE void gum::ApproximationScheme::setVerbosity ( bool  v )

virtualinherited

Set the verbosity on (true) or off (false).

Parameters

v	If true, then verbosity is turned on.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 137 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ verbosity_ = v; }

Here is the call graph for this function:

softEvidenceNodes()

template<typename GUM_SCALAR >

INLINE const NodeSet & gum::GraphicalModelInference< GUM_SCALAR >::softEvidenceNodes ( ) const

inherited

returns the set of nodes with soft evidence

the set of nodes that received soft evidence

Definition at line 612 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                                       {
    return _soft_evidence_nodes_;
  }

Here is the call graph for this function:

startOfPeriod()

INLINE bool gum::ApproximationScheme::startOfPeriod ( )

inherited

Returns true if we are at the beginning of a period (compute error is mandatory).

Returns

Returns true if we are at the beginning of a period (compute error is mandatory).

Definition at line 178 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                 {
    if (current_step_ < burn_in_) { return false; }

    if (period_size_ == 1) { return true; }

    return ((current_step_ - burn_in_) % period_size_ == 0);
  }

Here is the call graph for this function:

state()

template<typename GUM_SCALAR >

INLINE GraphicalModelInference< GUM_SCALAR >::StateOfInference gum::GraphicalModelInference< GUM_SCALAR >::state ( ) const

finalvirtualnoexceptinherited

returns the state of the inference engine

Definition at line 92 of file graphicalModelInference_tpl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                 {
    return _state_;
  }

Here is the call graph for this function:

stateApproximationScheme()

INLINE IApproximationSchemeConfiguration::ApproximationSchemeSTATE gum::ApproximationScheme::stateApproximationScheme ( ) const

virtualinherited

Returns the approximation scheme state.

Returns

Returns the approximation scheme state.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 143 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                             {
    return current_state_;
  }

Here is the call graph for this function:

stopApproximationScheme()

INLINE void gum::ApproximationScheme::stopApproximationScheme ( )

inherited

Stop the approximation scheme.

Definition at line 200 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                           {
    if (current_state_ == ApproximationSchemeSTATE::Continue) {
      stopScheme_(ApproximationSchemeSTATE::Stopped);
    }
  }

Here is the call graph for this function:

targets()

template<typename GUM_SCALAR >

INLINE const NodeSet & gum::MarginalTargetedInference< GUM_SCALAR >::targets ( ) const

finalvirtualnoexceptinherited

returns the list of marginal targets

Definition at line 201 of file marginalTargetedInference_tpl.h.

                                                                                        {
    return _targets_;
  }

updateApproximationScheme()

INLINE void gum::ApproximationScheme::updateApproximationScheme ( unsigned int  incr = 1 )

inherited

Update the scheme w.r.t the new error and increment steps.

Parameters

incr	The new increment steps.

Definition at line 187 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

                                                                              {
    current_step_ += incr;
  }

Here is the call graph for this function:

updateOutdatedPotentials_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::updateOutdatedPotentials_ ( )

overrideprotectedvirtualinherited

prepares inference when the latter is in OutdatedPotentials state

Note that the values of evidence are not necessarily known and can be changed between updateOutdatedPotentials_ and makeInference_.

Implements gum::GraphicalModelInference< GUM_SCALAR >.

Definition at line 219 of file samplingInference_tpl.h.

{}

updateOutdatedStructure_()

template<typename GUM_SCALAR >

void gum::SamplingInference< GUM_SCALAR >::updateOutdatedStructure_ ( )

overrideprotectedvirtualinherited

prepares inference when the latter is in OutdatedStructure state

Note that the values of evidence are not necessarily known and can be changed between updateOutdatedStructure_ and makeInference_.

Implements gum::GraphicalModelInference< GUM_SCALAR >.

Definition at line 216 of file samplingInference_tpl.h.

{}

verbosity()

INLINE bool gum::ApproximationScheme::verbosity ( ) const

virtualinherited

Returns true if verbosity is enabled.

Returns

Returns true if verbosity is enabled.

Implements gum::IApproximationSchemeConfiguration.

Definition at line 139 of file approximationScheme_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ return verbosity_; }

Here is the call graph for this function:

Member Data Documentation

_estimator_

template<typename GUM_SCALAR >

Estimator< GUM_SCALAR > gum::SamplingInference< GUM_SCALAR >::_estimator_

protectedinherited

Estimator object designed to approximate target posteriors.

Definition at line 178 of file samplingInference.h.

atRandom_

template<typename GUM_SCALAR >

bool gum::GibbsOperator< GUM_SCALAR >::atRandom_

protectedinherited

Definition at line 86 of file gibbsOperator.h.

Referenced by gum::GibbsOperator< GUM_SCALAR >::isDrawnAtRandom(), and gum::GibbsOperator< GUM_SCALAR >::setDrawnAtRandom().

burn_in_

Size gum::ApproximationScheme::burn_in_

protectedinherited

Number of iterations before checking stopping criteria.

Definition at line 413 of file approximationScheme.h.

counting_

template<typename GUM_SCALAR >

Size gum::GibbsOperator< GUM_SCALAR >::counting_

protectedinherited

Definition at line 80 of file gibbsOperator.h.

current_epsilon_

double gum::ApproximationScheme::current_epsilon_

protectedinherited

Current epsilon.

Definition at line 368 of file approximationScheme.h.

current_rate_

double gum::ApproximationScheme::current_rate_

protectedinherited

Current rate.

Definition at line 374 of file approximationScheme.h.

current_state_

ApproximationSchemeSTATE gum::ApproximationScheme::current_state_

protectedinherited

The current state.

Definition at line 383 of file approximationScheme.h.

current_step_

Size gum::ApproximationScheme::current_step_

protectedinherited

The current step.

Definition at line 377 of file approximationScheme.h.

enabled_eps_

bool gum::ApproximationScheme::enabled_eps_

protectedinherited

If true, the threshold convergence is enabled.

Definition at line 392 of file approximationScheme.h.

enabled_max_iter_

bool gum::ApproximationScheme::enabled_max_iter_

protectedinherited

If true, the maximum iterations stopping criterion is enabled.

Definition at line 410 of file approximationScheme.h.

enabled_max_time_

bool gum::ApproximationScheme::enabled_max_time_

protectedinherited

If true, the timeout is enabled.

Definition at line 404 of file approximationScheme.h.

enabled_min_rate_eps_

bool gum::ApproximationScheme::enabled_min_rate_eps_

protectedinherited

If true, the minimal threshold for epsilon rate is enabled.

Definition at line 398 of file approximationScheme.h.

eps_

double gum::ApproximationScheme::eps_

protectedinherited

Threshold for convergence.

Definition at line 389 of file approximationScheme.h.

hardEv_

template<typename GUM_SCALAR >

const NodeProperty< Idx >* gum::GibbsOperator< GUM_SCALAR >::hardEv_

protectedinherited

Definition at line 82 of file gibbsOperator.h.

history_

std::vector< double > gum::ApproximationScheme::history_

protectedinherited

The scheme history, used only if verbosity == true.

Definition at line 386 of file approximationScheme.h.

isContextualized

template<typename GUM_SCALAR >

bool gum::SamplingInference< GUM_SCALAR >::isContextualized = false

protectedinherited

whether the referenced Bayesian network has been "contextualized"

Definition at line 184 of file samplingInference.h.

isSetEstimator

template<typename GUM_SCALAR >

bool gum::SamplingInference< GUM_SCALAR >::isSetEstimator = false

protectedinherited

whether the Estimator object has been initialized

Definition at line 181 of file samplingInference.h.

last_epsilon_

double gum::ApproximationScheme::last_epsilon_

protectedinherited

Last epsilon value.

Definition at line 371 of file approximationScheme.h.

max_iter_

Size gum::ApproximationScheme::max_iter_

protectedinherited

The maximum iterations.

Definition at line 407 of file approximationScheme.h.

max_time_

double gum::ApproximationScheme::max_time_

protectedinherited

The timeout.

Definition at line 401 of file approximationScheme.h.

min_rate_eps_

double gum::ApproximationScheme::min_rate_eps_

protectedinherited

Threshold for the epsilon rate.

Definition at line 395 of file approximationScheme.h.

nbr_

template<typename GUM_SCALAR >

Size gum::GibbsOperator< GUM_SCALAR >::nbr_

protectedinherited

Definition at line 85 of file gibbsOperator.h.

onProgress

Signaler3< Size, double, double > gum::IApproximationSchemeConfiguration::onProgress

inherited

Progression, error and time.

Definition at line 58 of file IApproximationSchemeConfiguration.h.

onStop

Signaler1< std::string > gum::IApproximationSchemeConfiguration::onStop

inherited

Criteria messageApproximationScheme.

Definition at line 61 of file IApproximationSchemeConfiguration.h.

period_size_

Size gum::ApproximationScheme::period_size_

protectedinherited

Checking criteria frequency.

Definition at line 416 of file approximationScheme.h.

samplingBn_

template<typename GUM_SCALAR >

const IBayesNet< GUM_SCALAR >& gum::GibbsOperator< GUM_SCALAR >::samplingBn_

protectedinherited

Definition at line 81 of file gibbsOperator.h.

samplingNodes_

template<typename GUM_SCALAR >

Sequence< NodeId > gum::GibbsOperator< GUM_SCALAR >::samplingNodes_

protectedinherited

Definition at line 83 of file gibbsOperator.h.

timer_

Timer gum::ApproximationScheme::timer_

protectedinherited

The timer.

Definition at line 380 of file approximationScheme.h.

verbosity_

bool gum::ApproximationScheme::verbosity_

protectedinherited

If true, verbosity is enabled.

Definition at line 419 of file approximationScheme.h.

---

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

• agrum/BN/inference/GibbsSampling.h
• agrum/BN/inference/GibbsSampling_tpl.h