<agrum/ID/generator/influenceDiagramGenerator.h> More...

#include <influenceDiagramGenerator.h>

Collaboration diagram for gum::InfluenceDiagramGenerator< GUM_SCALAR >:

Public Member Functions
Constructors / Destructor
	InfluenceDiagramGenerator ()
	Default constructor.
	InfluenceDiagramGenerator (ICPTGenerator< GUM_SCALAR > *cptGenerator)
	Use this constructor if you want to use a different policy for generating CPT than the default one.
	InfluenceDiagramGenerator (UTGenerator *utGenerator)
	Use this constructor if you want to use a different policy for generating UT than the default one.
	InfluenceDiagramGenerator (ICPTGenerator< GUM_SCALAR > cptGenerator, UTGenerator utGenerator)
	Use this constructor if you want to use a different policy for generating both CPT & UT than the defaults ones.
	~InfluenceDiagramGenerator ()
	Destructor.
ID generation methods
InfluenceDiagram< GUM_SCALAR > *	generateID (Size nbrNodes, GUM_SCALAR arcDensity, GUM_SCALAR chanceNodeDensity, GUM_SCALAR utilityNodeDensity, Size max_modality=2)
	Generates an influence diagram using floats.

Private Member Functions
void	_checkTemporalOrder_ (InfluenceDiagram< GUM_SCALAR > *infdiag)

Private Attributes
ICPTGenerator< GUM_SCALAR > *	_cptGenerator_
UTGenerator *	_utGenerator_

Detailed Description

template<GUM_Numeric GUM_SCALAR>
class gum::InfluenceDiagramGenerator< GUM_SCALAR >

Class for generating influence diagram.

This class randomly generates an influence diagram given four parameters: the number of nodes,the probability of adding an arc between two nodes, the proportion of chance node and the proportion of utility node (the proportion of decision node is deduce from thos two)

Definition at line 75 of file influenceDiagramGenerator.h.

Constructor & Destructor Documentation

◆ InfluenceDiagramGenerator() [1/4]

template<GUM_Numeric GUM_SCALAR>

gum::InfluenceDiagramGenerator< GUM_SCALAR >::InfluenceDiagramGenerator ( )

Default constructor.

Use the SimpleCPTGenerator for generating the IDs CPT. Use the SimpleUTGenerator for generating the IDs UT.

Definition at line 59 of file influenceDiagramGenerator_tpl.h.

                                                                     {
    GUM_CONSTRUCTOR(InfluenceDiagramGenerator)
    _cptGenerator_ = new SimpleCPTGenerator< GUM_SCALAR >();
    _utGenerator_  = new SimpleUTGenerator();
  }

References InfluenceDiagramGenerator(), _cptGenerator_, and _utGenerator_.

Referenced by InfluenceDiagramGenerator(), InfluenceDiagramGenerator(), InfluenceDiagramGenerator(), InfluenceDiagramGenerator(), and ~InfluenceDiagramGenerator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InfluenceDiagramGenerator() [2/4]

template<GUM_Numeric GUM_SCALAR>

gum::InfluenceDiagramGenerator< GUM_SCALAR >::InfluenceDiagramGenerator ( ICPTGenerator< GUM_SCALAR > * cptGenerator )

explicit

Use this constructor if you want to use a different policy for generating CPT than the default one.

The cptGenerator will be erased when the destructor is called.

Parameters

cptGenerator The policy used to generate CPT.

Definition at line 70 of file influenceDiagramGenerator_tpl.h.

                                                 {
    GUM_CONSTRUCTOR(InfluenceDiagramGenerator)
    _cptGenerator_ = cptGenerator;
    _utGenerator_  = new SimpleUTGenerator();
  }

References InfluenceDiagramGenerator(), _cptGenerator_, and _utGenerator_.

Here is the call graph for this function:

◆ InfluenceDiagramGenerator() [3/4]

template<GUM_Numeric GUM_SCALAR>

gum::InfluenceDiagramGenerator< GUM_SCALAR >::InfluenceDiagramGenerator ( UTGenerator * utGenerator )

explicit

Use this constructor if you want to use a different policy for generating UT than the default one.

The utGenerator will be erased when the destructor is called.

Parameters

utGenerator The policy used to generate UT.

Definition at line 82 of file influenceDiagramGenerator_tpl.h.

                                                                                             {
    GUM_CONSTRUCTOR(InfluenceDiagramGenerator)
    _cptGenerator_ = new SimpleCPTGenerator< GUM_SCALAR >();
    _utGenerator_  = utGenerator;
  }

References InfluenceDiagramGenerator(), _cptGenerator_, and _utGenerator_.

Here is the call graph for this function:

◆ InfluenceDiagramGenerator() [4/4]

template<GUM_Numeric GUM_SCALAR>

gum::InfluenceDiagramGenerator< GUM_SCALAR >::InfluenceDiagramGenerator	(	ICPTGenerator< GUM_SCALAR > *	cptGenerator,
		UTGenerator *	utGenerator )

Use this constructor if you want to use a different policy for generating both CPT & UT than the defaults ones.

The cptGenerator and utGenerator will be erased when the destructor is called.

Parameters

cptGenerator	The policy used to generate CPT.
utGenerator	The policy used to generate UT.

