edgeGraphPart.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 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-2025                            *
 *       - 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_EDGE_GRAPH_PART_H
#define GUM_EDGE_GRAPH_PART_H
 
 
#include <algorithm>
#include <utility>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/signal/signalers.h>
#include <agrum/base/graphs/graphElements.h>
 
namespace gum {

 
  class EdgeGraphPart {
    public:
    using EdgeIterator = EdgeSetIterator;
 
    Signaler2< NodeId, NodeId > onEdgeAdded;
    Signaler2< NodeId, NodeId > onEdgeDeleted;
 
    // ############################################################################
    // ############################################################################


    explicit EdgeGraphPart(Size edges_size          = HashTableConst::default_size,
                           bool edges_resize_policy = true);


    EdgeGraphPart(const EdgeGraphPart& s);

    virtual ~EdgeGraphPart();

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


    EdgeGraphPart& operator=(const EdgeGraphPart& s);


    bool operator==(const EdgeGraphPart& p) const;
 
    // ############################################################################
    // ############################################################################


    virtual void addEdge(NodeId n1, NodeId n2);


    virtual void eraseEdge(const Edge& edge);


    bool existsEdge(const Edge& edge) const;


    bool existsEdge(NodeId n1, NodeId n2) const;

    bool emptyEdges() const;

    virtual void clearEdges();

    Size sizeEdges() const;

    const EdgeSet& edges() const;


    const NodeSet& neighbours(NodeId id) const;


    void eraseNeighbours(NodeId id);


    void unvirtualizedEraseNeighbours(NodeId id);

    virtual std::string toString() const;

    template < typename VAL >
    EdgeProperty< VAL > edgesProperty(VAL (*f)(const Edge&), Size size = 0) const;

    template < typename VAL >
    EdgeProperty< VAL > edgesProperty(const VAL& val, Size size = 0) const;

    template < typename VAL >
    List< VAL > listMapEdges(VAL (*f)(const Edge&)) const;


    std::vector< NodeId > undirectedPath(NodeId node1, NodeId node2) const;
    bool hasUndirectedPath(NodeId n1, NodeId n2) const;

    bool hasUndirectedPath(NodeId n1, NodeId n2, const NodeSet& except) const;
    bool hasUndirectedPath(const NodeSet& n1, const NodeSet& n2, const NodeSet& except) const;
 
    private:
    EdgeSet _edges_;

    NodeProperty< NodeSet* > _neighbours_;

    void _checkNeighbours_(NodeId id);
 
    void _clearEdges_();
  };

  std::ostream& operator<<(std::ostream&, const EdgeGraphPart&);
 
} /* namespace gum */
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphs/parts/edgeGraphPart_inl.h>
#endif   // GUM_NO_INLINE
 
#include <agrum/base/graphs/parts/edgeGraphPart_tpl.h>
 
#endif   // GUM_EDGE_GRAPH_PART_H