peak_common_range.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <peak_common/exceptions/peak_common_exceptions.hpp>
#include <peak_common/types/peak_common_interval.hpp>
#include <peak_common_c/detail/peak_common_defines.h>
 
#include <type_traits>
 
namespace peak
{
namespace common
{
 
namespace detail
{

template <typename T>
class RangeT : public detail::IntervalT<T>
{
 
public:
    static_assert(std::is_arithmetic<T>::value, "Template argument of Interval must be arithmetic.");
 
    using type = T;

    constexpr RangeT(T minimum, T maximum, T increment)
        : detail::IntervalT<T>(minimum, maximum)
        , m_increment{ increment }
    {
        if (increment > maximum - minimum)
        {
            throw peak::common::InvalidParameterException("The given increment is larger than the total range!");
        }
    }

    PEAK_COMMON_NO_DISCARD constexpr T GetIncrement() const
    {
        return m_increment;
    }

    constexpr bool operator==(const RangeT& rhs) const
    {
        return detail::IntervalT<T>::operator==(rhs) && m_increment == rhs.m_increment;
    }

    constexpr bool operator!=(const RangeT& rhs) const
    {
        return !(rhs == *this);
    }
 
private:
    T m_increment;
};
 
} // namespace detail

using RangeU = detail::RangeT<uint32_t>;

using Range = detail::RangeT<int32_t>;

using RangeF = detail::RangeT<float>;

using RangeU8 = detail::RangeT<uint8_t>;
 
 
} // namespace common 
} // namespace peak