arcGraphPart.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_ARC_GRAPH_PART_H
#define GUM_ARC_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 ArcGraphPart {
    public:
    using ArcIterator = ArcSetIterator;
 
    Signaler2< NodeId, NodeId > onArcAdded;     // onArcAdded(tail,head)
    Signaler2< NodeId, NodeId > onArcDeleted;   // onArcDeleted(tail,head)
 
    // ############################################################################
    // ############################################################################


    explicit ArcGraphPart(Size arcs_size          = HashTableConst::default_size,
                          bool arcs_resize_policy = true);


    ArcGraphPart(const ArcGraphPart& s);

    virtual ~ArcGraphPart();

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


    ArcGraphPart& operator=(const ArcGraphPart& s);


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


    virtual void addArc(NodeId tail, NodeId head);


    virtual void eraseArc(const Arc& arc);


    bool existsArc(const Arc& arc) const;


    bool existsArc(NodeId tail, NodeId head) const;

    bool emptyArcs() const;

    void clearArcs();

    Size sizeArcs() const;

    const ArcSet& arcs() const;


    const NodeSet& parents(NodeId id) const;


    NodeSet family(NodeId id) const;


    NodeSet descendants(NodeId id) const;
 


    NodeSet ancestors(NodeId id) const;

    NodeSet children(const NodeSet& ids) const;

    NodeSet parents(const NodeSet& ids) const;

    NodeSet family(const NodeSet& ids) const;
 


    const NodeSet& children(NodeId id) const;


    void eraseParents(NodeId id);


    void unvirtualizedEraseParents(NodeId id);


    void eraseChildren(NodeId id);


    void unvirtualizedEraseChildren(NodeId id);

    std::string toString() const;

    template < typename VAL >
    ArcProperty< VAL > arcsProperty(VAL (*f)(const Arc&), Size size = 0) const;

    template < typename VAL >
    ArcProperty< VAL > arcsProperty(const VAL& a, Size size = 0) const;

    template < typename VAL >
    List< VAL > listMapArcs(VAL (*f)(const Arc&)) const;


    std::vector< NodeId > directedPath(NodeId node1, NodeId node2) const;


    std::vector< NodeId > directedUnorientedPath(NodeId node1, NodeId node2) const;

 
    protected:

    void eraseSetOfArcs_(const ArcSet& set);


    void unvirtualizedEraseSetOfArcs_(const ArcSet& set);
 
    private:
    Set< Arc > _arcs_;

    NodeProperty< NodeSet* > _parents_;

    NodeProperty< NodeSet* > _children_;

    void _checkParents_(NodeId id);

    void _checkChildren_(NodeId id);
  };


  std::ostream& operator<<(std::ostream& s, const ArcGraphPart& a);
 
} /* namespace gum */
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphs/parts/arcGraphPart_inl.h>
#endif   // GU%_NO_INLINE
 
#include <agrum/base/graphs/parts/arcGraphPart_tpl.h>
 
#endif   // GUM_ARC_GRAPH_PART_H