Definition at line 95 of file influenceDiagramGenerator_tpl.h.

                                                {
    GUM_CONSTRUCTOR(InfluenceDiagramGenerator)
    _cptGenerator_ = cptGenerator;
    _utGenerator_  = utGenerator;
  }

References InfluenceDiagramGenerator(), _cptGenerator_, and _utGenerator_.

Here is the call graph for this function:

◆ ~InfluenceDiagramGenerator()

template<GUM_Numeric GUM_SCALAR>

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

Destructor.

Definition at line 105 of file influenceDiagramGenerator_tpl.h.

                                                                      {
    GUM_DESTRUCTOR(InfluenceDiagramGenerator)
    delete _cptGenerator_;
    delete _utGenerator_;
  }

References InfluenceDiagramGenerator(), _cptGenerator_, and _utGenerator_.

Here is the call graph for this function:

Member Function Documentation

◆ _checkTemporalOrder_()

template<GUM_Numeric GUM_SCALAR>

void gum::InfluenceDiagramGenerator< GUM_SCALAR >::_checkTemporalOrder_ ( InfluenceDiagram< GUM_SCALAR > * infdiag )

private

Definition at line 172 of file influenceDiagramGenerator_tpl.h.

                                               {
    if (!infdiag->decisionOrderExists()) {
      Sequence< NodeId > order = infdiag->topologicalOrder();
 
      auto orderIter = order.begin();
 
      while ((orderIter != order.end()) && (!infdiag->isDecisionNode(*orderIter)))
        ++orderIter;
 
      if (orderIter == order.end()) return;
 
      NodeId parentDecision = (*orderIter);
 
      ++orderIter;
 
      for (; orderIter != order.end(); ++orderIter)
        if (infdiag->isDecisionNode(*orderIter)) {
          infdiag->addArc(parentDecision, (*orderIter));
          parentDecision = (*orderIter);
        }
    }
  }

References gum::InfluenceDiagram< GUM_SCALAR >::addArc(), gum::SequenceImplementation< Key, std::is_scalar< Key >::value >::begin(), gum::InfluenceDiagram< GUM_SCALAR >::decisionOrderExists(), gum::SequenceImplementation< Key, std::is_scalar< Key >::value >::end(), gum::InfluenceDiagram< GUM_SCALAR >::isDecisionNode(), and gum::DAGmodel::topologicalOrder().

Referenced by generateID().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateID()

template<GUM_Numeric GUM_SCALAR>

InfluenceDiagram< GUM_SCALAR > * gum::InfluenceDiagramGenerator< GUM_SCALAR >::generateID	(	Size	nbrNodes,
		GUM_SCALAR	arcDensity,
		GUM_SCALAR	chanceNodeDensity,
		GUM_SCALAR	utilityNodeDensity,
		Size	max_modality = 2 )

Generates an influence diagram using floats.

Parameters

nbrNodes	The number of nodes in the generated ID.
arcDensity	The probability of adding an arc between two nodes.
chanceNodeDensity	The proportion of chance node
utilityNodeDensity	The proportion of utility node
max_modality	Each DRV has from 2 to max_modality modalities

Returns: A IDs randomly generated.

Definition at line 120 of file influenceDiagramGenerator_tpl.h.

                                                                                   {
    auto influenceDiagram = new InfluenceDiagram< GUM_SCALAR >();
    // First we add nodes
    HashTable< Size, NodeId > map;
    Size                      nb_mod;
 
    for (Idx i = 0; i < nbrNodes; ++i) {
      const auto varName = std::format("{}", i);
      nb_mod             = (max_modality == 2) ? 2 : 2 + randomValue(max_modality - 1);
 
      GUM_SCALAR cnd = chanceNodeDensity;
      GUM_SCALAR und = utilityNodeDensity;
 
      auto d = (GUM_SCALAR)randomProba();
 
      if (d < cnd)
        map.insert(i, influenceDiagram->addChanceNode(RangeVariable(varName, "", 0, nb_mod - 1)));
      else if (d < (cnd + und))
        map.insert(i, influenceDiagram->addUtilityNode(RangeVariable(varName, "", 0, 0)));
      else
        map.insert(i, influenceDiagram->addDecisionNode(RangeVariable(varName, "", 0, nb_mod - 1)));
    }
 
    // We add arcs
    GUM_SCALAR p = arcDensity;
 
    for (Size i = 0; i < nbrNodes; ++i)
      if (!influenceDiagram->isUtilityNode(map[i]))
        for (Size j = i + 1; j < nbrNodes; ++j)
          if (((GUM_SCALAR)randomProba()) < p) { influenceDiagram->addArc(map[i], map[j]); }
 
    // And fill the CPTs and UTs
    for (Size i = 0; i < nbrNodes; ++i)
      if (influenceDiagram->isChanceNode(map[i]))
        _cptGenerator_->generateCPT(
            influenceDiagram->cpt(map[i]).pos(influenceDiagram->variable(map[i])),
            influenceDiagram->cpt(map[i]));
      else if (influenceDiagram->isUtilityNode(map[i]))
        _utGenerator_->generateUT(
            influenceDiagram->utility(map[i]).pos(influenceDiagram->variable(map[i])),
            influenceDiagram->utility(map[i]));
 
    _checkTemporalOrder_(influenceDiagram);
 
    return influenceDiagram;
  }