gum::SimpleBayesNetGenerator< GUM_SCALAR, ICPTGenerator > Class Template Reference

<agrum/BN/generator/simpleBayesNetGenerator.h> More...

#include <simpleBayesNetGenerator.h>

Inheritance diagram for gum::SimpleBayesNetGenerator< GUM_SCALAR, ICPTGenerator >:

Collaboration diagram for gum::SimpleBayesNetGenerator< GUM_SCALAR, ICPTGenerator >:

Public Member Functions
Constructors / Destructor
	SimpleBayesNetGenerator (Size nbrNodes, Size maxArcs, Size maxModality=2)
	Constructor. More...
	~SimpleBayesNetGenerator () override
	Destructor. More...
BN generation methods
void	generateBN (BayesNet< GUM_SCALAR > &bayesNet) override
	function that generates a bayesian networks. More...
BN generation methods
void	fillCPT ()
	function that insert random values in the CPT of each nodes according to the CPTGenerator. More...
Getters
Size	nbrNodes () const
	Return a constant reference to the number of nodes imposed on the IBayesNetGenerator. More...
Size	maxArcs () const
	Return a constant reference to the maximum number of arcs imposed on the IBayesNetGenerator. More...
Size	maxModality () const
	Return a constant reference to the maximum modality imposed on the IBayesNetGenerator. More...
Setters
void	setNbrNodes (Size nbrNodes)
	Modifies the value of the number of nodes imposed on the BayesGenerator. More...
void	setMaxArcs (Size maxArcs)
	Modifies the value of the number of nodes imposed on the BayesGenerator. More...
void	setMaxModality (Size maxModality)
	Modifies the value of the number of nodes imposed on the BayesGenerator. More...

Protected Attributes
Size	_nbrNodes
Size	_maxArcs
Size	_maxModality
BayesNet< GUM_SCALAR >	_bayesNet

Detailed Description

template<typename GUM_SCALAR, template< typename > class ICPTGenerator = SimpleCPTGenerator>
class gum::SimpleBayesNetGenerator< GUM_SCALAR, ICPTGenerator >

<agrum/BN/generator/simpleBayesNetGenerator.h>

Class for generating bayesian networks.

This class randomly generates a bayesian network given three parameters: the number of nodes and the max number of arcs and the number of maximum modality for each nodes.

Warning

Be Careful when entering the parameters, high Values may cause the density of the Bayesian Network to be too high resulting in the failure of most of the inference Methods.

Definition at line 59 of file simpleBayesNetGenerator.h.

Constructor & Destructor Documentation

SimpleBayesNetGenerator()

template<typename GUM_SCALAR , template< typename > class ICPTGenerator>

INLINE gum::SimpleBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::SimpleBayesNetGenerator	(	Size	nbrNodes,
		Size	maxArcs,
		Size	maxModality = 2
	)

Constructor.

Use by default the SimpleCPTGenerator for generating the BNs CPT.

Parameters

nbrNodes	The number of nodes imposed on the generator.
maxArcs	The number of maximum arcs imposed on the generator.
maxModality	Each DRV has from 2 to maxModality modalities

Definition at line 43 of file simpleBayesNetGenerator_tpl.h.

                                                       :
      IBNG(nbrNodes, maxArcs, maxModality) {
    GUM_CONSTRUCTOR(SimpleBayesNetGenerator);
  }

~SimpleBayesNetGenerator()

template<typename GUM_SCALAR , template< typename > class ICPTGenerator>

INLINE gum::SimpleBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::~SimpleBayesNetGenerator ( )

override

Destructor.

Definition at line 64 of file simpleBayesNetGenerator_tpl.h.

                                                                            {
    GUM_DESTRUCTOR(SimpleBayesNetGenerator);
  }

Member Function Documentation

fillCPT()

template<typename GUM_SCALAR , template< typename > class ICPTGenerator>

void gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::fillCPT ( )

inherited

function that insert random values in the CPT of each nodes according to the CPTGenerator.

Returns

null but modify inputed empty Bayesian Network

