KTBNDatabaseGenerator.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 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-2026                            *
 *       - 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_KTBN_DATABASE_GENERATOR_H
#define GUM_KTBN_DATABASE_GENERATOR_H
 
#include <cstddef>
#include <string>
#include <vector>
 
#include <agrum/base/core/progressNotification.h>
#include <agrum/KTBN/KTBN.h>
 
#include <string_view>
#include <unordered_set>
 
namespace gum {
 
  namespace learning {
    template < GUM_Numeric GUM_SCALAR >
    class KTBNDatabaseGenerator: public ProgressNotifier {
      public:
      enum class DiscretizedLabelMode : char { INTERVAL, MEDIAN, RANDOM };

      enum class VarOrderMode : char { RANDOM, TOPOLOGICAL, ANTI_TOPOLOGICAL };
 
      // #######################################################################
      // #######################################################################

      explicit KTBNDatabaseGenerator(const KTBN< GUM_SCALAR >& kdbn);

      ~KTBNDatabaseGenerator();

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

      std::vector< double > drawSamples(Size             nbSamples,
                                        Size             nbTimeSlices,
                                        std::string_view dirPath,
                                        std::string_view csvBaseName,
                                        VarOrderMode     mode         = VarOrderMode::RANDOM,
                                        bool             useLabels    = true,
                                        std::string      csvSeparator = ",");

      std::vector< double > drawSamples(const std::vector< Size >& nbTimeSlices,
                                        std::string_view           dirPath,
                                        std::string_view           csvBaseName,
                                        VarOrderMode               mode      = VarOrderMode::RANDOM,
                                        bool                       useLabels = true,
                                        std::string                csvSeparator = ",");

      void setDiscretizedLabelModeRandom();
      void setDiscretizedLabelModeMedian();
      void setDiscretizedLabelModeInterval();
 

      Size nbVars() const;

 
      private:
      struct ParentRef {
        const DiscreteVariable* var;           
        Idx                     col;           
        int                     lag;           
        bool                    isAtemporal;   
      };

      struct NodeRef {
        const DiscreteVariable*     var;       
        const Tensor< GUM_SCALAR >* cpt;       
        int                         slice;     
        Idx                         col;       
        std::vector< ParentRef >    parents;   
      };

      BayesNet< GUM_SCALAR > _template_;

      Size _k_;

      Size _nbVars_;

      std::vector< std::string > _baseCols_;

      std::vector< const DiscreteVariable* > _vars_;

      std::vector< NodeRef > _nodes_;

      std::vector< Idx > _kernel_;

      Instantiation _inst_;

      DiscretizedLabelMode _discretizedLabelMode_ = DiscretizedLabelMode::RANDOM;
 
      // ----- constructor helper -----

      static std::pair< std::string, int >
          _decode_(const std::string& name, const std::unordered_set< std::string >& temporalSet);

      void _build_(const KTBN< GUM_SCALAR >& kdbn);
 
      // ----- sampling -----

      Idx _drawVar_(const DiscreteVariable&     var,
                    const Tensor< GUM_SCALAR >& cpt,
                    double&                     log2likelihood);
 
      // ----- export -----

      std::string _label_(Idx col, Idx idx) const;

      void _writeTrajectory_(std::string_view          csvFileURL,
                             const std::vector< Idx >& traj,
                             Size                      nbTimeSlices,
                             bool                      useLabels,
                             const std::string&        csvSeparator,
                             const std::vector< Idx >& colOrder) const;
 
      // ----- column order -----
      // each fills @p colOrder: output position -> canonical column index

      void setVarOrderRandomized(std::vector< Idx >& colOrder) const;

      void setVarOrderTopological(std::vector< Idx >& colOrder) const;

      void setVarOrderAntiTopological(std::vector< Idx >& colOrder) const;

      std::vector< double > _drawSamples_(Size                       nbSamples,
                                          Size                       fixedLen,
                                          const std::vector< Size >* perTraj,
                                          std::string_view           dirPath,
                                          std::string_view           csvBaseName,
                                          VarOrderMode               mode,
                                          bool                       useLabels,
                                          const std::string&         csvSeparator);
 
      // forbidden copies / moves
      KTBNDatabaseGenerator(const KTBNDatabaseGenerator&)            = delete;
      KTBNDatabaseGenerator(KTBNDatabaseGenerator&&)                 = delete;
      KTBNDatabaseGenerator& operator=(const KTBNDatabaseGenerator&) = delete;
      KTBNDatabaseGenerator& operator=(KTBNDatabaseGenerator&&)      = delete;
    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class GUM_PUBLIC_KTBN KTBNDatabaseGenerator< double >;
#endif
 
  } /* namespace learning */
} /* namespace gum */
 
#include <agrum/KTBN/database/KTBNDatabaseGenerator_tpl.h>
 
#endif /* GUM_KTBN_DATABASE_GENERATOR_H */