BNDatabaseGenerator.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_BN_DATABASE_GENERATOR
#define GUM_BN_DATABASE_GENERATOR
 
#include <fstream>
 
#include <agrum/base/core/progressNotification.h>
#include <agrum/base/database/databaseTable.h>
#include <agrum/BN/BayesNet.h>
 
namespace gum {
 
  namespace learning {
    template < typename GUM_SCALAR >
    class BNDatabaseGenerator: public ProgressNotifier {
      public:
      enum class DiscretizedLabelMode : char { INTERVAL, MEDIAN, RANDOM };
 
      // #######################################################################
      // #######################################################################

      explicit BNDatabaseGenerator(const BayesNet< GUM_SCALAR >& bn);

      ~BNDatabaseGenerator();

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

      double drawSamples(Size nbSamples);

      double drawSamples(Size nbSamples, const gum::Instantiation& evs, int timeout = 300);

      void setDiscretizedLabelModeRandom();

      void setDiscretizedLabelModeMedian();

      void setDiscretizedLabelModeInterval();

      void toCSV(const std::string& csvFileURL,
                 bool               useLabels     = true,
                 bool               append        = false,
                 std::string        csvSeparator  = ",",
                 bool               checkOnAppend = false) const;

      DatabaseTable toDatabaseTable(bool useLabels = true) const;

      std::vector< std::vector< Idx > > database() const;
 
      Size samplesNbRows() const;
      Size samplesNbCols() const;
 
      Idx         samplesAt(Idx row, Idx col) const;
      std::string samplesLabelAt(Idx row, Idx col) const;

      void setVarOrder(const std::vector< Idx >& varOrder);

      void setVarOrder(const std::vector< std::string >& varOrder);

      void setVarOrderFromCSV(const std::string& csvFileURL, const std::string& csvSeparator = ",");

      void setTopologicalVarOrder();

      void setAntiTopologicalVarOrder();

      void setRandomVarOrder();

      std::vector< Idx > varOrder() const;

      std::vector< std::string > varOrderNames() const;

      double log2likelihood() const;

      const BayesNet< GUM_SCALAR >& bn(void) { return _bn_; };

 
      private:
      DiscretizedLabelMode _discretizedLabelMode_;
      const BayesNet< GUM_SCALAR >& _bn_;

      Bijection< std::string, NodeId > _names2ids_;

      Size _nbVars_;

      std::vector< std::vector< Idx > > _database_;

      std::vector< Idx > _varOrder_;

      bool _drawnSamples_ = false;

      double _log2likelihood_ = 0;

      std::string _label_(const std::vector< Idx >& row, const DiscreteVariable& v, Idx i) const;

      std::vector< Idx > _varOrderFromCSV_(const std::string& csvFileURL,
                                           const std::string& csvSeparator = ",") const;

      std::vector< Idx > _varOrderFromCSV_(std::ifstream&     csvFile,
                                           const std::string& csvSeparator = ",") const;
 
      // forbidden copies / moves
      BNDatabaseGenerator(const BNDatabaseGenerator&)            = delete;
      BNDatabaseGenerator(BNDatabaseGenerator&&)                 = delete;
      BNDatabaseGenerator& operator=(const BNDatabaseGenerator&) = delete;
      BNDatabaseGenerator& operator=(BNDatabaseGenerator&&)      = delete;
    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class BNDatabaseGenerator< double >;
#endif
 
  } /* namespace learning */
} /* namespace gum */
 
#include <agrum/BN/database/BNDatabaseGenerator_tpl.h>
#endif /* BN_DATABASE_GENERTOR */