UGmodel.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_UGMODEL_H
#define GUM_UGMODEL_H
 
#include <agrum/agrum.h>
 
#include <agrum/base/graphicalModels/discreteGraphicalModel.h>
 
namespace gum {

  class UGmodel: public DiscreteGraphicalModel {
    public:

    UGmodel();

    ~UGmodel() override;

    UGmodel(const UGmodel& source);

    UGmodel(UGmodel&& source);



    [[nodiscard]] UndiGraph graph() const;

    Size size() const final;

    Size sizeEdges() const;
 
    const NodeGraphPart& nodes() const final;

    bool exists(NodeId node) const final;
    bool exists(std::string_view name) const final;


    const EdgeSet& edges() const;


    bool existsEdge(const NodeId node1, const NodeId node2) const;
    bool existsEdge(std::string_view name1, std::string_view name2) const;


    const NodeSet& neighbours(const NodeId id) const;
    const NodeSet& neighbours(std::string_view name) const;

    bool isIndependent(NodeId X, NodeId Y, const NodeSet& Z) const final;
    bool isIndependent(const NodeSet& X, const NodeSet& Y, const NodeSet& Z) const final;
 
    bool isIndependent(std::string_view                  Xname,
                       std::string_view                  Yname,
                       const std::vector< std::string >& Znames) const;
 
    bool isIndependent(const std::vector< std::string >& Xnames,
                       const std::vector< std::string >& Ynames,
                       const std::vector< std::string >& Znames) const;

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


    bool hasSameStructure(const UGmodel& other) const;

    NodeProperty< NodeId > connectedComponents() const;


    NodeSet family(const NodeId id) const final;
    NodeSet family(std::string_view name) const final;

    const UndiGraph& internalGraph() const;
 
    protected:
    UGmodel& operator=(const UGmodel& source);

    UGmodel& operator=(UGmodel&& source);

    UndiGraph graph_;
  };
}   // namespace gum
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphicalModels/UGmodel_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_UGMODEL_H */