HoldsCells.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"
 
namespace ceps
{
  template <class CellType>
  class HoldsCells
  {
    public:
      explicit HoldsCells(const CepsVector<CellType*>& cells);
 
      HoldsCells(CellType** cells, const CepsUInt& n);
 
      HoldsCells() = default;
 
      HoldsCells(const HoldsCells&) = default;
 
      HoldsCells(HoldsCells&&) noexcept = default;
 
      virtual ~HoldsCells() = default;
 
      HoldsCells&
      operator=(const HoldsCells&) = default;
 
      HoldsCells&
      operator=(HoldsCells&&) noexcept = default;
 
      CepsUInt
      getNumberOfCells() const;
 
      CepsUInt
      countValidCells();
 
      CepsVector<CellType*>
      getValidCells();
 
      CepsVector<CellType*>&
      getCells();
 
      const CepsVector<CellType*>&
      getCells() const;
 
      CellType*&
      getCellAt(const CepsUInt& i);
 
      const CellType*&
      getCellAt(const CepsUInt& i) const;
 
      void
      setCells(const CepsVector<CellType*>& cells);
 
      void
      setCells(CellType** cells, const CepsUInt& n);
 
      template <class _It>
      void
      setCells (_It first, _It last);
      
      void
      setCellAt(const CepsUInt& i, CellType* neigh);
 
      void
      addCell(CellType*& name);
 
      void
      addCells(const CepsVector<CellType*>& cells);
 
      void
      addCells(CellType** cells, const CepsUInt& n);
 
      template <class _It>
      void
      addCells(_It first, _It last);
 
      void
      removeCell(CellType*& name);
 
      void
      removeCells(const CepsVector<CellType*>& cells);
 
      void
      removeCells(CellType **cells, const CepsUInt &n);
 
      template <class _It>
      void
      removeCells(_It first, _It last);
 
      void
      clearCells();
 
      CepsBool
      hasCell(CellType*& neigh);
 
      CepsBool
      hasAllCells(const CepsVector<CellType*>& cells);
 
      CepsBool
      hasAllCells(CellType** cells, const CepsUInt& n);
 
      template <class _It>
      CepsBool
      hasAllCells(_It first, _It last);
 
      CepsBool
      hasOneOfCells(const CepsVector<CellType*>& cells);
 
      CepsBool
      hasOneOfCells(CellType** cells, const CepsUInt& n);
 
      template <class _It>
      CepsBool
      hasOneOfCells(_It first, _It last);
 
      CepsIndex
      getCellIndex(CepsUInt i) const;
 
      CepsVector<CepsIndex>
      getCellsIndices() const;
 
      void
      reset();
 
 
    protected:
 
      void
      errorOnCellIndex(CepsUInt i, const CepsString& funcName) const;
 
 
    protected:
 
      CepsVector<CellType*> m_cells;
 
  };
 
}  // namespace ceps
 
// Template member definitions
#include "common/abstract/HoldsCells.tpp"