graphicalModel.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_GRAPHICALMODEL_H
#define GUM_GRAPHICALMODEL_H
#include <agrum/agrum.h>
 
#include <agrum/base/graphicalModels/variableNodeMap.h>
#include <agrum/base/graphs/DAG.h>
#include <agrum/base/multidim/instantiation.h>
 
namespace gum {
  class GraphicalModel {
    public:

    GraphicalModel();

    virtual ~GraphicalModel();

    GraphicalModel(const GraphicalModel& source);

    GraphicalModel(GraphicalModel&& source) noexcept;


    const std::string& property(std::string_view name) const;

    const std::string& propertyWithDefault(std::string_view   name,
                                           const std::string& byDefault) const;

    void setProperty(std::string_view name, std::string_view value);

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

    bool existsProperty(std::string_view name) const;

    void updateMetaData();


    virtual const VariableNodeMap& variableNodeMap() const = 0;

    virtual Size size() const = 0;

    virtual bool empty() const;

    virtual bool exists(NodeId node) const           = 0;
    virtual bool exists(std::string_view name) const = 0;

    std::vector< std::string > names(const std::vector< NodeId >& ids) const;

    std::vector< std::string > names(const NodeSet& ids) const;

    std::vector< NodeId > ids(const std::vector< std::string >& names) const;

    NodeSet nodeset(const std::vector< std::string >& names) const;

    gum::VariableSet variables(const std::vector< std::string >& l) const;

    gum::VariableSet variables(const NodeSet& ids) const;
 
    virtual const NodeGraphPart& nodes() const = 0;

    Instantiation completeInstantiation() const;

    virtual const DiscreteVariable& variable(NodeId id) const = 0;

    virtual NodeId nodeId(const DiscreteVariable& var) const = 0;

    virtual NodeId idFromName(std::string_view name) const = 0;

    virtual const DiscreteVariable& variableFromName(std::string_view name) const = 0;

 
    double log10DomainSize() const;

    virtual bool isIndependent(NodeId X, NodeId Y, const NodeSet& Z) const = 0;

    virtual bool isIndependent(const NodeSet& X, const NodeSet& Y, const NodeSet& Z) const = 0;
 

    static std::string spaceCplxToString(double dSize, int dim, Size usedMem);


    virtual NodeSet family(const NodeId id) const       = 0;
    virtual NodeSet family(std::string_view name) const = 0;
 
    protected:
    GraphicalModel& operator=(const GraphicalModel& source);

    GraphicalModel& operator=(GraphicalModel&& source) noexcept;

    void _nameNodes_(NodeGraphPart& g) const;
 
    private:
    HashTable< std::string, std::string > _propertiesMap_;

    const HashTable< std::string, std::string >& _properties_() const;
  };
}   // namespace gum
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphicalModels/graphicalModel_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_GRAPHICALMODEL_H */