HoldsNodes.hpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   CEPS 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 General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
#include "common/core/CepsTypes.hpp"
#include <source_location>
 
namespace ceps
{
 
  template <class NodeType>
  class HoldsNodes
  {
 
    public:
 
      explicit HoldsNodes(const CepsVector<NodeType*>& nodes);
  
      HoldsNodes(NodeType** nodes, const CepsUInt& n);
  
      HoldsNodes() = default;
  
      HoldsNodes(const HoldsNodes&) = default;
  
      HoldsNodes(HoldsNodes&&) noexcept = default;
  
      virtual ~HoldsNodes() = default;
 
      HoldsNodes&
      operator=(const HoldsNodes&) = default;
  
      HoldsNodes&
      operator=(HoldsNodes&&) noexcept = default;
 
      CepsUInt
      getNumberOfNodes() const;
 
      CepsUInt
      countValidNodes();
 
      CepsVector<NodeType*>&
      getNodes();
  
      const CepsVector<NodeType*>&
      getNodes() const;
 
      NodeType*
      getNodeAt(const CepsUInt& i);
  
      const NodeType*
      getNodeAt(const CepsUInt& i) const;
 
      void
      setNodes(const CepsVector<NodeType*>& nodes);
  
      void
      setNodes(NodeType** nodes, const CepsUInt& n);
  
      template <class _It>
      void
      setNodes(_It first, _It last);
 
      void
      setNodeAt(const CepsUInt& i, NodeType* neigh);
 
      void
      addNode(NodeType* name);
  
      void
      addNodes(const CepsVector<NodeType*>& nodes);
  
      void
      addNodes(NodeType** nodes, const CepsUInt& n);
  
      template <class _It>
      void
      addNodes(_It first, _It last);
 
      void
      removeNode(NodeType*& name);
  
      void
      removeNodes(const CepsVector<NodeType*>& nodes);
  
      void
      removeNodes(NodeType** nodes, const CepsUInt& n);
  
      template <class _It>
      void
      removeNodes(_It first, _It last);
 
      void
      clearNodes();
  
      CepsBool
      hasNode(NodeType*& neigh);
  
      CepsBool
      hasAllNodes(const CepsVector<NodeType*>& nodes);
  
      CepsBool
      hasAllNodes(NodeType** nodes, const CepsUInt& n);
  
      template <class _It>
      CepsBool
      hasAllNodes(_It first, _It last);
  
      CepsBool
      hasOneOfNodes(const CepsVector<NodeType*>& nodes);
  
      CepsBool
      hasOneOfNodes(NodeType** nodes, const CepsUInt& n);
  
      template <class _It>
      CepsBool
      hasOneOfNodes(_It first, _It last);
 
      CepsVector<NodeType*>
      getValidNodes() const;
 
      CepsGlobalIndex
      getNodeIndex(CepsUInt i) const;
 
      CepsVector<CepsGlobalIndex>
      getNodeIndices() const;
 
      void
      getNodeIndices(CepsGlobalIndex* nodesIndices, const CepsSize& nAllocated) const;
 
      void
      reset();
  
 
    protected:
  
      void
      errorOnNodeIndex(CepsUInt i, std::source_location loc = std::source_location::current()) const;
 
 
    protected:
  
      CepsVector<NodeType*> m_nodes;
 
      NodeType* m_dummyNode; 
 
  };
 
}  // namespace ceps
 
// Template member functions in a fake cpp
#include "common/abstract/HoldsNodes.tpp"