KTBNGenerator.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_GENERATOR_H
#define GUM_KTBN_GENERATOR_H
 
#include <string>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/KTBN/KTBN.h>
 
#include <agrum/base/core/utils_random.h>
 
namespace gum {

  template < GUM_Numeric GUM_SCALAR >
  class KTBNGenerator {
    public:
    // ===========================================================================
    // ===========================================================================

    explicit KTBNGenerator(Size k,
                           Size nbTemporal,
                           Size nbAtemporal = 0,
                           Size maxArcs     = 0,
                           Size maxModality = 2);

    ~KTBNGenerator();

    // ===========================================================================
    // ===========================================================================

    void generateKTBN(KTBN< GUM_SCALAR >& out);

    KTBN< GUM_SCALAR > generate();

    // ===========================================================================
    // ===========================================================================

    KTBNGenerator< GUM_SCALAR >& setDensity(double density);

    KTBNGenerator< GUM_SCALAR >& setDomainRange(Size minModality, Size maxModality);

    KTBNGenerator< GUM_SCALAR >& setMaxParents(Size maxParents);

    KTBNGenerator< GUM_SCALAR >& setGuaranteeOrder(bool on);

    KTBNGenerator< GUM_SCALAR >& setGenerateCPTs(bool on);

    KTBNGenerator< GUM_SCALAR >& setNamePrefixes(const std::string& temporal,
                                                 const std::string& atemporal);

    // ===========================================================================
    // ===========================================================================

    Size k() const;

    Size nbLegalArcs() const;

 
    private:
    struct _Arc_ {
      std::string tailBase;
      int         tailSlice;
      std::string headBase;
      int         headSlice;
    };
 
    Size   _k_;
    Size   _nbTemporal_;
    Size   _nbAtemporal_;
    Size   _maxArcs_;
    Size   _minModality_{2};
    Size   _maxModality_;
    Size   _maxParents_{0};
    double _density_{0.1};
    bool   _guaranteeOrder_{true};
    bool   _generateCPTs_{true};
 
    std::string _temporalPrefix_{"X"};
    std::string _atemporalPrefix_{"A"};

    std::vector< _Arc_ > _legalArcs_(const std::vector< std::string >& temporal,
                                     const std::vector< std::string >& atemporal,
                                     const std::vector< Size >&        tRank,
                                     const std::vector< Size >&        aRank) const;

    template < typename T >
    static void _shuffle_(std::vector< T >& v);
  };
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class GUM_PUBLIC_KTBN KTBNGenerator< double >;
#endif
 
}   // namespace gum
 
#include <agrum/KTBN/generator/KTBNGenerator_tpl.h>
 
#endif /* GUM_KTBN_GENERATOR_H */