localindex.hh

Go to the documentation of this file.

// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
// SPDX-FileCopyrightInfo: Copyright (C) DUNE Project contributors, see file LICENSE.md in module root
// SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
 
#ifndef DUNE_COMMON_LOCALINDEX_HH
#define DUNE_COMMON_LOCALINDEX_HH
 
#include <cstddef>
 
namespace Dune
{
 
 
  enum LocalIndexState {VALID, DELETED};
 
 
  class LocalIndex
  {
  public:
    LocalIndex() :
      localIndex_(0), state_(VALID){}
 
 
    LocalIndex(std::size_t index) :
      localIndex_(index), state_(VALID){}
    inline const std::size_t& local() const;
 
    inline operator std::size_t() const;
 
    inline LocalIndex& operator=(std::size_t index);
 
    inline LocalIndexState state() const;
 
    inline void setState(LocalIndexState state);
 
  private:
    std::size_t localIndex_;
 
    char state_;
 
  };
 
 
 
  inline const std::size_t& LocalIndex::local() const {
    return localIndex_;
  }
 
  inline LocalIndex::operator std::size_t() const {
    return localIndex_;
  }
 
  inline LocalIndex& LocalIndex::operator=(std::size_t index){
    localIndex_ = index;
    return *this;
  }
 
  inline LocalIndexState LocalIndex::state() const {
    return static_cast<LocalIndexState>(state_);
  }
 
  inline void LocalIndex::setState(LocalIndexState state){
    state_ = static_cast<char>(state);
  }
 
} // namespace Dune
 
#endif