nodeGraphPart.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_NODE_GRAPH_PART_H
#define GUM_NODE_GRAPH_PART_H
 
#include <algorithm>
#include <memory>
#include <optional>
#include <utility>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/bijection.h>
#include <agrum/base/core/signal/signalers.h>
#include <agrum/base/graphs/graphElements.h>
 
namespace gum {
 
  class NodeGraphPart;

  class NodeGraphPartIterator {
    friend class NodeGraphPart;
 
    public:
    using iterator_category = std::forward_iterator_tag;
    using value_type        = NodeId;
    using reference         = value_type&;
    using const_reference   = const value_type&;
    using pointer           = value_type*;
    using const_pointer     = const value_type*;
    using difference_type   = std::ptrdiff_t;
 
    // ############################################################################
    // ############################################################################

    explicit NodeGraphPartIterator(const NodeGraphPart& nodes) noexcept;

    NodeGraphPartIterator(const NodeGraphPartIterator& it) noexcept;

    NodeGraphPartIterator(NodeGraphPartIterator&& it) noexcept;

    virtual ~NodeGraphPartIterator() noexcept;

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

    NodeGraphPartIterator& operator=(const NodeGraphPartIterator& it) noexcept;

    NodeGraphPartIterator& operator=(NodeGraphPartIterator&& it) noexcept;

    bool operator==(const NodeGraphPartIterator& it) const noexcept;
 

    NodeGraphPartIterator& operator++() noexcept;

    value_type operator*() const;

 
    protected:
    void setPos_(NodeId id) noexcept;

    void validate_() noexcept;

    const NodeGraphPart* nodes_;

    NodeId pos_{0};
 
    // is this iterator still valid ?
    bool valid_{false};
  };

  class NodeGraphPartIteratorSafe final: public NodeGraphPartIterator, public Listener {
    friend class NodeGraphPart;
 
    public:
    using iterator_category = std::forward_iterator_tag;
    using value_type        = NodeId;
    using reference         = value_type&;
    using const_reference   = const value_type&;
    using pointer           = value_type*;
    using const_pointer     = const value_type*;
    using difference_type   = std::ptrdiff_t;
 
    // ############################################################################
    // ############################################################################

    explicit NodeGraphPartIteratorSafe(const NodeGraphPart& nodes);

    NodeGraphPartIteratorSafe(const NodeGraphPartIteratorSafe& it);

    NodeGraphPartIteratorSafe(NodeGraphPartIteratorSafe&& it);

    ~NodeGraphPartIteratorSafe() final;

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

    NodeGraphPartIteratorSafe& operator=(const NodeGraphPartIteratorSafe& it);

    NodeGraphPartIteratorSafe& operator=(NodeGraphPartIteratorSafe&& it);

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


    void whenNodeDeleted(const void* src, NodeId id);

  };

 
  class NodeGraphPart {
    public:
    using node_iterator            = NodeGraphPartIterator;
    using node_const_iterator      = NodeGraphPartIterator;
    using node_iterator_safe       = NodeGraphPartIteratorSafe;
    using node_const_iterator_safe = NodeGraphPartIteratorSafe;
 
    // something strange with SWIG (with "using", these definitions cored dump
    // the
    // swig process)
    using NodeIterator          = NodeGraphPartIterator;
    using NodeConstIterator     = NodeGraphPartIterator;
    using NodeIteratorSafe      = NodeGraphPartIteratorSafe;
    using NodeConstIteratorSafe = NodeGraphPartIteratorSafe;
 
    Signaler< NodeId > onNodeAdded;
    Signaler< NodeId > onNodeDeleted;
 
    // ############################################################################
    // ############################################################################


    explicit NodeGraphPart(Size holes_size          = HashTableConst::default_size,
                           bool holes_resize_policy = true);


    NodeGraphPart(const NodeGraphPart& s);

    NodeGraphPart(NodeGraphPart&& s);

    virtual ~NodeGraphPart();

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


    NodeGraphPart& operator=(const NodeGraphPart& p);

    NodeGraphPart& operator=(NodeGraphPart&& p);


    bool operator==(const NodeGraphPart& p) const;
 

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


    void populateNodes(const NodeGraphPart& s);


    template < typename T >
    void populateNodesFromProperty(const NodeProperty< T >& h);

    NodeId nextNodeId() const;


    virtual NodeId addNode();

    std::vector< NodeId > addNodes(Size n);


    virtual void addNodeWithId(const NodeId id);


    virtual void eraseNode(const NodeId id);

    bool existsNode(const NodeId id) const;

    bool exists(const NodeId id) const;

    bool emptyNodes() const;

    bool empty() const;

    virtual void clearNodes();

    virtual void clear();

    Size sizeNodes() const;

    Size size() const;

    NodeId bound() const;


    NodeSet asNodeSet() const;

    const NodeGraphPart& nodes() const;

    node_iterator_safe beginSafe() const;

    const node_iterator_safe& endSafe() const noexcept;

    node_iterator begin() const noexcept;

    const node_iterator& end() const noexcept;
 
    virtual   
        std::string toString() const;

    std::string nameFromId(NodeId id) const;

    std::optional< NodeId > idFromName(const std::string& name) const;

    void setName(NodeId id, const std::string& name);

    bool hasName(NodeId id) const;

    std::string dotNodeLabel(NodeId id) const;


    template < typename VAL >
    NodeProperty< VAL > nodesPropertyFromFunction(VAL (*f)(const NodeId&), Size size = 0) const;


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

    template < typename VAL >
    List< VAL > listMapNodes(VAL (*f)(const NodeId&)) const;

 
    private:
    friend class NodeGraphPartIterator;
    friend class NodeGraphPartIteratorSafe;

    void _updateEndIteratorSafe_();

    void _clearNodes_();

    void _eraseHole_(NodeId id);

    void _addHole_(NodeId id);
 
    // ############################################################################
    // ############################################################################

    bool _inHoles_(NodeId id) const;

    Size _sizeHoles_() const;


    NodeSet* _holes_;

    std::unique_ptr< Bijection< NodeId, std::string > > _names_;
 
    std::unique_ptr< Bijection< NodeId, std::string > > _cloneNames_() const;

    Size _holes_size_;

    bool _holes_resize_policy_;

    NodeGraphPartIteratorSafe _endIteratorSafe_;

    NodeId _boundVal_;
  };

  std::ostream& operator<<(std::ostream&, const NodeGraphPart&);
 
} /* namespace gum */
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphs/parts/nodeGraphPart_inl.h>
#endif   // GU%_NO_INLINE
 
#include <agrum/base/graphs/parts/nodeGraphPart_tpl.h>
 
#endif   // GUM_NODE_GRAPH_PART_H