linear_index_iterator.h

Go to the documentation of this file.

// ------------------------------------------------------------------------
//
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2018 - 2023 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Part of the source code is dual licensed under Apache-2.0 WITH
// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
// governing the source code and code contributions can be found in
// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
//
// ------------------------------------------------------------------------
 
#ifndef dealii_linear_index_iterator_h
#define dealii_linear_index_iterator_h
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/exceptions.h>
 
 
DEAL_II_NAMESPACE_OPEN
template <typename DerivedIterator, typename AccessorType>
class LinearIndexIterator
{
public:
#ifdef DEAL_II_HAVE_CXX20
  using iterator_category = std::contiguous_iterator_tag;
#else
  using iterator_category = std::random_access_iterator_tag;
#endif
 
  using value_type = AccessorType;
 
  using difference_type = std::ptrdiff_t;
 
  using reference = const value_type &;
 
  using pointer = const value_type *;
 
  using size_type = typename value_type::size_type;
 
  DerivedIterator &
  operator=(const DerivedIterator &it);
 
  DerivedIterator &
  operator++();
 
  DerivedIterator
  operator++(int);
 
  DerivedIterator &
  operator--();
 
  DerivedIterator
  operator--(int);
 
  DerivedIterator
  operator+(const difference_type n) const;
 
  DerivedIterator
  operator-(const difference_type n) const;
 
  DerivedIterator &
  operator+=(const difference_type n);
 
  DerivedIterator &
  operator-=(const difference_type n);
 
  difference_type
  operator-(const DerivedIterator &p) const;
 
  reference
  operator*() const;
 
  pointer
  operator->() const;
 
  template <typename OtherIterator>
  std::enable_if_t<std::is_convertible_v<OtherIterator, DerivedIterator>, bool>
  operator==(const OtherIterator &right) const
  {
    const auto &right_2 = static_cast<const DerivedIterator &>(right);
    return this->accessor == right_2.accessor;
  }
 
  template <typename OtherIterator>
  std::enable_if_t<std::is_convertible_v<OtherIterator, DerivedIterator>, bool>
  operator!=(const OtherIterator &right) const
  {
    return !(*this == right);
  }
 
  bool
  operator<=(const DerivedIterator &) const;
 
  bool
  operator>=(const DerivedIterator &) const;
 
  bool
  operator<(const DerivedIterator &) const;
 
  bool
  operator>(const DerivedIterator &) const;
 
protected:
  /*
   * The inheriting class should have a default constructor.
   */
  LinearIndexIterator() = default; // NOLINT
 
  LinearIndexIterator(const AccessorType accessor);
 
protected:
  AccessorType accessor;
};
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline DerivedIterator &
LinearIndexIterator<DerivedIterator, AccessorType>::operator=(
  const DerivedIterator &it)
{
  accessor.container    = it.container;
  accessor.linear_index = it.linear_index;
  return static_cast<DerivedIterator &>(*this);
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline DerivedIterator &
LinearIndexIterator<DerivedIterator, AccessorType>::operator++()
{
  return operator+=(1);
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline DerivedIterator
LinearIndexIterator<DerivedIterator, AccessorType>::operator++(int)
{
  const DerivedIterator copy(this->accessor);
  operator+=(1);
  return copy;
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline DerivedIterator &
LinearIndexIterator<DerivedIterator, AccessorType>::operator--()
{
  return operator+=(-1);
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline DerivedIterator
LinearIndexIterator<DerivedIterator, AccessorType>::operator--(int)
{
  const DerivedIterator copy(this->accessor);
  operator+=(-1);
  return copy;
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline DerivedIterator
LinearIndexIterator<DerivedIterator, AccessorType>::operator+(
  const difference_type n) const
{
  DerivedIterator copy(this->accessor);
  copy += n;
  return copy;
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline DerivedIterator
LinearIndexIterator<DerivedIterator, AccessorType>::operator-(
  const difference_type n) const
{
  DerivedIterator copy(this->accessor);
  copy += -n;
  return copy;
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline DerivedIterator &
LinearIndexIterator<DerivedIterator, AccessorType>::operator+=(
  const difference_type n)
{
  accessor.linear_index += n;
  return static_cast<DerivedIterator &>(*this);
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline DerivedIterator &
LinearIndexIterator<DerivedIterator, AccessorType>::operator-=(
  const difference_type n)
{
  return operator+=(-n);
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline
  typename LinearIndexIterator<DerivedIterator, AccessorType>::difference_type
  LinearIndexIterator<DerivedIterator, AccessorType>::operator-(
    const DerivedIterator &other) const
{
  Assert(this->accessor.container == other.accessor.container,
         ExcMessage(
           "Only iterators pointing to the same container can be compared."));
  return this->accessor.linear_index - other.accessor.linear_index;
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline typename LinearIndexIterator<DerivedIterator, AccessorType>::reference
LinearIndexIterator<DerivedIterator, AccessorType>::operator*() const
{
  return accessor;
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline typename LinearIndexIterator<DerivedIterator, AccessorType>::pointer
LinearIndexIterator<DerivedIterator, AccessorType>::operator->() const
{
  return &accessor;
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline bool
LinearIndexIterator<DerivedIterator, AccessorType>::operator<=(
  const DerivedIterator &other) const
{
  return (*this == other) || (*this < other);
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline bool
LinearIndexIterator<DerivedIterator, AccessorType>::operator>=(
  const DerivedIterator &other) const
{
  return !(*this < other);
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline bool
LinearIndexIterator<DerivedIterator, AccessorType>::operator<(
  const DerivedIterator &other) const
{
  Assert(this->accessor.container == other.accessor.container,
         ExcMessage(
           "Only iterators pointing to the same container can be compared."));
  return this->accessor.linear_index < other.accessor.linear_index;
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline bool
LinearIndexIterator<DerivedIterator, AccessorType>::operator>(
  const DerivedIterator &other) const
{
  return other < static_cast<const DerivedIterator &>(*this);
}
 
 
 
template <typename DerivedIterator, typename AccessorType>
inline LinearIndexIterator<DerivedIterator, AccessorType>::LinearIndexIterator(
  const AccessorType accessor)
  : accessor(accessor)
{}
 
 
DEAL_II_NAMESPACE_CLOSE
 
#endif