MCBayesNetGenerator.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2025                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

 
#ifndef GUM_MC_BAYES_NET_GENERATOR
#define GUM_MC_BAYES_NET_GENERATOR
 
#define NB_INIT_ITERATIONS 5000
 
#include <fstream>
#include <iostream>
#include <set>
#include <sstream>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/BN/generator/IBayesNetGenerator.h>
#include <agrum/BN/generator/simpleCPTDisturber.h>
#include <agrum/BN/inference/lazyPropagation.h>
 
namespace gum {
  template < typename GUM_SCALAR,
             template < typename > class ICPTGenerator = SimpleCPTGenerator,
             template < typename > class ICPTDisturber = SimpleCPTDisturber >
  class MCBayesNetGenerator:
      public IBayesNetGenerator< GUM_SCALAR, ICPTGenerator >,
      public ICPTDisturber< GUM_SCALAR > {
    public:
    // ############################################################################
    // ############################################################################

    MCBayesNetGenerator(Size nbrNodes,
                        Size maxArcs,
                        Idx  maxModality = 2,
                        Size iteration   = NB_INIT_ITERATIONS,
                        Idx  p           = 30,
                        Idx  q           = 40);

    explicit MCBayesNetGenerator(BayesNet< GUM_SCALAR > bayesNet,
                                 Size                   iteration = NB_INIT_ITERATIONS,
                                 Idx                    p         = 30,
                                 Idx                    q         = 40);

 
    ~MCBayesNetGenerator() override;

 
    // ############################################################################
    // ############################################################################

    void generateBN(BayesNet< GUM_SCALAR >& bayesNet) override;


 
    // ############################################################################
    // ############################################################################

    Size iteration() const;
    Idx p() const;
    Idx q() const;


    void setIteration(Size iteration);
    void setP(Idx p);
    void setQ(Idx q);

 
    protected:
    Size iteration_;
    Idx  p_, q_;
    /*
       bool                                          disturbing_;
    BayesNet< GUM_SCALAR >                        bayesNettemp_;
    HashTable< NodeId, Tensor< GUM_SCALAR >* > hashMarginal_;*/

    bool _isPolytree_();
    bool _connect_(NodeId i, NodeId j);
    bool _directedPath_(NodeId tail, NodeId head);
    void _insertArc_(NodeId i, NodeId j);
    void _eraseArc_(NodeId i, NodeId j, bool mustbeconnex = true);

    void _PMMx_poly_();

    void _PMMx_multi_();

    void _jump_poly_();

    void _jump_multi_();

    void _Add_or_Remove_();

    void _Add_and_Remove_();

    virtual bool _checkConditions_();

    bool _is_connected_(const NodeId i, const NodeId j, NodeSet& excluded);

    bool _directedPath_(NodeId tail, NodeId head, NodeSet& excluded);

 
    void _chooseNodes_(NodeId& i, NodeId& j);

    void _chooseCloseNodes_(NodeId& i, NodeId& j);

 
    void _transformPoly_(Idx nbiter);

    void _createTree_(Size BNSize);

    NodeId _createPartTree_(Size BNSize, Idx& n);
  };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class MCBayesNetGenerator< double >;
#endif
 
} /*namespace gum*/
 
#include <agrum/BN/generator/MCBayesNetGenerator_tpl.h>
#endif   // MCBAYESNETGENERATOR