Definition at line 64 of file IBayesNetGenerator_tpl.h.

References gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_bayesNet.

Referenced by gum::SimpleBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::generateBN(), and gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::generateBN().

                                                                {
    for (auto node : _bayesNet.nodes())
      this->generateCPT(_bayesNet.cpt(node).pos(_bayesNet.variable(node)),
                        _bayesNet.cpt(node));   // TODO ASSERT THE LINE
  }

Here is the caller graph for this function:

generateBN()

template<typename GUM_SCALAR , template< typename > class ICPTGenerator>

void gum::SimpleBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::generateBN ( BayesNet< GUM_SCALAR > &  bayesNet )

overridevirtual

function that generates a bayesian networks.

Parameters

bayesNet

Bayesian Network to be completed after initialisation

Returns

null but modify inputed Bayesian Network

Implements gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >.

Definition at line 74 of file simpleBayesNetGenerator_tpl.h.

References gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_bayesNet, gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_maxArcs, gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_maxModality, gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_nbrNodes, gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::fillCPT(), gum::HashTable< Key, Val, Alloc >::insert(), gum::randomProba(), and gum::randomValue().

                                       {
    this->_bayesNet = bayesNet;
    HashTable< Size, NodeId > map;
    std::stringstream         strBuff;

    for (Size i = 0; this->_nbrNodes > i; ++i) {
      strBuff << "n" << i;
      Size nb_mod =
         (this->_maxModality == 2) ? 2 : 2 + randomValue(this->_maxModality - 1);
      map.insert(
         i, this->_bayesNet.add(LabelizedVariable(strBuff.str(), "", nb_mod)));
      strBuff.str("");
    }

    // We add arcs
    float density = (float)(this->_maxArcs * 2)
                    / (float)(this->_nbrNodes * (this->_nbrNodes - 1));

    for (Size i = 0; i < this->_nbrNodes; ++i)
      for (Size j = i + 1; j < this->_nbrNodes; ++j)
        if (randomProba() < density) this->_bayesNet.addArc(map[i], map[j]);

    this->fillCPT();

    bayesNet = this->_bayesNet;
  }

Here is the call graph for this function:

maxArcs()

template<typename GUM_SCALAR , template< typename > class ICPTGenerator>

INLINE Size gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::maxArcs ( ) const

inherited

Return a constant reference to the maximum number of arcs imposed on the IBayesNetGenerator.

Definition at line 82 of file IBayesNetGenerator_tpl.h.

References gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_maxArcs.

Referenced by gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::IBayesNetGenerator(), and gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::setMaxArcs().

                                                                             {
    return _maxArcs;
  }

Here is the caller graph for this function:

maxModality()

template<typename GUM_SCALAR , template< typename > class ICPTGenerator>

INLINE Size gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::maxModality ( ) const

inherited

Return a constant reference to the maximum modality imposed on the IBayesNetGenerator.

Definition at line 72 of file IBayesNetGenerator_tpl.h.

References gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_maxModality.

Referenced by gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::IBayesNetGenerator(), and gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::setMaxModality().

                                                                            {
    return _maxModality;
  }

Here is the caller graph for this function:

nbrNodes()

template<typename GUM_SCALAR , template< typename > class ICPTGenerator>

INLINE Size gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::nbrNodes ( ) const

inherited

Return a constant reference to the number of nodes imposed on the IBayesNetGenerator.

Definition at line 77 of file IBayesNetGenerator_tpl.h.

References gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_nbrNodes.

Referenced by gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::IBayesNetGenerator(), and gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::setNbrNodes().

                                                                              {
    return _nbrNodes;
  }

Here is the caller graph for this function:

setMaxArcs()

template<typename GUM_SCALAR , template< typename > class ICPTGenerator>

INLINE void gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::setMaxArcs ( Size  maxArcs )

inherited

Modifies the value of the number of nodes imposed on the BayesGenerator.

Definition at line 106 of file IBayesNetGenerator_tpl.h.

References gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_maxArcs, gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_nbrNodes, GUM_ERROR, and gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::maxArcs().

                                                                             {
    if (maxArcs < _nbrNodes - 1 || maxArcs > (_nbrNodes * (_nbrNodes - 1)) / 2)
      GUM_ERROR(OperationNotAllowed, " maxArcs value not possible ");

    _maxArcs = maxArcs;
  }

Here is the call graph for this function:

setMaxModality()

template<typename GUM_SCALAR , template< typename > class ICPTGenerator>

INLINE void gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::setMaxModality ( Size  maxModality )

inherited

Modifies the value of the number of nodes imposed on the BayesGenerator.

Definition at line 87 of file IBayesNetGenerator_tpl.h.

References gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_maxModality, GUM_ERROR, and gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::maxModality().

                       {
    if (maxModality < 2)
      GUM_ERROR(OperationNotAllowed,
                " maxModality must be at least equal to two ");

    _maxModality = maxModality;
  }

Here is the call graph for this function:

setNbrNodes()

template<typename GUM_SCALAR , template< typename > class ICPTGenerator>

INLINE void gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::setNbrNodes ( Size  nbrNodes )

inherited

Modifies the value of the number of nodes imposed on the BayesGenerator.

Definition at line 97 of file IBayesNetGenerator_tpl.h.

References gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_maxArcs, gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_nbrNodes, GUM_ERROR, and gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::nbrNodes().

                                                                               {
    if ((_maxArcs < nbrNodes - 1) || (_maxArcs > (nbrNodes * (nbrNodes - 1)) / 2))
      GUM_ERROR(OperationNotAllowed, " nbrNodes value not possible ");

    _nbrNodes = nbrNodes;
  }

Here is the call graph for this function:

Member Data Documentation

_bayesNet

template<typename GUM_SCALAR , template< typename > class ICPTGenerator>

BayesNet< GUM_SCALAR > gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_bayesNet

protectedinherited

Definition at line 167 of file IBayesNetGenerator.h.

Referenced by gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__AorR(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__AR(), gum::MaxInducedWidthMCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__checkConditions(), gum::MaxParentsMCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__checkConditions(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__checkConditions(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__chooseCloseNodes(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__chooseNodes(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__connect(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__createPartTree(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__createTree(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__directedPath(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__eraseArc(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__insertArc(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__isPolytree(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__jump_multi(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__jump_poly(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__PMMx_multi(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__PMMx_poly(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__transformPoly(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::disturbBN(), gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::fillCPT(), gum::SimpleBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::generateBN(), and gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::generateBN().

_maxArcs

template<typename GUM_SCALAR , template< typename > class ICPTGenerator>

Size gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_maxArcs

protectedinherited

Definition at line 165 of file IBayesNetGenerator.h.

Referenced by gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__checkConditions(), gum::SimpleBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::generateBN(), gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::IBayesNetGenerator(), gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::maxArcs(), gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::setMaxArcs(), and gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::setNbrNodes().

_maxModality

template<typename GUM_SCALAR , template< typename > class ICPTGenerator>

Size gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_maxModality

protectedinherited

Definition at line 166 of file IBayesNetGenerator.h.

Referenced by gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__createPartTree(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::__createTree(), gum::SimpleBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::generateBN(), gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::IBayesNetGenerator(), gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::maxModality(), and gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::setMaxModality().

_nbrNodes

template<typename GUM_SCALAR , template< typename > class ICPTGenerator>

Size gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::_nbrNodes

protectedinherited

Definition at line 164 of file IBayesNetGenerator.h.

Referenced by gum::SimpleBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::generateBN(), gum::MCBayesNetGenerator< GUM_SCALAR, ICPTGenerator, ICPTDisturber >::generateBN(), gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::IBayesNetGenerator(), gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::nbrNodes(), gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::setMaxArcs(), and gum::IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >::setNbrNodes().

---

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

• agrum/BN/generator/simpleBayesNetGenerator.h
• agrum/BN/generator/simpleBayesNetGenerator_tpl.h