LocalGlobalMapping.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/containers/CepsVector.hpp"
#include "common/core/CepsTypeTools.hpp"
#include "common/core/CepsTypes.hpp"
 
template <class _Type, class _Hash=CepsHash>
class LocalGlobalMapping
{
  public:
 
    LocalGlobalMapping();
   
    ~LocalGlobalMapping();
  
    void
    reserve(CepsUInt n);
 
    void
    append(const _Type&x , const _Hash& hashValue);
  
    void
    append(const _Type& x, const _Hash& hashValue, const CepsGlobalIndex& gId);
 
    const CepsVector<_Type>&
    all() const;
  
    CepsVector<_Type>&
    all();
 
    CepsUInt
    size() const;
  
    CepsBool
    contains(const _Type& x) const;
  
    void
    destroyObjects();
  
    void
    reset();
  
    void
    synchronizeLocalSizes();
  
    void
    setGlobalIndicesFromLocals();
  
    void
    updateObjects(std::function<void(_Type&,CepsGlobalIndex)> func);
 
    const CepsVector<CepsUInt>&
    getLocalSizes() const;
 
    CepsBool
    hasLocal(const CepsLocalIndex& lId) const;
  
    CepsBool
    hasGlobal(const CepsGlobalIndex& gId) const;
 
    CepsBool
    hasHash(const _Hash& hId) const;
  
    _Type&
    atLocal(const CepsLocalIndex& lId, const _Type& def);
 
    const _Type&
    atLocal(const CepsLocalIndex& lId, const _Type& def) const;
 
    const _Type&
    atLocal(const CepsLocalIndex& lId) const;
  
    _Type&
    atLocal(const CepsLocalIndex& lId);
  
    const CepsGlobalIndex&
    localToGlobal(const CepsLocalIndex& lId) const;
  
    _Type&
    atGlobal(const CepsGlobalIndex& gId, const _Type& def);
  
    const _Type&
    atGlobal(const CepsGlobalIndex& gId, const _Type& def) const;
  
    _Type&
    atGlobal(const CepsGlobalIndex& gId);
  
    const _Type&
    atGlobal(const CepsGlobalIndex& gId) const;
  
    const CepsLocalIndex&
    globalToLocal(const CepsGlobalIndex& gId) const;
  
    _Type&
    atHash(const _Hash& hId);
  
    const _Type&
    atHash(const _Hash& hId) const;
  
    _Type&
    atHash(const _Hash& hId, const _Type& def);
  
    const _Type&
    atHash(const _Hash& hId, const _Type& def) const;
  
    const CepsLocalIndex&
    hashToLocal(const _Hash& hId) const;
  
    const CepsGlobalIndex&
    hashToGlobal(const _Hash& hId) const;
 
    void
    registerIndices(const CepsLocalIndex& localId, const CepsGlobalIndex& globalId);
 
 
  protected:
 
    CepsLocalIndex
    pushBack(const _Type& x);  
  
    void
    registerHash(const CepsLocalIndex& localId, const _Hash& hashValue);
 
 
  protected:
 
    CepsVector<_Type>                       m_data         ; 
    CepsMap<_Hash,CepsLocalIndex>           m_hash         ; 
    CepsMap<CepsGlobalIndex,CepsLocalIndex> m_globalToLocal; 
    CepsMap<CepsLocalIndex,CepsGlobalIndex> m_localToGlobal; 
    CepsVector<CepsUInt>                    m_localSizes   ; 
    CepsBool                                m_synchronized ; 
 
};
 
// Template definitions
#include "common/containers/LocalGlobalMapping.tpp"