graphElements_inl.h

Go to the documentation of this file.

/**
 *
 *   Copyright 2005-2020 Pierre-Henri WUILLEMIN(@LIP6) & Christophe GONZALES(@AMU)
 *   info_at_agrum_dot_org
 *
 *  This library is free software: you can redistribute it and/or modify
 *  it under the terms of 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.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */


/** @file
 * @brief Inlined implementation of directed and undirected edges
 *
 * @author Christophe GONZALES(@AMU) and Pierre-Henri WUILLEMIN(@LIP6)
 */
#include <algorithm>
#include <iostream>

#include <agrum/agrum.h>

// to facilitate parsing
#include <agrum/tools/graphs/graphElements.h>

#ifndef DOXYGEN_SHOULD_SKIP_THIS

namespace gum {

  /* ===========================================================================
   */
  /* ===========================================================================
   */
  /* ===                GENERIC UNDIRECTED EDGES IMPLEMENTATION              ===
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */

  /// basic constructor

  INLINE Edge::Edge(NodeId aN1, NodeId aN2) :
      n1(std::min(aN1, aN2)), n2(std::max(aN1, aN2)) {
    // for debugging purposes
    GUM_CONSTRUCTOR(Edge);
  }

  /// copy constructor

  INLINE Edge::Edge(const Edge& src) : n1(src.n1), n2(src.n2) {
    // for debugging purposes
    GUM_CONS_CPY(Edge);
  }

  /// copy operator

  INLINE Edge& Edge::operator=(const Edge& src) {
    // for debugging purposes
    GUM_OP_CPY(Edge);
    n1 = src.n1;
    n2 = src.n2;
    return *this;
  }

  /// destructor

  INLINE Edge::~Edge() {
    // for debugging purposes
    GUM_DESTRUCTOR(Edge);
  }

  /// returns an extremal node of an edge given the ID of the other one

  INLINE NodeId Edge::other(NodeId id) const {
    if (id == n1)
      return n2;
    else if (id == n2)
      return n1;
    else {
      GUM_ERROR(IdError, id << " does not belong to this edge");
    }
  }

  /// returns one extremal node ID (whichever one it is is unspecified)

  INLINE NodeId Edge::first() const { return n1; }

  /// returns the second extremal node

  INLINE NodeId Edge::second() const { return n2; }

  /// check if two undirected edges are equal

  INLINE bool Edge::operator==(const Edge& src) const {
    return ((n1 == src.n1) && (n2 == src.n2));
  }

  /// check if two undirected edges are different

  INLINE bool Edge::operator!=(const Edge& src) const {
    return ((n1 != src.n1) || (n2 != src.n2));
  }


  // Returns the value of a key as a Size
  INLINE Size HashFunc< Edge >::castToSize(const Edge& key) {
    return Size(key.first()) * HashFuncConst::pi
         + Size(key.second()) * HashFuncConst::gold;
  }

  // Computes the hashed value of a key.
  INLINE Size HashFunc< Edge >::operator()(const Edge& key) const {
    return castToSize(key) & this->hash_mask_;
  }


  /* ===========================================================================
   */
  /* ===========================================================================
   */
  /* ===                 GENERIC DIRECTED EDGES IMPLEMENTATION               ===
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */

  /// basic constructor.

  INLINE Arc::Arc(NodeId tail, NodeId head) : n1(tail), n2(head) {
    // for debugging purposes
    GUM_CONSTRUCTOR(Arc);
  }

  /// copy constructor

  INLINE Arc::Arc(const Arc& src) : n1(src.n1), n2(src.n2) {
    // for debugging purposes
    GUM_CONS_CPY(Arc);
  }

  /// copy operator

  INLINE Arc& Arc::operator=(const Arc& src) {
    // for debugging purposes
    GUM_OP_CPY(Arc);
    n1 = src.n1;
    n2 = src.n2;
    return *this;
  }

  /// destructor

  INLINE Arc::~Arc() {
    // for debugging purposes
    GUM_DESTRUCTOR(Arc);
  }

  /// returns the tail of the arc

  INLINE NodeId Arc::tail() const { return n1; }

  /// modifies the tail of the arc

  INLINE void Arc::setTail__(NodeId id) { n1 = id; }

  /// returns the head of the arc

  INLINE NodeId Arc::head() const { return n2; }

  /// modifies the head of the arc

  INLINE void Arc::setHead__(NodeId id) { n2 = id; }

  /// returns an extremal node of an edge given the ID of the other one

  INLINE NodeId Arc::other(NodeId id) const {
    if (id == n1)
      return n2;
    else if (id == n2)
      return n1;
    else {
      GUM_ERROR(IdError, id << " does not belong to this arc");
    }
  }

  /// returns one extremal node ID (whichever one it is is unspecified)

  INLINE NodeId Arc::first() const { return n1; }

  /// returns the second extremal node

  INLINE NodeId Arc::second() const { return n2; }

  /// check if two arcs are equal

  INLINE bool Arc::operator==(const Arc& src) const {
    return ((n1 == src.n1) && (n2 == src.n2));
  }

  /// check if two arcs are different

  INLINE bool Arc::operator!=(const Arc& src) const {
    return ((n1 != src.n1) || (n2 != src.n2));
  }

  /// reverses the direction of the arc

  INLINE void Arc::operator-() {
    NodeId n_temp = n1;
    n1            = n2;
    n2            = n_temp;
  }


  // Returns the value of a key as a Size
  INLINE Size HashFunc< Arc >::castToSize(const Arc& key) {
    return Size(key.first()) * HashFuncConst::pi
         + Size(key.second()) * HashFuncConst::gold;
  }

  // Computes the hashed value of a key.
  INLINE Size HashFunc< Arc >::operator()(const Arc& key) const {
    return castToSize(key) & this->hash_mask_;
  }


} /* namespace gum */

#endif /* DOXYGEN_SHOULD_SKIP_THIS */