graphElements.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_GRAPH_ELEMENTS_H
#define GUM_GRAPH_ELEMENTS_H
 
#include <iostream>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/set.h>
 
namespace gum {

  using NodeId = Size;
 
  /* ===========================================================================
   */
  /* ===========================================================================
   */
  /* ===                       GENERIC UNDIRECTED EDGES                      ===
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */
 
  class Edge {
    public:
    // ############################################################################
    // ############################################################################


    Edge(NodeId aN1, NodeId aN2);

    Edge(const Edge& src);

    ~Edge();

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

    GUM_NODISCARD NodeId other(NodeId id) const;

    GUM_NODISCARD NodeId first() const;

    GUM_NODISCARD NodeId second() const;

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

    Edge& operator=(const Edge& src);


    bool operator==(const Edge& src) const = default;

 
    private:
    NodeId n1;
    NodeId n2;
  };
 
  /* =========================================================================*/
  /* =========================================================================*/
  /* ==                        GENERIC DIRECTED EDGES                       ==*/
  /* =========================================================================*/
  /* =========================================================================*/
  /* ===========================================================================
   */
 
  class Arc {
    public:
    // ############################################################################
    // ############################################################################


    Arc(NodeId tail, NodeId head);

    Arc(const Arc& src);

    ~Arc();

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

    GUM_NODISCARD NodeId tail() const;

    GUM_NODISCARD NodeId head() const;

    GUM_NODISCARD NodeId other(NodeId id) const;

    GUM_NODISCARD NodeId first() const;

    GUM_NODISCARD NodeId second() const;

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

    Arc& operator=(const Arc& src);


    bool operator==(const Arc& src) const = default;

 
    private:
    NodeId n1;
    NodeId n2;

    void _setTail_(NodeId id);

    void _setHead_(NodeId id);

    void operator-();
  };

  // we need to provide hash functions for some Edge and Arc
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
  template <>
  class HashFunc< Edge >: public HashFuncBase< Edge > {
    public:
    static Size castToSize(const Edge& key);

    Size operator()(const Edge& key) const final;
  };
 
  template <>
  class HashFunc< Arc >: public HashFuncBase< Arc > {
    public:
    static Size castToSize(const Arc& key);

    Size operator()(const Arc& key) const final;
  };
 
#endif   // DOXYGEN_SHOULD_SKIP_THIS

  using EdgeSet = Set< Edge >;
  using NodeSet = Set< NodeId >;
  using ArcSet  = Set< Arc >;
 
  using ArcSetIterator  = ArcSet::const_iterator;
  using EdgeSetIterator = EdgeSet::const_iterator;
  using NodeSetIterator = NodeSet::const_iterator;
 
  inline const NodeSet emptyNodeSet;

  template < class VAL >
  using NodeProperty = HashTable< NodeId, VAL >;
  template < class VAL >
  using EdgeProperty = HashTable< Edge, VAL >;
  template < class VAL >
  using ArcProperty = HashTable< Arc, VAL >;


  std::ostream& operator<<(std::ostream& stream, const Edge& edge);

  std::ostream& operator<<(std::ostream& stream, const Arc& arc);
 
} /* namespace gum */
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
extern template class gum::HashFunc< gum::NodeSet >;
#endif
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/graphs/graphElements_inl.h>
#endif   /* GUM_NO_INLINE */
 
#endif   // GUM_GRAPH_ELEMENTS_H