Range.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * Range.h
 *
 ****/

#pragma once

#include <WString.h>
#include <esp_systemapi.h>

template <typename T> struct TRange {
    T min{};
    T max{};

    class Iterator
    {
    public:
        using value_type = T;
        using difference_type = std::ptrdiff_t;
        using pointer = T*;
        using reference = T&;
        using iterator_category = std::random_access_iterator_tag;

        Iterator(T value) : value(value)
        {
        }

        T operator*() const
        {
            return value;
        }

        bool operator==(const Iterator& other) const
        {
            return value == other.value;
        }

        bool operator!=(const Iterator& other) const
        {
            return !(*this == other);
        }

        Iterator operator++(int)
        {
            Iterator ret(value);
            ++*this;
            return ret;
        }

        Iterator& operator++()
        {
            ++value;
            return *this;
        }

    private:
        T value;
    };

    constexpr TRange()
    {
    }

    constexpr TRange(T min, T max) : min(min), max(max)
    {
    }

    constexpr TRange(T count) : min(0), max(count - 1)
    {
    }

    bool contains(T value) const
    {
        return (value >= min) && (value <= max);
    }

    T clip(T value) const
    {
        return (value < min) ? min : (value > max) ? max : value;
    }

    T random() const
    {
        auto n = 1 + max - min;
        if(n == 0) {
            return 0;
        }
        auto value = os_random();
        return min + value % n;
    }

    Iterator begin() const
    {
        return Iterator{min};
    }

    Iterator end() const
    {
        return Iterator{T(max + 1)};
    }

    String toString() const
    {
        String s;
        s += min;
        s += ", ";
        s += max;
        return s;
    }

    operator String() const
    {
        return toString();
    }
};

template <typename T> inline String toString(TRange<T> range)
{
    return range.toString();
}