DiscreteRange.h

Go to the documentation of this file.

#pragma once

#include <cmath>
#include <limits>
#include <type_traits>

namespace CortidQCT {

template <class T> struct DiscreteRange {
  using value_type = T;

  value_type min;
  value_type max;
  value_type stride;

  inline constexpr DiscreteRange(value_type min_, value_type max_,
                                 value_type stride_) noexcept
      : min{min_}, max{max_}, stride{stride_} {}

  inline constexpr DiscreteRange(value_type min_, value_type max_) noexcept
      : min{min_}, max{max_}, stride{1} {
    static_assert(std::is_integral<value_type>::value,
                  "Default stride is only defined for integral types.");
  }

  inline constexpr std::size_t numElements() const noexcept {
    using std::floor;
    auto const length = max - min;
    return static_cast<std::size_t>(floor(length / stride)) + std::size_t{1};
  }

  inline constexpr value_type nThElement(std::size_t n) const noexcept {
    return min + (static_cast<value_type>(n) - value_type{1}) * stride;
  }
};

using DiscreteRangef = DiscreteRange<float>;
using DiscreteRanged = DiscreteRange<double>;

using DiescreteRangei = DiscreteRange<int>;

template <class T>
inline constexpr DiscreteRange<T> discreteRange(T min, T max,
                                                T stride) noexcept {
  return DiscreteRange<T>(min, max, stride);
}

template <class T>
inline constexpr DiscreteRange<T> discreteRange(T min, T max) noexcept {
  return DiscreteRange<T>(min, max);
}

} // namespace CortidQCT