KTBN.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_H
#define GUM_KTBN_H
 
#include <concepts>
#include <map>
#include <memory>
#include <string>
#include <utility>
#include <variant>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/BN/BayesNet.h>
 
#include <unordered_set>
 
namespace gum {

  struct GUM_PUBLIC_KTBN KTBNModality {
    template < std::integral T >
    KTBNModality(T modality);

    KTBNModality(const char* modality);

    KTBNModality(std::string modality);

    Idx toIndex(const DiscreteVariable& var) const;

    bool isLabel;
    Idx index{};
    std::string label;
  };

  template < GUM_Numeric GUM_SCALAR >
  class KTBN {
    public:
    static constexpr int ATEMPORAL = -1;
 
    // ===========================================================================
    // ===========================================================================

    explicit KTBN(Size k = 2);

    virtual ~KTBN();

    KTBN(const KTBN< GUM_SCALAR >& source);

    KTBN(KTBN< GUM_SCALAR >&& source) noexcept;

    KTBN< GUM_SCALAR >& operator=(const KTBN< GUM_SCALAR >& source);

    KTBN< GUM_SCALAR >& operator=(KTBN< GUM_SCALAR >&& source) noexcept;

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

    Size k() const;

    Size size() const;

    Size sizeArcs() const;

    bool empty() const;

    void clear();

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

    void add(const DiscreteVariable& var, bool temporal = true);

    void add(std::string_view fast_description,
             bool             temporal       = true,
             unsigned int     default_nbrmod = 2);

    void addTemporal(const DiscreteVariable& var);
    void addAtemporal(const DiscreteVariable& var);

    void addTemporal(std::string_view fast_description, unsigned int default_nbrmod = 2);
    void addAtemporal(std::string_view fast_description, unsigned int default_nbrmod = 2);

    void erase(std::string_view base);

    void changeVariableName(std::string_view oldBase, std::string_view newBase);

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

    bool exists(std::string_view base) const;

    const std::unordered_set< std::string >& temporalVarNames() const;

    const std::unordered_set< std::string >& atemporalVarNames() const;

    Size nbTemporalVars() const;

    Size nbAtemporalVars() const;

    std::vector< std::pair< std::string, int > > nodes() const;

    std::vector< std::pair< std::string, int > > parents(std::string_view base, int slice) const;
    std::vector< std::pair< std::string, int > > parents(std::string_view node_name) const;

    std::vector< std::pair< std::string, int > > children(std::string_view base, int slice) const;
    std::vector< std::pair< std::string, int > > children(std::string_view node_name) const;

    const DiscreteVariable& variable(std::string_view base, int slice) const;

    const DiscreteVariable& variable(std::string_view node_name) const;

    int timeSlice(const DiscreteVariable& var) const;

    std::string baseName(const DiscreteVariable& var) const;

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

    void addArc(std::string_view tailBase, int tailSlice, std::string_view headBase, int headSlice);

    void addArc(std::string_view tail, std::string_view head);

    void eraseArc(std::string_view tailBase,
                  int              tailSlice,
                  std::string_view headBase,
                  int              headSlice);

    void eraseArc(std::string_view tail, std::string_view head);

    bool existsArc(std::string_view tailBase,
                   int              tailSlice,
                   std::string_view headBase,
                   int              headSlice) const;

    bool existsArc(std::string_view tail, std::string_view head) const;

    std::vector< std::pair< std::pair< std::string, int >, std::pair< std::string, int > > >
        arcs() const;

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

    const Tensor< GUM_SCALAR >& cpt(std::string_view base, int slice) const;
    const Tensor< GUM_SCALAR >& cpt(std::string_view node_name) const;

    void fillCPT(std::string_view                                               base,
                 int                                                            slice,
                 const std::map< std::pair< std::string, int >, KTBNModality >& parents,
                 const std::vector< GUM_SCALAR >&                               distribution) const;

    void fillCPT(std::string_view                 node_name,
                 const std::map< std::variant< std::string, std::pair< std::string, int > >,
                                 KTBNModality >&  parents,
                 const std::vector< GUM_SCALAR >& distribution) const;

    void generateCPTs() const;

    void generateCPT(std::string_view base, int slice) const;
    void generateCPT(std::string_view node_name) const;

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

    BayesNet< GUM_SCALAR > toBN() const;

    BayesNet< GUM_SCALAR > unroll(Size nbTimeSlices) const;

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

    void save(std::string_view filename) const;

    static KTBN< GUM_SCALAR > load(std::string_view filename);

    static KTBN< GUM_SCALAR > fromBN(const BayesNet< GUM_SCALAR >&            bn,
                                     const std::unordered_set< std::string >& atemporalNodes = {},
                                     std::vector< std::string >*              warnings = nullptr);

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

    std::string toString() const;

    std::string toDot() const;

    std::string toUnrolledDot(Size T, bool highlightReplicated = false) const;

    std::string bnToDot() const;

    std::string summaryGraph() const;

 
    private:
    Size _k_;

    BayesNet< GUM_SCALAR > _bn_;

    std::unordered_set< std::string > _temporal_;

    std::unordered_set< std::string > _atemporal_;

    std::string _encode_(std::string_view base, int slice) const;

    std::pair< std::string, int > _decodeName_(std::string_view name) const;

    std::pair< std::string, int > _determineNode_(const std::string& name) const;

    std::vector< std::pair< std::string, int > > _determineNodeSet_(const NodeSet& ids) const;

    NodeId _validateVariable_(std::string_view base, int slice) const;

    void _validateAdd_(const std::string& base, bool temporal) const;

    void _determineNodesFromBN_(const std::unordered_set< std::string >& atemporalNodes,
                                std::vector< std::string >*              warnings);

    static std::pair< std::string, bool > _resolveGumFormat_(std::string_view filename);

    std::string _timeSlicesToDot_(const BayesNet< GUM_SCALAR >& bn, bool highlightReplicated) const;

    static std::string _escapeDot_(std::string_view name);
  };
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class GUM_PUBLIC_KTBN KTBN< double >;
#endif

  template < GUM_Numeric GUM_SCALAR >
  std::ostream& operator<<(std::ostream& output, const KTBN< GUM_SCALAR >& kdbn);
 
}   // namespace gum
 
// include the inlined functions if necessary
#ifndef GUM_NO_INLINE
#  include <agrum/KTBN/KTBN_inl.h>
#endif /* GUM_NO_INLINE */
 
#include <agrum/KTBN/KTBN_tpl.h>
 
#endif /* GUM_KTBN_H */