Range.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2017 Julien Bernard
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */
#ifndef GF_RANGE_H
#define GF_RANGE_H

#include <cstddef>
#include <iterator>

#include "Portability.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  template<typename T>
  struct Range {
    T lo; 
    T hi; 

    struct Iterator : public std::iterator<std::input_iterator_tag, T> {
      T index; 

      constexpr Iterator(T iteratorIndex) noexcept
      : index(iteratorIndex)
      {

      }

      T operator*() noexcept {
        return index;
      }

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

      constexpr bool operator!=(const Iterator& other) const noexcept {
        return index != other.index;
      }

      constexpr bool operator==(const Iterator& other) const noexcept {
        return index == other.index;
      }
    };

    constexpr bool contains(T value) const noexcept {
      return lo <= value && value < hi;
    }

    constexpr Iterator begin() const noexcept {
      return Iterator(lo);
    }

    constexpr Iterator end() const noexcept {
      return Iterator(hi);
    }

    constexpr T length() const noexcept {
      return hi - lo;
    }

    constexpr bool isEmpty() const noexcept {
      return lo >= hi;
    }

    constexpr bool isValid() const noexcept {
      return lo <= hi;
    }

  };

  using RangeF = Range<float>;

  using RangeI = Range<int>;

  using RangeU = Range<unsigned>;

  using RangeZ = Range<std::size_t>;

// MSVC does not like extern template
#ifndef _MSC_VER
  extern template struct Range<float>;
  extern template struct Range<int>;
  extern template struct Range<unsigned>;
#endif

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_RANGE_H