graphElements_inl.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                           *
 *                                                                          *
 ****************************************************************************/
 
#pragma once
 

#include <algorithm>
#include <iostream>
 
#include <agrum/agrum.h>
 
// to facilitate parsing
#include <agrum/base/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);
  }
 
  // move constructor
  INLINE Edge::Edge(Edge&& src) noexcept : n1(src.n1), n2(src.n2) {   // for debugging purposes
    GUM_CONS_MOV(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;
  }
 
  // move operator
  INLINE Edge& Edge::operator=(Edge&& src) noexcept {
    // for debugging purposes
    GUM_OP_MOV(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(InvalidNode, 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; }
 
  // 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);
  }
 
  // move constructor
  INLINE Arc::Arc(Arc&& src) noexcept : n1(src.n1), n2(src.n2) {   // for debugging purposes
    GUM_CONS_MOV(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;
  }
 
  // move operator
  INLINE Arc& Arc::operator=(Arc&& src) noexcept {
    // for debugging purposes
    GUM_OP_MOV(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(InvalidNode, 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; }
 
  // 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 */