diff --git a/.gitignore b/.gitignore index 5f5de3e..ea47eb3 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,14 @@ -tests/unittest-cpp \ No newline at end of file +tests/unittest-cpp +CMakeFiles +tests/CMakeFiles +tests/Debug +*.opensdf +*.sdf +tests/*tests.dir +*.vcxproj +*.vcxproj.filters +*.sln +*.tlog +Testing/Temporary/*.* +CMakeCache.txt +*.suo diff --git a/README.md b/README.md index c687673..5743bb3 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ The Guidelines Support Library (GSL) contains functions and types that are sugge [C++ Core Guidelines](https://github.com/isocpp/CppCoreGuidelines) maintained by the [Standard C++ Foundation](https://isocpp.org). This repo contains Microsoft's implementation of GSL. -The library includes types like `array_view<>`, `string_view<>`, `owner<>` and others. +The library includes types like `span`, `string_span`, `owner<>` and others. -The entire implementation is provided inline in the headers under the [include](./include) directory. +The entire implementation is provided inline in the headers under the [include](./include) directory. The implementation generally assumes a platform that implements C++14 support. There are specific workarounds to support MSVC 2013 and 2015. -While some types have been broken out into their own headers (e.g. [include/array_view.h](./include/array_view.h)), +While some types have been broken out into their own headers (e.g. [include/span.h](./include/span.h)), it is simplest to just include [gsl.h](./include/gsl.h) and gain access to the entire library. > NOTE: We encourage contributions that improve or refine any of the types in this library as well as ports to diff --git a/include/array_view.h b/include/array_view.h deleted file mode 100644 index 0145799..0000000 --- a/include/array_view.h +++ /dev/null @@ -1,1998 +0,0 @@ -/////////////////////////////////////////////////////////////////////////////// -// -// Copyright (c) 2015 Microsoft Corporation. All rights reserved. -// -// This code is licensed under the MIT License (MIT). -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -// THE SOFTWARE. -// -/////////////////////////////////////////////////////////////////////////////// - -#pragma once - -#ifndef GSL_ARRAY_VIEW_H -#define GSL_ARRAY_VIEW_H - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include "fail_fast.h" - -#ifdef _MSC_VER - -// No MSVC does constexpr fully yet -#pragma push_macro("constexpr") -#define constexpr /* nothing */ - - -// VS 2013 workarounds -#if _MSC_VER <= 1800 - -// noexcept is not understood -#ifndef GSL_THROWS_FOR_TESTING -#define noexcept /* nothing */ -#endif - -// turn off some misguided warnings -#pragma warning(push) -#pragma warning(disable: 4351) // warns about newly introduced aggregate initializer behavior - -#endif // _MSC_VER <= 1800 - -#endif // _MSC_VER - -// In order to test the library, we need it to throw exceptions that we can catch -#ifdef GSL_THROWS_FOR_TESTING -#define noexcept /* nothing */ -#endif // GSL_THROWS_FOR_TESTING - - -namespace gsl { - -/* -** begin definitions of index and bounds -*/ -namespace details -{ - template - struct SizeTypeTraits - { - static const SizeType max_value = std::numeric_limits::max(); - }; - - - template - class are_integral : public std::integral_constant {}; - - template - class are_integral : public std::integral_constant::value && are_integral::value> {}; -} - -template -class index final -{ - static_assert(std::is_integral::value, "ValueType must be an integral type!"); - static_assert(Rank > 0, "Rank must be greater than 0!"); - - template - friend class index; - -public: - static const size_t rank = Rank; - using value_type = std::remove_reference_t; - using reference = std::add_lvalue_reference_t; - using const_reference = std::add_lvalue_reference_t>; - - constexpr index() noexcept - {} - - constexpr index(const value_type(&values)[Rank]) noexcept - { - std::copy(values, values + Rank, elems); - } - - template::value, typename Dummy = std::enable_if_t> - constexpr index(Ts... ds) noexcept : elems{ static_cast(ds)... } - {} - - constexpr index(const index& other) noexcept = default; - - // copy from index over smaller domain - template ::max_value <= details::SizeTypeTraits::max_value), - typename Other = std::enable_if_t>> - constexpr index(const index& other) noexcept - { - std::copy(other.elems, other.elems + Rank, elems); - } - - // copy from index over larger domain - template ::max_value > details::SizeTypeTraits::max_value), - typename Other = std::enable_if_t>> - constexpr index(const index& other, void* ptr = 0) noexcept - { - bool ok = std::accumulate(other.elems, other.elems + Rank, true, - [&](bool b, OtherValueType val) { return b && (val <= static_cast(details::SizeTypeTraits::max_value)); } - ); - - fail_fast_assert(ok, "other value must fit in the new domain"); - std::transform(other.elems, other.elems + rank, elems, [&](OtherValueType val) { return static_cast(val); }); - } - - constexpr index& operator=(const index& rhs) noexcept = default; - - // Preconditions: component_idx < rank - constexpr reference operator[](size_t component_idx) - { - fail_fast_assert(component_idx < Rank, "Component index must be less than rank"); - return elems[component_idx]; - } - - // Preconditions: component_idx < rank - constexpr const_reference operator[](size_t component_idx) const noexcept - { - fail_fast_assert(component_idx < Rank, "Component index must be less than rank"); - return elems[component_idx]; - } - - constexpr bool operator==(const index& rhs) const noexcept - { - return std::equal(elems, elems + rank, rhs.elems); - } - - constexpr bool operator!=(const index& rhs) const noexcept - { - return !(this == rhs); - } - - constexpr index operator+() const noexcept - { - return *this; - } - - constexpr index operator-() const noexcept - { - index ret = *this; - std::transform(ret, ret + rank, ret, std::negate{}); - return ret; - } - - constexpr index operator+(const index& rhs) const noexcept - { - index ret = *this; - ret += rhs; - return ret; - } - - constexpr index operator-(const index& rhs) const noexcept - { - index ret = *this; - ret -= rhs; - return ret; - } - - constexpr index& operator+=(const index& rhs) noexcept - { - std::transform(elems, elems + rank, rhs.elems, elems, std::plus{}); - return *this; - } - - constexpr index& operator-=(const index& rhs) noexcept - { - std::transform(elems, elems + rank, rhs.elems, elems, std::minus{}); - return *this; - } - - constexpr index operator*(value_type v) const noexcept - { - index ret = *this; - ret *= v; - return ret; - } - - constexpr index operator/(value_type v) const noexcept - { - index ret = *this; - ret /= v; - return ret; - } - - friend constexpr index operator*(value_type v, const index& rhs) noexcept - { - return rhs * v; - } - - constexpr index& operator*=(value_type v) noexcept - { - std::transform(elems, elems + rank, elems, [v](value_type x) { return std::multiplies{}(x, v); }); - return *this; - } - - constexpr index& operator/=(value_type v) noexcept - { - std::transform(elems, elems + rank, elems, [v](value_type x) { return std::divides{}(x, v); }); - return *this; - } - -private: - value_type elems[Rank] = {}; -}; - -#ifndef _MSC_VER - -struct static_bounds_dynamic_range_t -{ - template ::value>> - constexpr operator T() const noexcept - { - return static_cast(-1); - } - - template ::value>> - constexpr bool operator ==(T other) const noexcept - { - return static_cast(-1) == other; - } - - template ::value>> - constexpr bool operator !=(T other) const noexcept - { - return static_cast(-1) != other; - } - -}; - -template ::value>> -constexpr bool operator ==(T left, static_bounds_dynamic_range_t right) noexcept -{ - return right == left; -} - -template ::value>> -constexpr bool operator !=(T left, static_bounds_dynamic_range_t right) noexcept -{ - return right != left; -} - -constexpr static_bounds_dynamic_range_t dynamic_range{}; -#else -const char dynamic_range = -1; -#endif - -struct generalized_mapping_tag {}; -struct contiguous_mapping_tag : generalized_mapping_tag {}; - -namespace details -{ - template - struct StaticSizeHelperImpl - { - static_assert(static_cast(Fact1) * static_cast(Fact2) <= SizeTypeTraits::max_value, "Value out of the range of SizeType"); - static const SizeType value = Fact1 * Fact2; - }; - - template - struct StaticSizeHelperImpl - { - static const SizeType value = ConstBound; - }; - - template - struct StaticSizeHelperImpl - { - static const SizeType value = ConstBound; - }; - - template - struct StaticSizeHelperImpl - { - static const SizeType value = static_cast(ConstBound); - }; - - template - struct StaticSizeHelper - { - static const SizeType value = StaticSizeHelperImpl(Fact1), static_cast(Fact2), static_cast(dynamic_range)>::value; - }; - - - template - struct LessThan - { - static const bool value = Left < Right; - }; - - template - struct BoundsRanges { - static const size_t Depth = 0; - static const size_t DynamicNum = 0; - static const SizeType CurrentRange = 1; - static const SizeType TotalSize = 1; - - BoundsRanges (const BoundsRanges &) = default; - - // TODO : following signature is for work around VS bug - template - BoundsRanges (const OtherType &, bool /* firstLevel */) {} - BoundsRanges(const SizeType * const) { } - BoundsRanges() = default; - - - template - void serialize(T &) const { - } - template - SizeType linearize(const T &) const { - return 0; - } - template - ptrdiff_t contains(const T &) const { - return 0; - } - - size_t totalSize() const noexcept { - return TotalSize; - } - - bool operator == (const BoundsRanges &) const noexcept - { - return true; - } - }; - - template - struct BoundsRanges : BoundsRanges{ - using Base = BoundsRanges ; - static const size_t Depth = Base::Depth + 1; - static const size_t DynamicNum = Base::DynamicNum + 1; - static const SizeType CurrentRange = dynamic_range; - static const SizeType TotalSize = dynamic_range; - const SizeType m_bound; - - BoundsRanges (const BoundsRanges &) = default; - BoundsRanges(const SizeType * const arr) : Base(arr + 1), m_bound(static_cast(*arr * this->Base::totalSize())) - { - fail_fast_assert(0 <= *arr); - fail_fast_assert(*arr * this->Base::totalSize() <= details::SizeTypeTraits::max_value); - } - BoundsRanges() : m_bound(0) {} - - template - BoundsRanges(const BoundsRanges &other, bool /* firstLevel */ = true) : - Base(static_cast&>(other), false), m_bound (static_cast(other.totalSize())) - { - } - - template - void serialize(T & arr) const { - arr[Dim] = elementNum(); - this->Base::template serialize(arr); - } - template - SizeType linearize(const T & arr) const { - const size_t index = this->Base::totalSize() * arr[Dim]; - fail_fast_assert(index < static_cast(m_bound)); - return static_cast(index) + this->Base::template linearize(arr); - } - - template - ptrdiff_t contains(const T & arr) const { - const ptrdiff_t last = this->Base::template contains(arr); - if (last == -1) - return -1; - const ptrdiff_t cur = this->Base::totalSize() * arr[Dim]; - return static_cast(cur) < static_cast(m_bound) ? cur + last : -1; - } - - size_t totalSize() const noexcept { - return m_bound; - } - - SizeType elementNum() const noexcept { - return static_cast(totalSize() / this->Base::totalSize()); - } - - SizeType elementNum(size_t dim) const noexcept{ - if (dim > 0) - return this->Base::elementNum(dim - 1); - else - return elementNum(); - } - - bool operator == (const BoundsRanges & rhs) const noexcept - { - return m_bound == rhs.m_bound && static_cast(*this) == static_cast(rhs); - } - }; - - template - struct BoundsRanges : BoundsRanges{ - using Base = BoundsRanges ; - static const size_t Depth = Base::Depth + 1; - static const size_t DynamicNum = Base::DynamicNum; - static const SizeType CurrentRange = static_cast(CurRange); - static const SizeType TotalSize = StaticSizeHelper::value; - static_assert (CurRange <= SizeTypeTraits::max_value, "CurRange must be smaller than SizeType limits"); - - BoundsRanges (const BoundsRanges &) = default; - BoundsRanges(const SizeType * const arr) : Base(arr) { } - BoundsRanges() = default; - - template - BoundsRanges(const BoundsRanges &other, bool firstLevel = true) : Base(static_cast&>(other), false) - { - fail_fast_assert((firstLevel && totalSize() <= other.totalSize()) || totalSize() == other.totalSize()); - } - - template - void serialize(T & arr) const { - arr[Dim] = elementNum(); - this->Base::template serialize(arr); - } - - template - SizeType linearize(const T & arr) const { - fail_fast_assert(arr[Dim] < CurrentRange, "Index is out of range"); - return static_cast(this->Base::totalSize()) * arr[Dim] + this->Base::template linearize(arr); - } - - template - ptrdiff_t contains(const T & arr) const { - if (static_cast(arr[Dim]) >= CurrentRange) - return -1; - const ptrdiff_t last = this->Base::template contains(arr); - if (last == -1) - return -1; - return static_cast(this->Base::totalSize() * arr[Dim]) + last; - } - - size_t totalSize() const noexcept{ - return CurrentRange * this->Base::totalSize(); - } - - SizeType elementNum() const noexcept{ - return CurrentRange; - } - - SizeType elementNum(size_t dim) const noexcept{ - if (dim > 0) - return this->Base::elementNum(dim - 1); - else - return elementNum(); - } - - bool operator == (const BoundsRanges & rhs) const noexcept - { - return static_cast(*this) == static_cast(rhs); - } - }; - - template - struct BoundsRangeConvertible2; - - // TODO: I have to rewrite BoundsRangeConvertible into following way to workaround VS 2013 bugs - template > - auto helpBoundsRangeConvertible(SourceType, TargetType, std::true_type) -> Ret; - - template - auto helpBoundsRangeConvertible(SourceType, TargetType, ...) -> std::false_type; - - template - struct BoundsRangeConvertible2 : decltype(helpBoundsRangeConvertible(SourceType(), TargetType(), - std::integral_constant())) - {}; - - template - struct BoundsRangeConvertible2 : std::true_type {}; - - template - struct BoundsRangeConvertible : decltype(helpBoundsRangeConvertible(SourceType(), TargetType(), - std::integral_constant::value || TargetType::CurrentRange == dynamic_range || SourceType::CurrentRange == dynamic_range)>())) - {}; - template - struct BoundsRangeConvertible : std::true_type {}; - - template - struct TypeListIndexer - { - const TypeChain & obj; - TypeListIndexer(const TypeChain & obj) :obj(obj){} - template - const TypeChain & getObj(std::true_type) - { - return obj; - } - template - auto getObj(std::false_type) -> decltype(TypeListIndexer(static_cast(obj)).template get()) - { - return TypeListIndexer(static_cast(obj)).template get(); - } - template - auto get() -> decltype(getObj(std::integral_constant())) - { - return getObj(std::integral_constant()); - } - }; - - template - TypeListIndexer createTypeListIndexer(const TypeChain &obj) - { - return TypeListIndexer(obj); - } - - template 1), typename Ret = std::enable_if_t>> - constexpr Ret shift_left(const index& other) noexcept - { - Ret ret; - for (size_t i = 0; i < Rank - 1; ++i) - { - ret[i] = other[i + 1]; - } - return ret; - } -} - -template -class bounds_iterator; - -template -class static_bounds { -public: - static_bounds(const details::BoundsRanges &) { - } -}; - -template -class static_bounds -{ - using MyRanges = details::BoundsRanges ; - static_assert(std::is_integral::value - && details::SizeTypeTraits::max_value <= SIZE_MAX, "SizeType must be an integral type and its numeric limits must be smaller than SIZE_MAX"); - - MyRanges m_ranges; - constexpr static_bounds(const MyRanges & range) : m_ranges(range) { } - - template - friend class static_bounds; -public: - static const size_t rank = MyRanges::Depth; - static const size_t dynamic_rank = MyRanges::DynamicNum; - static const SizeType static_size = static_cast(MyRanges::TotalSize); - - using size_type = SizeType; - using index_type = index; - using const_index_type = std::add_const_t; - using iterator = bounds_iterator; - using const_iterator = bounds_iterator; - using difference_type = ptrdiff_t; - using sliced_type = static_bounds; - using mapping_type = contiguous_mapping_tag; -public: - constexpr static_bounds(const static_bounds &) = default; - - template , details::BoundsRanges >::value>> - constexpr static_bounds(const static_bounds &other): - m_ranges(other.m_ranges) - { - } - - constexpr static_bounds(std::initializer_list il) : m_ranges(il.begin()) - { - fail_fast_assert(MyRanges::DynamicNum == il.size(), "Size of the initializer list must match the rank of the array"); - fail_fast_assert(m_ranges.totalSize() <= details::SizeTypeTraits::max_value, "Size of the range is larger than the max element of the size type"); - } - - constexpr static_bounds() = default; - - constexpr static_bounds & operator = (const static_bounds & otherBounds) - { - new(&m_ranges) MyRanges (otherBounds.m_ranges); - return *this; - } - - constexpr sliced_type slice() const noexcept - { - return sliced_type{static_cast &>(m_ranges)}; - } - - constexpr size_type stride() const noexcept - { - return rank > 1 ? slice().size() : 1; - } - - constexpr size_type size() const noexcept - { - return static_cast(m_ranges.totalSize()); - } - - constexpr size_type total_size() const noexcept - { - return static_cast(m_ranges.totalSize()); - } - - constexpr size_type linearize(const index_type & idx) const - { - return m_ranges.linearize(idx); - } - - constexpr bool contains(const index_type& idx) const noexcept - { - return m_ranges.contains(idx) != -1; - } - - constexpr size_type operator[](size_t index) const noexcept - { - return m_ranges.elementNum(index); - } - - template - constexpr size_type extent() const noexcept - { - static_assert(Dim < rank, "dimension should be less than rank (dimension count starts from 0)"); - return details::createTypeListIndexer(m_ranges).template get().elementNum(); - } - - constexpr index_type index_bounds() const noexcept - { - size_type extents[rank] = {}; - m_ranges.serialize(extents); - return{ extents }; - } - - template - constexpr bool operator == (const static_bounds & rhs) const noexcept - { - return this->size() == rhs.size(); - } - - template - constexpr bool operator != (const static_bounds & rhs) const noexcept - { - return !(*this == rhs); - } - - constexpr const_iterator begin() const noexcept - { - return const_iterator(*this, index_type{}); - } - - constexpr const_iterator end() const noexcept - { - return const_iterator(*this, this->index_bounds()); - } -}; - -template -class strided_bounds -{ - template - friend class strided_bounds; - -public: - static const size_t rank = Rank; - using reference = SizeType&; - using const_reference = const SizeType&; - using size_type = SizeType; - using difference_type = SizeType; - using value_type = SizeType; - using index_type = index; - using const_index_type = std::add_const_t; - using iterator = bounds_iterator; - using const_iterator = bounds_iterator; - static const int dynamic_rank = rank; - static const size_t static_size = dynamic_range; - using sliced_type = std::conditional_t, void>; - using mapping_type = generalized_mapping_tag; - constexpr strided_bounds(const strided_bounds &) noexcept = default; - - template - constexpr strided_bounds(const strided_bounds &other) noexcept - : m_extents(other.extents), m_strides(other.strides) - {} - constexpr strided_bounds(const index_type &extents, const index_type &strides) noexcept - : m_extents(extents), m_strides(strides) - {} - constexpr index_type strides() const noexcept - { - return m_strides; - } - constexpr size_type total_size() const noexcept - { - size_type ret = 0; - for (size_t i = 0; i < rank; ++i) - { - ret += (m_extents[i] - 1) * m_strides[i]; - } - return ret + 1; - } - constexpr size_type size() const noexcept - { - size_type ret = 1; - for (size_t i = 0; i < rank; ++i) - { - ret *= m_extents[i]; - } - return ret; - } - constexpr bool contains(const index_type& idx) const noexcept - { - for (size_t i = 0; i < rank; ++i) - { - if (idx[i] < 0 || idx[i] >= m_extents[i]) - return false; - } - return true; - } - constexpr size_type linearize(const index_type & idx) const noexcept - { - size_type ret = 0; - for (size_t i = 0; i < rank; i++) - { - fail_fast_assert(idx[i] < m_extents[i], "index is out of bounds of the array"); - ret += idx[i] * m_strides[i]; - } - return ret; - } - constexpr size_type stride() const noexcept - { - return m_strides[0]; - } - template 1), typename Ret = std::enable_if_t> - constexpr sliced_type slice() const - { - return{ details::shift_left(m_extents), details::shift_left(m_strides) }; - } - template - constexpr size_type extent() const noexcept - { - static_assert(Dim < Rank, "dimension should be less than rank (dimension count starts from 0)"); - return m_extents[Dim]; - } - constexpr index_type index_bounds() const noexcept - { - return m_extents; - } - constexpr const_iterator begin() const noexcept - { - return const_iterator{ *this, index_type{} }; - } - constexpr const_iterator end() const noexcept - { - return const_iterator{ *this, index_bounds() }; - } -private: - index_type m_extents; - index_type m_strides; -}; - -template -struct is_bounds : std::integral_constant {}; -template -struct is_bounds> : std::integral_constant {}; -template -struct is_bounds> : std::integral_constant {}; - -template -class bounds_iterator: public std::iterator -{ -private: - using Base = std::iterator ; - -public: - static const size_t rank = IndexType::rank; - using typename Base::reference; - using typename Base::pointer; - using typename Base::difference_type; - using typename Base::value_type; - using index_type = value_type; - using index_size_type = typename IndexType::value_type; - template - explicit bounds_iterator(const Bounds& bnd, value_type curr) noexcept - : boundary(bnd.index_bounds()), curr(std::move(curr)) - { - static_assert(is_bounds::value, "Bounds type must be provided"); - } - - constexpr reference operator*() const noexcept - { - return curr; - } - - constexpr pointer operator->() const noexcept - { - return &curr; - } - - constexpr bounds_iterator& operator++() noexcept - { - for (size_t i = rank; i-- > 0;) - { - if (curr[i] < boundary[i] - 1) - { - curr[i]++; - return *this; - } - curr[i] = 0; - } - // If we're here we've wrapped over - set to past-the-end. - curr = boundary; - return *this; - } - - constexpr bounds_iterator operator++(int) noexcept - { - auto ret = *this; - ++(*this); - return ret; - } - - constexpr bounds_iterator& operator--() noexcept - { - if (!less(curr, boundary)) - { - // if at the past-the-end, set to last element - for (size_t i = 0; i < rank; ++i) - { - curr[i] = boundary[i] - 1; - } - return *this; - } - for (size_t i = rank; i-- > 0;) - { - if (curr[i] >= 1) - { - curr[i]--; - return *this; - } - curr[i] = boundary[i] - 1; - } - // If we're here the preconditions were violated - // "pre: there exists s such that r == ++s" - fail_fast_assert(false); - return *this; - } - - constexpr bounds_iterator operator--(int) noexcept - { - auto ret = *this; - --(*this); - return ret; - } - - constexpr bounds_iterator operator+(difference_type n) const noexcept - { - bounds_iterator ret{ *this }; - return ret += n; - } - - constexpr bounds_iterator& operator+=(difference_type n) noexcept - { - auto linear_idx = linearize(curr) + n; - std::remove_const_t stride; - stride[rank - 1] = 1; - for (size_t i = rank - 1; i-- > 0;) - { - stride[i] = stride[i + 1] * boundary[i + 1]; - } - for (size_t i = 0; i < rank; ++i) - { - curr[i] = linear_idx / stride[i]; - linear_idx = linear_idx % stride[i]; - } - fail_fast_assert(!less(curr, index_type{}) && !less(boundary, curr), "index is out of bounds of the array"); - return *this; - } - - constexpr bounds_iterator operator-(difference_type n) const noexcept - { - bounds_iterator ret{ *this }; - return ret -= n; - } - - constexpr bounds_iterator& operator-=(difference_type n) noexcept - { - return *this += -n; - } - - constexpr difference_type operator-(const bounds_iterator& rhs) const noexcept - { - return linearize(curr) - linearize(rhs.curr); - } - - constexpr reference operator[](difference_type n) const noexcept - { - return *(*this + n); - } - - constexpr bool operator==(const bounds_iterator& rhs) const noexcept - { - return curr == rhs.curr; - } - - constexpr bool operator!=(const bounds_iterator& rhs) const noexcept - { - return !(*this == rhs); - } - - constexpr bool operator<(const bounds_iterator& rhs) const noexcept - { - return less(curr, rhs.curr); - } - - constexpr bool operator<=(const bounds_iterator& rhs) const noexcept - { - return !(rhs < *this); - } - - constexpr bool operator>(const bounds_iterator& rhs) const noexcept - { - return rhs < *this; - } - - constexpr bool operator>=(const bounds_iterator& rhs) const noexcept - { - return !(rhs > *this); - } - - void swap(bounds_iterator& rhs) noexcept - { - std::swap(boundary, rhs.boundary); - std::swap(curr, rhs.curr); - } -private: - constexpr bool less(index_type& one, index_type& other) const noexcept - { - for (size_t i = 0; i < rank; ++i) - { - if (one[i] < other[i]) - return true; - } - return false; - } - - constexpr index_size_type linearize(const value_type& idx) const noexcept - { - // TODO: Smarter impl. - // Check if past-the-end - index_size_type multiplier = 1; - index_size_type res = 0; - if (!less(idx, boundary)) - { - res = 1; - for (size_t i = rank; i-- > 0;) - { - res += (idx[i] - 1) * multiplier; - multiplier *= boundary[i]; - } - } - else - { - for (size_t i = rank; i-- > 0;) - { - res += idx[i] * multiplier; - multiplier *= boundary[i]; - } - } - return res; - } - - value_type boundary; - std::remove_const_t curr; -}; - -template -bounds_iterator operator+(typename bounds_iterator::difference_type n, const bounds_iterator& rhs) noexcept -{ - return rhs + n; -} - -/* -** begin definitions of basic_array_view -*/ -namespace details -{ - template - constexpr std::enable_if_t::value, typename Bounds::index_type> make_stride(const Bounds& bnd) noexcept - { - return bnd.strides(); - } - - // Make a stride vector from bounds, assuming contiguous memory. - template - constexpr std::enable_if_t::value, typename Bounds::index_type> make_stride(const Bounds& bnd) noexcept - { - auto extents = bnd.index_bounds(); - typename Bounds::size_type stride[Bounds::rank] = {}; - - stride[Bounds::rank - 1] = 1; - for (size_t i = 1; i < Bounds::rank; ++i) - { - stride[Bounds::rank - i - 1] = stride[Bounds::rank - i] * extents[Bounds::rank - i]; - } - return{ stride }; - } - - template - void verifyBoundsReshape(const BoundsSrc &src, const BoundsDest &dest) - { - static_assert(is_bounds::value && is_bounds::value, "The src type and dest type must be bounds"); - static_assert(std::is_same::value, "The source type must be a contiguous bounds"); - static_assert(BoundsDest::static_size == dynamic_range || BoundsSrc::static_size == dynamic_range || BoundsDest::static_size == BoundsSrc::static_size, "The source bounds must have same size as dest bounds"); - fail_fast_assert(src.size() == dest.size()); - } - - -} // namespace details - -template -class contiguous_array_view_iterator; -template -class general_array_view_iterator; -enum class byte : std::uint8_t {}; - -template -class basic_array_view -{ -public: - static const size_t rank = BoundsType::rank; - using bounds_type = BoundsType; - using size_type = typename bounds_type::size_type; - using index_type = typename bounds_type::index_type; - using value_type = ValueType; - using const_value_type = std::add_const_t; - using pointer = ValueType*; - using reference = ValueType&; - using iterator = std::conditional_t::value, contiguous_array_view_iterator, general_array_view_iterator>; - using const_iterator = std::conditional_t::value, contiguous_array_view_iterator>, general_array_view_iterator>>; - using reverse_iterator = std::reverse_iterator; - using const_reverse_iterator = std::reverse_iterator; - using sliced_type = std::conditional_t>; - -private: - pointer m_pdata; - bounds_type m_bounds; - -public: - constexpr bounds_type bounds() const noexcept - { - return m_bounds; - } - template - constexpr size_type extent() const noexcept - { - static_assert(Dim < rank, "dimension should be less than rank (dimension count starts from 0)"); - return m_bounds.template extent(); - } - constexpr size_type size() const noexcept - { - return m_bounds.size(); - } - constexpr reference operator[](const index_type& idx) const - { - return m_pdata[m_bounds.linearize(idx)]; - } - constexpr pointer data() const noexcept - { - return m_pdata; - } - template 1), typename Ret = std::enable_if_t> - constexpr Ret operator[](size_type idx) const - { - fail_fast_assert(idx < m_bounds.size(), "index is out of bounds of the array"); - const size_type ridx = idx * m_bounds.stride(); - - fail_fast_assert(ridx < m_bounds.total_size(), "index is out of bounds of the underlying data"); - return Ret {m_pdata + ridx, m_bounds.slice()}; - } - - constexpr operator bool () const noexcept - { - return m_pdata != nullptr; - } - - constexpr iterator begin() const - { - return iterator {this, true}; - } - constexpr iterator end() const - { - return iterator {this, false}; - } - constexpr const_iterator cbegin() const - { - return const_iterator {reinterpret_cast *>(this), true}; - } - constexpr const_iterator cend() const - { - return const_iterator {reinterpret_cast *>(this), false}; - } - - constexpr reverse_iterator rbegin() const - { - return reverse_iterator {end()}; - } - constexpr reverse_iterator rend() const - { - return reverse_iterator {begin()}; - } - constexpr const_reverse_iterator crbegin() const - { - return const_reverse_iterator {cend()}; - } - constexpr const_reverse_iterator crend() const - { - return const_reverse_iterator {cbegin()}; - } - - template , std::remove_cv_t>::value>> - constexpr bool operator== (const basic_array_view & other) const noexcept - { - return m_bounds.size() == other.m_bounds.size() && - (m_pdata == other.m_pdata || std::equal(this->begin(), this->end(), other.begin())); - } - - template , std::remove_cv_t>::value>> - constexpr bool operator!= (const basic_array_view & other) const noexcept - { - return !(*this == other); - } - - template , std::remove_cv_t>::value>> - constexpr bool operator< (const basic_array_view & other) const noexcept - { - return std::lexicographical_compare(this->begin(), this->end(), other.begin(), other.end()); - } - - template , std::remove_cv_t>::value>> - constexpr bool operator<= (const basic_array_view & other) const noexcept - { - return !(other < *this); - } - - template , std::remove_cv_t>::value>> - constexpr bool operator> (const basic_array_view & other) const noexcept - { - return (other < *this); - } - - template , std::remove_cv_t>::value>> - constexpr bool operator>= (const basic_array_view & other) const noexcept - { - return !(*this < other); - } - -public: - template ::value - && std::is_convertible::value>> - constexpr basic_array_view(const basic_array_view & other ) noexcept - : m_pdata(other.m_pdata), m_bounds(other.m_bounds) - { - } -protected: - - constexpr basic_array_view(pointer data, bounds_type bound) noexcept - : m_pdata(data) - , m_bounds(std::move(bound)) - { - fail_fast_assert((m_bounds.size() > 0 && data != nullptr) || m_bounds.size() == 0); - } - template - constexpr basic_array_view(T *data, std::enable_if_t>::value, bounds_type> bound) noexcept - : m_pdata(reinterpret_cast(data)) - , m_bounds(std::move(bound)) - { - fail_fast_assert((m_bounds.size() > 0 && data != nullptr) || m_bounds.size() == 0); - } - template - constexpr basic_array_view as_array_view(const DestBounds &bounds) - { - details::verifyBoundsReshape(m_bounds, bounds); - return {m_pdata, bounds}; - } -private: - - friend iterator; - friend const_iterator; - template - friend class basic_array_view; -}; - -template -struct dim -{ - static const size_t value = DimSize; -}; -template <> -struct dim -{ - static const size_t value = dynamic_range; - const size_t dvalue; - dim(size_t size) : dvalue(size) {} -}; - -template -class array_view; -template -class strided_array_view; - -namespace details -{ - template - struct ArrayViewTypeTraits - { - using value_type = T; - using size_type = size_t; - }; - - template - struct ArrayViewTypeTraits::type> - { - using value_type = typename Traits::array_view_traits::value_type; - using size_type = typename Traits::array_view_traits::size_type; - }; - - template - struct ArrayViewArrayTraits { - using type = array_view; - using value_type = T; - using bounds_type = static_bounds; - using pointer = T*; - using reference = T&; - }; - template - struct ArrayViewArrayTraits : ArrayViewArrayTraits {}; - - template - BoundsType newBoundsHelperImpl(size_t totalSize, std::true_type) // dynamic size - { - fail_fast_assert(totalSize <= details::SizeTypeTraits::max_value); - return BoundsType{static_cast(totalSize)}; - } - template - BoundsType newBoundsHelperImpl(size_t totalSize, std::false_type) // static size - { - fail_fast_assert(BoundsType::static_size == totalSize); - return {}; - } - template - BoundsType newBoundsHelper(size_t totalSize) - { - static_assert(BoundsType::dynamic_rank <= 1, "dynamic rank must less or equal to 1"); - return newBoundsHelperImpl(totalSize, std::integral_constant()); - } - - struct Sep{}; - - template - T static_as_array_view_helper(Sep, Args... args) - { - return T{static_cast(args)...}; - } - template - std::enable_if_t>::value && !std::is_same::value, T> static_as_array_view_helper(Arg, Args... args) - { - return static_as_array_view_helper(args...); - } - template - T static_as_array_view_helper(dim val, Args ... args) - { - return static_as_array_view_helper(args..., val.dvalue); - } - - template - struct static_as_array_view_static_bounds_helper - { - using type = static_bounds; - }; - - template - struct is_array_view_oracle : std::false_type - {}; - template - struct is_array_view_oracle> : std::true_type - {}; - template - struct is_array_view_oracle> : std::true_type - {}; - template - struct is_array_view : is_array_view_oracle> - {}; - -} - - -template -struct array_view_options -{ - struct array_view_traits - { - using value_type = ValueType; - using size_type = SizeType; - }; -}; - -template -class array_view : public basic_array_view::value_type, - static_bounds::size_type, FirstDimension, RestDimensions...>> -{ - template - friend class array_view; - using Base = basic_array_view::value_type, - static_bounds::size_type, FirstDimension, RestDimensions...>>; - -public: - using typename Base::bounds_type; - using typename Base::size_type; - using typename Base::pointer; - using typename Base::value_type; - using typename Base::index_type; - using typename Base::iterator; - using typename Base::const_iterator; - using typename Base::reference; - using Base::rank; - -public: - // basic - constexpr array_view(pointer ptr, bounds_type bounds) : Base(ptr, std::move(bounds)) - { - } - - constexpr array_view(std::nullptr_t) : Base(nullptr, bounds_type{}) - { - } - - constexpr array_view(std::nullptr_t, size_type size) : Base(nullptr, bounds_type{}) - { - fail_fast_assert(size == 0); - } - - // default - template > - constexpr array_view() : Base(nullptr, bounds_type()) - { - } - - // from n-dimensions dynamic array (e.g. new int[m][4]) (precedence will be lower than the 1-dimension pointer) - template , - typename Dummy = std::enable_if_t::value - && std::is_convertible::value>> - constexpr array_view(T * const & data, size_type size) : Base(data, typename Helper::bounds_type{size}) - { - } - - // from n-dimensions static array - template , - typename Dummy = std::enable_if_t::value - && std::is_convertible::value>> - constexpr array_view (T (&arr)[N]) : Base(arr, typename Helper::bounds_type()) - { - } - - // from n-dimensions static array with size - template , - typename Dummy = std::enable_if_t::value - && std::is_convertible::value >> - constexpr array_view(T(&arr)[N], size_type size) : Base(arr, typename Helper::bounds_type{ size }) - { - fail_fast_assert(size <= N); - } - - // from std array - template , typename Base::bounds_type>::value>> - constexpr array_view (std::array, N> & arr) : Base(arr.data(), static_bounds()) - { - } - - template , typename Base::bounds_type>::value && std::is_const::value>> - constexpr array_view (const std::array, N> & arr) : Base(arr.data(), static_bounds()) - { - } - - - // from begin, end pointers. We don't provide iterator pair since no way to guarantee the contiguity - template ::value - && details::LessThan::value>> // remove literal 0 case - constexpr array_view (pointer begin, Ptr end) : Base(begin, details::newBoundsHelper(static_cast(end) - begin)) - { - } - - // from containers. It must has .size() and .data() two function signatures - template ::value - && std::is_convertible::value - && std::is_convertible, typename Base::bounds_type>::value - && std::is_same().size(), *std::declval().data())>, DataType>::value> - > - constexpr array_view (Cont& cont) : Base(static_cast(cont.data()), details::newBoundsHelper(cont.size())) - { - - } - - constexpr array_view(const array_view &) = default; - - // convertible - template ::value_type, static_bounds::size_type, FirstDimension, RestDimensions...>>, - typename OtherBaseType = basic_array_view::value_type, static_bounds::size_type, OtherDimensions...>>, - typename Dummy = std::enable_if_t::value> - > - constexpr array_view(const array_view &av) : Base(static_cast::Base &>(av)) {} // static_cast is required - - // reshape - template - constexpr array_view as_array_view(Dimensions2... dims) - { - static_assert(sizeof...(Dimensions2) > 0, "the target array_view must have at least one dimension."); - using BoundsType = typename array_view::bounds_type; - auto tobounds = details::static_as_array_view_helper(dims..., details::Sep{}); - details::verifyBoundsReshape(this->bounds(), tobounds); - return {this->data(), tobounds}; - } - - // to bytes array - template ::value_type>>::value> - constexpr auto as_bytes() const noexcept -> - array_view, static_cast(details::StaticSizeHelper::value)> - { - static_assert(Enabled, "The value_type of array_view must be standarded layout"); - return { reinterpret_cast(this->data()), this->bytes() }; - } - - template ::value_type>>::value> - constexpr auto as_writeable_bytes() const noexcept -> - array_view, static_cast(details::StaticSizeHelper::value)> - { - static_assert(Enabled, "The value_type of array_view must be standarded layout"); - return { reinterpret_cast(this->data()), this->bytes() }; - } - - - // from bytes array - template::value, typename Dummy = std::enable_if_t> - constexpr auto as_array_view() const noexcept -> array_view(dynamic_range))> - { - static_assert(std::is_standard_layout::value && (Base::bounds_type::static_size == dynamic_range || Base::bounds_type::static_size % sizeof(U) == 0), - "Target type must be standard layout and its size must match the byte array size"); - fail_fast_assert((this->bytes() % sizeof(U)) == 0); - return { reinterpret_cast(this->data()), this->bytes() / sizeof(U) }; - } - - template::value, typename Dummy = std::enable_if_t> - constexpr auto as_array_view() const noexcept -> array_view(dynamic_range))> - { - static_assert(std::is_standard_layout::value && (Base::bounds_type::static_size == dynamic_range || Base::bounds_type::static_size % sizeof(U) == 0), - "Target type must be standard layout and its size must match the byte array size"); - fail_fast_assert((this->bytes() % sizeof(U)) == 0); - return { reinterpret_cast(this->data()), this->bytes() / sizeof(U) }; - } - - // section on linear space - template - constexpr array_view first() const noexcept - { - static_assert(bounds_type::static_size == dynamic_range || Count <= bounds_type::static_size, "Index is out of bound"); - fail_fast_assert(bounds_type::static_size != dynamic_range || Count <= this->size()); // ensures we only check condition when needed - return { this->data(), Count }; - } - - constexpr array_view first(size_type count) const noexcept - { - fail_fast_assert(count <= this->size()); - return { this->data(), count }; - } - - template - constexpr array_view last() const noexcept - { - static_assert(bounds_type::static_size == dynamic_range || Count <= bounds_type::static_size, "Index is out of bound"); - fail_fast_assert(bounds_type::static_size != dynamic_range || Count <= this->size()); - return { this->data() + this->size() - Count, Count }; - } - - constexpr array_view last(size_type count) const noexcept - { - fail_fast_assert(count <= this->size()); - return { this->data() + this->size() - count, count }; - } - - template - constexpr array_view sub() const noexcept - { - static_assert(bounds_type::static_size == dynamic_range || ((Offset == 0 || Offset <= bounds_type::static_size) && Offset + Count <= bounds_type::static_size), "Index is out of bound"); - fail_fast_assert(bounds_type::static_size != dynamic_range || ((Offset == 0 || Offset <= this->size()) && Offset + Count <= this->size())); - return { this->data() + Offset, Count }; - } - - constexpr array_view sub(size_type offset, size_type count = dynamic_range) const noexcept - { - fail_fast_assert((offset == 0 || offset <= this->size()) && (count == dynamic_range || (offset + count) <= this->size())); - return { this->data() + offset, count == dynamic_range ? this->length() - offset : count }; - } - - // size - constexpr size_type length() const noexcept - { - return this->size(); - } - constexpr size_type used_length() const noexcept - { - return length(); - } - constexpr size_type bytes() const noexcept - { - return sizeof(value_type) * this->size(); - } - constexpr size_type used_bytes() const noexcept - { - return bytes(); - } - - // section - constexpr strided_array_view section(index_type origin, index_type extents) const - { - size_type size = this->bounds().total_size() - this->bounds().linearize(origin); - return{ &this->operator[](origin), size, strided_bounds {extents, details::make_stride(Base::bounds())} }; - } - - constexpr reference operator[](const index_type& idx) const - { - return Base::operator[](idx); - } - - template 1), typename Dummy = std::enable_if_t> - constexpr array_view operator[](size_type idx) const - { - auto ret = Base::operator[](idx); - return{ ret.data(), ret.bounds() }; - } - - using Base::operator==; - using Base::operator!=; - using Base::operator<; - using Base::operator<=; - using Base::operator>; - using Base::operator>=; -}; - -template -constexpr auto as_array_view(T * const & ptr, dim... args) -> array_view, Dimensions...> -{ - return {reinterpret_cast*>(ptr), details::static_as_array_view_helper>(args..., details::Sep{})}; -} - -template -constexpr auto as_array_view (T * arr, size_t len) -> typename details::ArrayViewArrayTraits::type -{ - return {arr, len}; -} - -template -constexpr auto as_array_view (T (&arr)[N]) -> typename details::ArrayViewArrayTraits::type -{ - return {arr}; -} - -template -constexpr array_view as_array_view(const std::array &arr) -{ - return {arr}; -} - -template -constexpr array_view as_array_view(const std::array &&) = delete; - -template -constexpr array_view as_array_view(std::array &arr) -{ - return {arr}; -} - -template -constexpr array_view as_array_view(T *begin, T *end) -{ - return {begin, end}; -} - -template -constexpr auto as_array_view(Cont &arr) -> std::enable_if_t>::value, - array_view, dynamic_range>> -{ - return {arr.data(), arr.size()}; -} - -template -constexpr auto as_array_view(Cont &&arr) -> std::enable_if_t>::value, - array_view, dynamic_range>> = delete; - -template -class strided_array_view : public basic_array_view::value_type, strided_bounds::size_type>> -{ - using Base = basic_array_view::value_type, strided_bounds::size_type>>; - - template - friend class strided_array_view; -public: - using Base::rank; - using typename Base::bounds_type; - using typename Base::size_type; - using typename Base::pointer; - using typename Base::value_type; - using typename Base::index_type; - using typename Base::iterator; - using typename Base::const_iterator; - using typename Base::reference; - - // from static array of size N - template - strided_array_view(value_type(&values)[N], bounds_type bounds) : Base(values, std::move(bounds)) - { - fail_fast_assert(this->bounds().total_size() <= N, "Bounds cross data boundaries"); - } - - // from raw data - strided_array_view(pointer ptr, size_type size, bounds_type bounds): Base(ptr, std::move(bounds)) - { - fail_fast_assert(this->bounds().total_size() <= size, "Bounds cross data boundaries"); - } - - // from array view - template > - strided_array_view(array_view av, bounds_type bounds) : Base(av.data(), std::move(bounds)) - { - fail_fast_assert(this->bounds().total_size() <= av.bounds().total_size(), "Bounds cross data boundaries"); - } - - // convertible - template ::value_type, strided_bounds::size_type>>, - typename OtherBaseType = basic_array_view::value_type, strided_bounds::size_type>>, - typename Dummy = std::enable_if_t::value> - > - constexpr strided_array_view(const strided_array_view &av): Base(static_cast::Base &>(av)) // static_cast is required - { - } - - // convert from bytes - template - strided_array_view::value, OtherValueType>::type, rank> as_strided_array_view() const - { - static_assert((sizeof(OtherValueType) >= sizeof(value_type)) && (sizeof(OtherValueType) % sizeof(value_type) == 0), "OtherValueType should have a size to contain a multiple of ValueTypes"); - auto d = sizeof(OtherValueType) / sizeof(value_type); - - size_type size = this->bounds().total_size() / d; - return{ (OtherValueType*)this->data(), size, bounds_type{ resize_extent(this->bounds().index_bounds(), d), resize_stride(this->bounds().strides(), d)} }; - } - - strided_array_view section(index_type origin, index_type extents) const - { - size_type size = this->bounds().total_size() - this->bounds().linearize(origin); - return { &this->operator[](origin), size, bounds_type {extents, details::make_stride(Base::bounds())}}; - } - - constexpr reference operator[](const index_type& idx) const - { - return Base::operator[](idx); - } - - template 1), typename Dummy = std::enable_if_t> - constexpr strided_array_view operator[](size_type idx) const - { - auto ret = Base::operator[](idx); - return{ ret.data(), ret.bounds().total_size(), ret.bounds() }; - } - -private: - static index_type resize_extent(const index_type& extent, size_t d) - { - fail_fast_assert(extent[rank - 1] >= d && (extent[rank-1] % d == 0), "The last dimension of the array needs to contain a multiple of new type elements"); - - index_type ret = extent; - ret[rank - 1] /= d; - - return ret; - } - - template > - static index_type resize_stride(const index_type& strides, size_t , void * = 0) - { - fail_fast_assert(strides[rank - 1] == 1, "Only strided arrays with regular strides can be resized"); - - return strides; - } - - template 1), typename Dummy = std::enable_if_t> - static index_type resize_stride(const index_type& strides, size_t d) - { - fail_fast_assert(strides[rank - 1] == 1, "Only strided arrays with regular strides can be resized"); - fail_fast_assert(strides[rank - 2] >= d && (strides[rank - 2] % d == 0), "The strides must have contiguous chunks of memory that can contain a multiple of new type elements"); - - for (size_t i = rank - 1; i > 0; --i) - fail_fast_assert((strides[i-1] >= strides[i]) && (strides[i-1] % strides[i] == 0), "Only strided arrays with regular strides can be resized"); - - index_type ret = strides / d; - ret[rank - 1] = 1; - - return ret; - } -}; - -template -class contiguous_array_view_iterator : public std::iterator -{ - using Base = std::iterator; -public: - using typename Base::reference; - using typename Base::pointer; - using typename Base::difference_type; -private: - template - friend class basic_array_view; - pointer m_pdata; - const ArrayView * m_validator; - void validateThis() const - { - fail_fast_assert(m_pdata >= m_validator->m_pdata && m_pdata < m_validator->m_pdata + m_validator->size(), "iterator is out of range of the array"); - } - contiguous_array_view_iterator (const ArrayView *container, bool isbegin) : - m_pdata(isbegin ? container->m_pdata : container->m_pdata + container->size()), m_validator(container) {} -public: - reference operator*() const noexcept - { - validateThis(); - return *m_pdata; - } - pointer operator->() const noexcept - { - validateThis(); - return m_pdata; - } - contiguous_array_view_iterator& operator++() noexcept - { - ++m_pdata; - return *this; - } - contiguous_array_view_iterator operator++(int)noexcept - { - auto ret = *this; - ++(*this); - return ret; - } - contiguous_array_view_iterator& operator--() noexcept - { - --m_pdata; - return *this; - } - contiguous_array_view_iterator operator--(int)noexcept - { - auto ret = *this; - --(*this); - return ret; - } - contiguous_array_view_iterator operator+(difference_type n) const noexcept - { - contiguous_array_view_iterator ret{ *this }; - return ret += n; - } - contiguous_array_view_iterator& operator+=(difference_type n) noexcept - { - m_pdata += n; - return *this; - } - contiguous_array_view_iterator operator-(difference_type n) const noexcept - { - contiguous_array_view_iterator ret{ *this }; - return ret -= n; - } - contiguous_array_view_iterator& operator-=(difference_type n) noexcept - { - return *this += -n; - } - difference_type operator-(const contiguous_array_view_iterator& rhs) const noexcept - { - fail_fast_assert(m_validator == rhs.m_validator); - return m_pdata - rhs.m_pdata; - } - reference operator[](difference_type n) const noexcept - { - return *(*this + n); - } - bool operator==(const contiguous_array_view_iterator& rhs) const noexcept - { - fail_fast_assert(m_validator == rhs.m_validator); - return m_pdata == rhs.m_pdata; - } - bool operator!=(const contiguous_array_view_iterator& rhs) const noexcept - { - return !(*this == rhs); - } - bool operator<(const contiguous_array_view_iterator& rhs) const noexcept - { - fail_fast_assert(m_validator == rhs.m_validator); - return m_pdata < rhs.m_pdata; - } - bool operator<=(const contiguous_array_view_iterator& rhs) const noexcept - { - return !(rhs < *this); - } - bool operator>(const contiguous_array_view_iterator& rhs) const noexcept - { - return rhs < *this; - } - bool operator>=(const contiguous_array_view_iterator& rhs) const noexcept - { - return !(rhs > *this); - } - void swap(contiguous_array_view_iterator& rhs) noexcept - { - std::swap(m_pdata, rhs.m_pdata); - std::swap(m_validator, rhs.m_validator); - } -}; - -template -contiguous_array_view_iterator operator+(typename contiguous_array_view_iterator::difference_type n, const contiguous_array_view_iterator& rhs) noexcept -{ - return rhs + n; -} - -template -class general_array_view_iterator : public std::iterator -{ - using Base = std::iterator; -public: - using typename Base::reference; - using typename Base::pointer; - using typename Base::difference_type; - using typename Base::value_type; -private: - template - friend class basic_array_view; - const ArrayView * m_container; - typename ArrayView::bounds_type::iterator m_itr; - general_array_view_iterator(const ArrayView *container, bool isbegin) : - m_container(container), m_itr(isbegin ? m_container->bounds().begin() : m_container->bounds().end()) - { - } -public: - reference operator*() noexcept - { - return (*m_container)[*m_itr]; - } - pointer operator->() noexcept - { - return &(*m_container)[*m_itr]; - } - general_array_view_iterator& operator++() noexcept - { - ++m_itr; - return *this; - } - general_array_view_iterator operator++(int)noexcept - { - auto ret = *this; - ++(*this); - return ret; - } - general_array_view_iterator& operator--() noexcept - { - --m_itr; - return *this; - } - general_array_view_iterator operator--(int)noexcept - { - auto ret = *this; - --(*this); - return ret; - } - general_array_view_iterator operator+(difference_type n) const noexcept - { - general_array_view_iterator ret{ *this }; - return ret += n; - } - general_array_view_iterator& operator+=(difference_type n) noexcept - { - m_itr += n; - return *this; - } - general_array_view_iterator operator-(difference_type n) const noexcept - { - general_array_view_iterator ret{ *this }; - return ret -= n; - } - general_array_view_iterator& operator-=(difference_type n) noexcept - { - return *this += -n; - } - difference_type operator-(const general_array_view_iterator& rhs) const noexcept - { - fail_fast_assert(m_container == rhs.m_container); - return m_itr - rhs.m_itr; - } - value_type operator[](difference_type n) const noexcept - { - return (*m_container)[m_itr[n]];; - } - bool operator==(const general_array_view_iterator& rhs) const noexcept - { - fail_fast_assert(m_container == rhs.m_container); - return m_itr == rhs.m_itr; - } - bool operator !=(const general_array_view_iterator& rhs) const noexcept - { - return !(*this == rhs); - } - bool operator<(const general_array_view_iterator& rhs) const noexcept - { - fail_fast_assert(m_container == rhs.m_container); - return m_itr < rhs.m_itr; - } - bool operator<=(const general_array_view_iterator& rhs) const noexcept - { - return !(rhs < *this); - } - bool operator>(const general_array_view_iterator& rhs) const noexcept - { - return rhs < *this; - } - bool operator>=(const general_array_view_iterator& rhs) const noexcept - { - return !(rhs > *this); - } - void swap(general_array_view_iterator& rhs) noexcept - { - std::swap(m_itr, rhs.m_itr); - std::swap(m_container, rhs.m_container); - } -}; - -template -general_array_view_iterator operator+(typename general_array_view_iterator::difference_type n, const general_array_view_iterator& rhs) noexcept -{ - return rhs + n; -} - -} // namespace gsl - -#ifdef _MSC_VER - -#undef constexpr -#pragma pop_macro("constexpr") - -#if _MSC_VER <= 1800 -#pragma warning(pop) - -#ifndef GSL_THROWS_FOR_TESTING -#pragma undef noexcept -#endif // GSL_THROWS_FOR_TESTING - -#endif // _MSC_VER <= 1800 - -#endif // _MSC_VER - -#if defined(GSL_THROWS_FOR_TESTING) -#undef noexcept -#endif // GSL_THROWS_FOR_TESTING - - -#endif // GSL_ARRAY_VIEW_H diff --git a/include/gsl.h b/include/gsl.h index ec75723..e20ac69 100644 --- a/include/gsl.h +++ b/include/gsl.h @@ -19,8 +19,8 @@ #ifndef GSL_GSL_H #define GSL_GSL_H -#include "array_view.h" // array_view, strided_array_view... -#include "string_view.h" // zstring, string_view, zstring_builder... +#include "span.h" // span, strided_span... +#include "string_span.h" // zstring, string_span, zstring_builder... #include #ifdef _MSC_VER diff --git a/include/span.h b/include/span.h new file mode 100644 index 0000000..f4a57d9 --- /dev/null +++ b/include/span.h @@ -0,0 +1,1992 @@ +/////////////////////////////////////////////////////////////////////////////// +// +// Copyright (c) 2015 Microsoft Corporation. All rights reserved. +// +// This code is licensed under the MIT License (MIT). +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +// THE SOFTWARE. +// +/////////////////////////////////////////////////////////////////////////////// + +#pragma once + +#ifndef GSL_SPAN_H +#define GSL_SPAN_H + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "fail_fast.h" + +#ifdef _MSC_VER + +// No MSVC does constexpr fully yet +#pragma push_macro("constexpr") +#define constexpr /* nothing */ + + +// VS 2013 workarounds +#if _MSC_VER <= 1800 + +#pragma push_macro("GSL_MSVC_HAS_VARIADIC_CTOR_BUG") +#define GSL_MSVC_HAS_VARIADIC_CTOR_BUG + + +// noexcept is not understood +#ifndef GSL_THROWS_FOR_TESTING +#define noexcept /* nothing */ +#endif + +// turn off some misguided warnings +#pragma warning(push) +#pragma warning(disable: 4351) // warns about newly introduced aggregate initializer behavior +#pragma warning(disable: 4512) // warns that assignment op could not be generated + +#endif // _MSC_VER <= 1800 + +#endif // _MSC_VER + +// In order to test the library, we need it to throw exceptions that we can catch +#ifdef GSL_THROWS_FOR_TESTING +#define noexcept /* nothing */ +#endif // GSL_THROWS_FOR_TESTING + + +namespace gsl { + +/* +** begin definitions of index and bounds +*/ +namespace details +{ + template + struct SizeTypeTraits + { + static const SizeType max_value = std::numeric_limits::max(); + }; + + + template + class are_integral : public std::integral_constant {}; + + template + class are_integral : public std::integral_constant::value && are_integral::value> {}; +} + +template +class index final +{ + static_assert(Rank > 0, "Rank must be greater than 0!"); + + template + friend class index; + +public: + static const size_t rank = Rank; + using value_type = std::ptrdiff_t; + using size_type = value_type; + using reference = std::add_lvalue_reference_t; + using const_reference = std::add_lvalue_reference_t>; + + constexpr index() noexcept + {} + + constexpr index(const value_type(&values)[Rank]) noexcept + { + std::copy(values, values + Rank, elems); + } + +#ifdef GSL_MSVC_HAS_VARIADIC_CTOR_BUG + template::value && + details::are_integral::value>> + constexpr index(T t, Ts... ds) : index({ static_cast(t), static_cast(ds)... }) + {} +#else + template::value>> + constexpr index(Ts... ds) noexcept : elems{ static_cast(ds)... } + {} +#endif + + constexpr index(const index& other) noexcept = default; + + constexpr index& operator=(const index& rhs) noexcept = default; + + // Preconditions: component_idx < rank + constexpr reference operator[](size_t component_idx) + { + fail_fast_assert(component_idx < Rank, "Component index must be less than rank"); + return elems[component_idx]; + } + + // Preconditions: component_idx < rank + constexpr const_reference operator[](size_t component_idx) const noexcept + { + fail_fast_assert(component_idx < Rank, "Component index must be less than rank"); + return elems[component_idx]; + } + + constexpr bool operator==(const index& rhs) const noexcept + { + return std::equal(elems, elems + rank, rhs.elems); + } + + constexpr bool operator!=(const index& rhs) const noexcept + { + return !(this == rhs); + } + + constexpr index operator+() const noexcept + { + return *this; + } + + constexpr index operator-() const noexcept + { + index ret = *this; + std::transform(ret, ret + rank, ret, std::negate{}); + return ret; + } + + constexpr index operator+(const index& rhs) const noexcept + { + index ret = *this; + ret += rhs; + return ret; + } + + constexpr index operator-(const index& rhs) const noexcept + { + index ret = *this; + ret -= rhs; + return ret; + } + + constexpr index& operator+=(const index& rhs) noexcept + { + std::transform(elems, elems + rank, rhs.elems, elems, std::plus{}); + return *this; + } + + constexpr index& operator-=(const index& rhs) noexcept + { + std::transform(elems, elems + rank, rhs.elems, elems, std::minus{}); + return *this; + } + + constexpr index operator*(value_type v) const noexcept + { + index ret = *this; + ret *= v; + return ret; + } + + constexpr index operator/(value_type v) const noexcept + { + index ret = *this; + ret /= v; + return ret; + } + + friend constexpr index operator*(value_type v, const index& rhs) noexcept + { + return rhs * v; + } + + constexpr index& operator*=(value_type v) noexcept + { + std::transform(elems, elems + rank, elems, [v](value_type x) { return std::multiplies{}(x, v); }); + return *this; + } + + constexpr index& operator/=(value_type v) noexcept + { + std::transform(elems, elems + rank, elems, [v](value_type x) { return std::divides{}(x, v); }); + return *this; + } + +private: + value_type elems[Rank] = {}; +}; + +#ifndef _MSC_VER + +struct static_bounds_dynamic_range_t +{ + template ::value>> + constexpr operator T() const noexcept + { + return static_cast(-1); + } + + template ::value>> + constexpr bool operator ==(T other) const noexcept + { + return static_cast(-1) == other; + } + + template ::value>> + constexpr bool operator !=(T other) const noexcept + { + return static_cast(-1) != other; + } + +}; + +template ::value>> +constexpr bool operator ==(T left, static_bounds_dynamic_range_t right) noexcept +{ + return right == left; +} + +template ::value>> +constexpr bool operator !=(T left, static_bounds_dynamic_range_t right) noexcept +{ + return right != left; +} + +constexpr static_bounds_dynamic_range_t dynamic_range{}; +#else +const std::ptrdiff_t dynamic_range = -1; +#endif + +struct generalized_mapping_tag {}; +struct contiguous_mapping_tag : generalized_mapping_tag {}; + +namespace details +{ + + template + struct LessThan + { + static const bool value = Left < Right; + }; + + template + struct BoundsRanges { + using size_type = std::ptrdiff_t; + static const size_type Depth = 0; + static const size_type DynamicNum = 0; + static const size_type CurrentRange = 1; + static const size_type TotalSize = 1; + + // TODO : following signature is for work around VS bug + template + BoundsRanges(const OtherRange&, bool /* firstLevel */) + {} + + BoundsRanges (const BoundsRanges&) = default; + BoundsRanges& operator=(const BoundsRanges&) = default; + BoundsRanges(const std::ptrdiff_t* const) { } + BoundsRanges() = default; + + + template + void serialize(T&) const + {} + + template + size_type linearize(const T&) const + { + return 0; + } + + template + bool contains(const T&) const + { + return 0; + } + + size_type totalSize() const noexcept + { + return TotalSize; + } + + bool operator==(const BoundsRanges&) const noexcept + { + return true; + } + }; + + template + struct BoundsRanges : BoundsRanges{ + using Base = BoundsRanges ; + using size_type = std::ptrdiff_t; + static const size_t Depth = Base::Depth + 1; + static const size_t DynamicNum = Base::DynamicNum + 1; + static const size_type CurrentRange = dynamic_range; + static const size_type TotalSize = dynamic_range; + const size_type m_bound; + + BoundsRanges (const BoundsRanges&) = default; + + BoundsRanges(const std::ptrdiff_t* const arr) : Base(arr + 1), m_bound(*arr * this->Base::totalSize()) + { + fail_fast_assert(0 <= *arr); + } + + BoundsRanges() : m_bound(0) {} + + template + BoundsRanges(const BoundsRanges& other, bool /* firstLevel */ = true) : + Base(static_cast&>(other), false), m_bound(other.totalSize()) + {} + + template + void serialize(T& arr) const + { + arr[Dim] = elementNum(); + this->Base::template serialize(arr); + } + + template + size_type linearize(const T& arr) const + { + const size_type index = this->Base::totalSize() * arr[Dim]; + fail_fast_assert(index < m_bound); + return index + this->Base::template linearize(arr); + } + + template + size_type contains(const T & arr) const + { + const ptrdiff_t last = this->Base::template contains(arr); + if (last == -1) + return -1; + const ptrdiff_t cur = this->Base::totalSize() * arr[Dim]; + return cur < m_bound ? cur + last : -1; + } + + size_type totalSize() const noexcept + { + return m_bound; + } + + size_type elementNum() const noexcept + { + return totalSize() / this->Base::totalSize(); + } + + size_type elementNum(size_t dim) const noexcept + { + if (dim > 0) + return this->Base::elementNum(dim - 1); + else + return elementNum(); + } + + bool operator == (const BoundsRanges & rhs) const noexcept + { + return m_bound == rhs.m_bound && static_cast(*this) == static_cast(rhs); + } + }; + + template + struct BoundsRanges : BoundsRanges + { + using Base = BoundsRanges ; + using size_type = std::ptrdiff_t; + static const size_t Depth = Base::Depth + 1; + static const size_t DynamicNum = Base::DynamicNum; + static const size_type CurrentRange = CurRange; + static const size_type TotalSize = Base::TotalSize == dynamic_range ? dynamic_range : CurrentRange * Base::TotalSize; + + BoundsRanges (const BoundsRanges&) = default; + BoundsRanges(const std::ptrdiff_t* const arr) : Base(arr) { } + BoundsRanges() = default; + + template + BoundsRanges(const BoundsRanges&other, bool firstLevel = true) : Base(static_cast&>(other), false) + { + fail_fast_assert((firstLevel && totalSize() <= other.totalSize()) || totalSize() == other.totalSize()); + } + + template + void serialize(T& arr) const + { + arr[Dim] = elementNum(); + this->Base::template serialize(arr); + } + + template + size_type linearize(const T& arr) const + { + fail_fast_assert(arr[Dim] < CurrentRange, "Index is out of range"); + return this->Base::totalSize() * arr[Dim] + this->Base::template linearize(arr); + } + + template + size_type contains(const T& arr) const + { + if (arr[Dim] >= CurrentRange) + return -1; + const size_type last = this->Base::template contains(arr); + if (last == -1) + return -1; + return this->Base::totalSize() * arr[Dim] + last; + } + + size_type totalSize() const noexcept + { + return CurrentRange * this->Base::totalSize(); + } + + size_type elementNum() const noexcept + { + return CurrentRange; + } + + size_type elementNum(size_t dim) const noexcept + { + if (dim > 0) + return this->Base::elementNum(dim - 1); + else + return elementNum(); + } + + bool operator== (const BoundsRanges& rhs) const noexcept + { + return static_cast(*this) == static_cast(rhs); + } + }; + + template + struct BoundsRangeConvertible2; + + template > + auto helpBoundsRangeConvertible(SourceType, TargetType, std::true_type) -> Ret; + + template + auto helpBoundsRangeConvertible(SourceType, TargetType, ...) -> std::false_type; + + template + struct BoundsRangeConvertible2 : decltype(helpBoundsRangeConvertible(SourceType(), TargetType(), + std::integral_constant())) + {}; + + template + struct BoundsRangeConvertible2 : std::true_type {}; + + template + struct BoundsRangeConvertible : decltype(helpBoundsRangeConvertible(SourceType(), TargetType(), + std::integral_constant::value || TargetType::CurrentRange == dynamic_range || SourceType::CurrentRange == dynamic_range)>())) + {}; + template + struct BoundsRangeConvertible : std::true_type {}; + + template + struct TypeListIndexer + { + const TypeChain & obj; + TypeListIndexer(const TypeChain & obj) :obj(obj){} + template + const TypeChain & getObj(std::true_type) + { + return obj; + } + template + auto getObj(std::false_type) -> decltype(TypeListIndexer(static_cast(obj)).template get()) + { + return TypeListIndexer(static_cast(obj)).template get(); + } + template + auto get() -> decltype(getObj(std::integral_constant())) + { + return getObj(std::integral_constant()); + } + }; + + template + TypeListIndexer createTypeListIndexer(const TypeChain &obj) + { + return TypeListIndexer(obj); + } + + template 1), typename Ret = std::enable_if_t>> + constexpr Ret shift_left(const index& other) noexcept + { + Ret ret{}; + for (size_t i = 0; i < Rank - 1; ++i) + { + ret[i] = other[i + 1]; + } + return ret; + } +} + +template +class bounds_iterator; + +template +class static_bounds +{ +public: + static_bounds(const details::BoundsRanges&) { + } +}; + +template +class static_bounds +{ + using MyRanges = details::BoundsRanges; + + MyRanges m_ranges; + constexpr static_bounds(const MyRanges& range) : m_ranges(range) + {} + + template + friend class static_bounds; + +public: + static const size_t rank = MyRanges::Depth; + static const size_t dynamic_rank = MyRanges::DynamicNum; + static const std::ptrdiff_t static_size = MyRanges::TotalSize; + + using size_type = std::ptrdiff_t; + using index_type = index; + using const_index_type = std::add_const_t; + using iterator = bounds_iterator; + using const_iterator = bounds_iterator; + using difference_type = std::ptrdiff_t; + using sliced_type = static_bounds; + using mapping_type = contiguous_mapping_tag; + + constexpr static_bounds(const static_bounds&) = default; + + template , details::BoundsRanges >::value>> + constexpr static_bounds(const static_bounds& other) : m_ranges(other.m_ranges) + {} + + constexpr static_bounds(std::initializer_list il) : m_ranges((const std::ptrdiff_t*)il.begin()) + { + fail_fast_assert((MyRanges::DynamicNum == 0 && il.size() == 1 && *il.begin() == static_size) || MyRanges::DynamicNum == il.size(), "Size of the initializer list must match the rank of the array"); + fail_fast_assert(m_ranges.totalSize() <= PTRDIFF_MAX, "Size of the range is larger than the max element of the size type"); + } + + constexpr static_bounds() = default; + + constexpr static_bounds& operator=(const static_bounds& otherBounds) + { + new(&m_ranges) MyRanges (otherBounds.m_ranges); + return *this; + } + + constexpr sliced_type slice() const noexcept + { + return sliced_type{static_cast &>(m_ranges)}; + } + + constexpr size_type stride() const noexcept + { + return rank > 1 ? slice().size() : 1; + } + + constexpr size_type size() const noexcept + { + return m_ranges.totalSize(); + } + + constexpr size_type total_size() const noexcept + { + return m_ranges.totalSize(); + } + + constexpr size_type linearize(const index_type & idx) const + { + return m_ranges.linearize(idx); + } + + constexpr bool contains(const index_type& idx) const noexcept + { + return m_ranges.contains(idx) != -1; + } + + constexpr size_type operator[](size_t index) const noexcept + { + return m_ranges.elementNum(index); + } + + template + constexpr size_type extent() const noexcept + { + static_assert(Dim < rank, "dimension should be less than rank (dimension count starts from 0)"); + return details::createTypeListIndexer(m_ranges).template get().elementNum(); + } + + constexpr index_type index_bounds() const noexcept + { + size_type extents[rank] = {}; + m_ranges.serialize(extents); + return{ extents }; + } + + template + constexpr bool operator == (const static_bounds& rhs) const noexcept + { + return this->size() == rhs.size(); + } + + template + constexpr bool operator != (const static_bounds& rhs) const noexcept + { + return !(*this == rhs); + } + + constexpr const_iterator begin() const noexcept + { + return const_iterator(*this, index_type{}); + } + + constexpr const_iterator end() const noexcept + { + return const_iterator(*this, this->index_bounds()); + } +}; + +template +class strided_bounds +{ + template + friend class strided_bounds; + +public: + static const size_t rank = Rank; + using value_type = std::ptrdiff_t; + using reference = std::add_lvalue_reference_t; + using const_reference = std::add_const_t; + using size_type = value_type; + using difference_type = value_type; + using index_type = index; + using const_index_type = std::add_const_t; + using iterator = bounds_iterator; + using const_iterator = bounds_iterator; + static const value_type dynamic_rank = rank; + static const value_type static_size = dynamic_range; + using sliced_type = std::conditional_t, void>; + using mapping_type = generalized_mapping_tag; + + constexpr strided_bounds(const strided_bounds &) noexcept = default; + + constexpr strided_bounds & operator=(const strided_bounds &) noexcept = default; + + constexpr strided_bounds(const value_type(&values)[rank], index_type strides) + : m_extents(values), m_strides(std::move(strides)) + {} + + constexpr strided_bounds(const index_type &extents, const index_type &strides) noexcept + : m_extents(extents), m_strides(strides) + {} + + constexpr index_type strides() const noexcept + { + return m_strides; + } + + constexpr size_type total_size() const noexcept + { + size_type ret = 0; + for (size_t i = 0; i < rank; ++i) + { + ret += (m_extents[i] - 1) * m_strides[i]; + } + return ret + 1; + } + + constexpr size_type size() const noexcept + { + size_type ret = 1; + for (size_t i = 0; i < rank; ++i) + { + ret *= m_extents[i]; + } + return ret; + } + + constexpr bool contains(const index_type& idx) const noexcept + { + for (size_t i = 0; i < rank; ++i) + { + if (idx[i] < 0 || idx[i] >= m_extents[i]) + return false; + } + return true; + } + + constexpr size_type linearize(const index_type& idx) const noexcept + { + size_type ret = 0; + for (size_t i = 0; i < rank; i++) + { + fail_fast_assert(idx[i] < m_extents[i], "index is out of bounds of the array"); + ret += idx[i] * m_strides[i]; + } + return ret; + } + + constexpr size_type stride() const noexcept + { + return m_strides[0]; + } + + template 1), typename Ret = std::enable_if_t> + constexpr sliced_type slice() const + { + return{ details::shift_left(m_extents), details::shift_left(m_strides) }; + } + + template + constexpr size_type extent() const noexcept + { + static_assert(Dim < Rank, "dimension should be less than rank (dimension count starts from 0)"); + return m_extents[Dim]; + } + + constexpr index_type index_bounds() const noexcept + { + return m_extents; + } + constexpr const_iterator begin() const noexcept + { + return const_iterator{ *this, index_type{} }; + } + + constexpr const_iterator end() const noexcept + { + return const_iterator{ *this, index_bounds() }; + } + +private: + index_type m_extents; + index_type m_strides; +}; + +template +struct is_bounds : std::integral_constant {}; +template +struct is_bounds> : std::integral_constant {}; +template +struct is_bounds> : std::integral_constant {}; + +template +class bounds_iterator: public std::iterator +{ +private: + using Base = std::iterator ; + +public: + static const size_t rank = IndexType::rank; + using typename Base::reference; + using typename Base::pointer; + using typename Base::difference_type; + using typename Base::value_type; + using index_type = value_type; + using index_size_type = typename IndexType::value_type; + template + explicit bounds_iterator(const Bounds& bnd, value_type curr) noexcept + : boundary(bnd.index_bounds()), curr(std::move(curr)) + { + static_assert(is_bounds::value, "Bounds type must be provided"); + } + + constexpr reference operator*() const noexcept + { + return curr; + } + + constexpr pointer operator->() const noexcept + { + return &curr; + } + + constexpr bounds_iterator& operator++() noexcept + { + for (size_t i = rank; i-- > 0;) + { + if (curr[i] < boundary[i] - 1) + { + curr[i]++; + return *this; + } + curr[i] = 0; + } + // If we're here we've wrapped over - set to past-the-end. + curr = boundary; + return *this; + } + + constexpr bounds_iterator operator++(int) noexcept + { + auto ret = *this; + ++(*this); + return ret; + } + + constexpr bounds_iterator& operator--() noexcept + { + if (!less(curr, boundary)) + { + // if at the past-the-end, set to last element + for (size_t i = 0; i < rank; ++i) + { + curr[i] = boundary[i] - 1; + } + return *this; + } + for (size_t i = rank; i-- > 0;) + { + if (curr[i] >= 1) + { + curr[i]--; + return *this; + } + curr[i] = boundary[i] - 1; + } + // If we're here the preconditions were violated + // "pre: there exists s such that r == ++s" + fail_fast_assert(false); + return *this; + } + + constexpr bounds_iterator operator--(int) noexcept + { + auto ret = *this; + --(*this); + return ret; + } + + constexpr bounds_iterator operator+(difference_type n) const noexcept + { + bounds_iterator ret{ *this }; + return ret += n; + } + + constexpr bounds_iterator& operator+=(difference_type n) noexcept + { + auto linear_idx = linearize(curr) + n; + std::remove_const_t stride = 0; + stride[rank - 1] = 1; + for (size_t i = rank - 1; i-- > 0;) + { + stride[i] = stride[i + 1] * boundary[i + 1]; + } + for (size_t i = 0; i < rank; ++i) + { + curr[i] = linear_idx / stride[i]; + linear_idx = linear_idx % stride[i]; + } + fail_fast_assert(!less(curr, index_type{}) && !less(boundary, curr), "index is out of bounds of the array"); + return *this; + } + + constexpr bounds_iterator operator-(difference_type n) const noexcept + { + bounds_iterator ret{ *this }; + return ret -= n; + } + + constexpr bounds_iterator& operator-=(difference_type n) noexcept + { + return *this += -n; + } + + constexpr difference_type operator-(const bounds_iterator& rhs) const noexcept + { + return linearize(curr) - linearize(rhs.curr); + } + + constexpr value_type operator[](difference_type n) const noexcept + { + return *(*this + n); + } + + constexpr bool operator==(const bounds_iterator& rhs) const noexcept + { + return curr == rhs.curr; + } + + constexpr bool operator!=(const bounds_iterator& rhs) const noexcept + { + return !(*this == rhs); + } + + constexpr bool operator<(const bounds_iterator& rhs) const noexcept + { + return less(curr, rhs.curr); + } + + constexpr bool operator<=(const bounds_iterator& rhs) const noexcept + { + return !(rhs < *this); + } + + constexpr bool operator>(const bounds_iterator& rhs) const noexcept + { + return rhs < *this; + } + + constexpr bool operator>=(const bounds_iterator& rhs) const noexcept + { + return !(rhs > *this); + } + + void swap(bounds_iterator& rhs) noexcept + { + std::swap(boundary, rhs.boundary); + std::swap(curr, rhs.curr); + } +private: + constexpr bool less(index_type& one, index_type& other) const noexcept + { + for (size_t i = 0; i < rank; ++i) + { + if (one[i] < other[i]) + return true; + } + return false; + } + + constexpr index_size_type linearize(const value_type& idx) const noexcept + { + // TODO: Smarter impl. + // Check if past-the-end + index_size_type multiplier = 1; + index_size_type res = 0; + if (!less(idx, boundary)) + { + res = 1; + for (size_t i = rank; i-- > 0;) + { + res += (idx[i] - 1) * multiplier; + multiplier *= boundary[i]; + } + } + else + { + for (size_t i = rank; i-- > 0;) + { + res += idx[i] * multiplier; + multiplier *= boundary[i]; + } + } + return res; + } + + value_type boundary; + std::remove_const_t curr; +}; + +template +bounds_iterator operator+(typename bounds_iterator::difference_type n, const bounds_iterator& rhs) noexcept +{ + return rhs + n; +} + +// +// begin definitions of basic_span +// +namespace details +{ + template + constexpr std::enable_if_t::value, typename Bounds::index_type> make_stride(const Bounds& bnd) noexcept + { + return bnd.strides(); + } + + // Make a stride vector from bounds, assuming contiguous memory. + template + constexpr std::enable_if_t::value, typename Bounds::index_type> make_stride(const Bounds& bnd) noexcept + { + auto extents = bnd.index_bounds(); + typename Bounds::size_type stride[Bounds::rank] = {}; + + stride[Bounds::rank - 1] = 1; + for (size_t i = 1; i < Bounds::rank; ++i) + { + stride[Bounds::rank - i - 1] = stride[Bounds::rank - i] * extents[Bounds::rank - i]; + } + return{ stride }; + } + + template + void verifyBoundsReshape(const BoundsSrc &src, const BoundsDest &dest) + { + static_assert(is_bounds::value && is_bounds::value, "The src type and dest type must be bounds"); + static_assert(std::is_same::value, "The source type must be a contiguous bounds"); + static_assert(BoundsDest::static_size == dynamic_range || BoundsSrc::static_size == dynamic_range || BoundsDest::static_size == BoundsSrc::static_size, "The source bounds must have same size as dest bounds"); + fail_fast_assert(src.size() == dest.size()); + } + + +} // namespace details + +template +class contiguous_span_iterator; +template +class general_span_iterator; +enum class byte : std::uint8_t {}; + +template +class basic_span +{ +public: + static const size_t rank = BoundsType::rank; + using bounds_type = BoundsType; + using size_type = typename bounds_type::size_type; + using index_type = typename bounds_type::index_type; + using value_type = ValueType; + using const_value_type = std::add_const_t; + using pointer = ValueType*; + using reference = ValueType&; + using iterator = std::conditional_t::value, contiguous_span_iterator, general_span_iterator>; + using const_iterator = std::conditional_t::value, contiguous_span_iterator>, general_span_iterator>>; + using reverse_iterator = std::reverse_iterator; + using const_reverse_iterator = std::reverse_iterator; + using sliced_type = std::conditional_t>; + +private: + pointer m_pdata; + bounds_type m_bounds; + +public: + constexpr bounds_type bounds() const noexcept + { + return m_bounds; + } + template + constexpr size_type extent() const noexcept + { + static_assert(Dim < rank, "dimension should be less than rank (dimension count starts from 0)"); + return m_bounds.template extent(); + } + constexpr size_type size() const noexcept + { + return m_bounds.size(); + } + constexpr reference operator[](const index_type& idx) const + { + return m_pdata[m_bounds.linearize(idx)]; + } + constexpr pointer data() const noexcept + { + return m_pdata; + } + template 1), typename Ret = std::enable_if_t> + constexpr Ret operator[](size_type idx) const + { + fail_fast_assert(idx < m_bounds.size(), "index is out of bounds of the array"); + const size_type ridx = idx * m_bounds.stride(); + + fail_fast_assert(ridx < m_bounds.total_size(), "index is out of bounds of the underlying data"); + return Ret {m_pdata + ridx, m_bounds.slice()}; + } + + constexpr operator bool () const noexcept + { + return m_pdata != nullptr; + } + + constexpr iterator begin() const + { + return iterator {this, true}; + } + constexpr iterator end() const + { + return iterator {this, false}; + } + constexpr const_iterator cbegin() const + { + return const_iterator {reinterpret_cast *>(this), true}; + } + constexpr const_iterator cend() const + { + return const_iterator {reinterpret_cast *>(this), false}; + } + + constexpr reverse_iterator rbegin() const + { + return reverse_iterator {end()}; + } + constexpr reverse_iterator rend() const + { + return reverse_iterator {begin()}; + } + constexpr const_reverse_iterator crbegin() const + { + return const_reverse_iterator {cend()}; + } + constexpr const_reverse_iterator crend() const + { + return const_reverse_iterator {cbegin()}; + } + + template , std::remove_cv_t>::value>> + constexpr bool operator== (const basic_span & other) const noexcept + { + return m_bounds.size() == other.m_bounds.size() && + (m_pdata == other.m_pdata || std::equal(this->begin(), this->end(), other.begin())); + } + + template , std::remove_cv_t>::value>> + constexpr bool operator!= (const basic_span & other) const noexcept + { + return !(*this == other); + } + + template , std::remove_cv_t>::value>> + constexpr bool operator< (const basic_span & other) const noexcept + { + return std::lexicographical_compare(this->begin(), this->end(), other.begin(), other.end()); + } + + template , std::remove_cv_t>::value>> + constexpr bool operator<= (const basic_span & other) const noexcept + { + return !(other < *this); + } + + template , std::remove_cv_t>::value>> + constexpr bool operator> (const basic_span & other) const noexcept + { + return (other < *this); + } + + template , std::remove_cv_t>::value>> + constexpr bool operator>= (const basic_span & other) const noexcept + { + return !(*this < other); + } + +public: + template ::value + && std::is_convertible::value>> + constexpr basic_span(const basic_span & other ) noexcept + : m_pdata(other.m_pdata), m_bounds(other.m_bounds) + { + } +protected: + + constexpr basic_span(pointer data, bounds_type bound) noexcept + : m_pdata(data) + , m_bounds(std::move(bound)) + { + fail_fast_assert((m_bounds.size() > 0 && data != nullptr) || m_bounds.size() == 0); + } + template + constexpr basic_span(T *data, std::enable_if_t>::value, bounds_type> bound) noexcept + : m_pdata(reinterpret_cast(data)) + , m_bounds(std::move(bound)) + { + fail_fast_assert((m_bounds.size() > 0 && data != nullptr) || m_bounds.size() == 0); + } + template + constexpr basic_span as_span(const DestBounds &bounds) + { + details::verifyBoundsReshape(m_bounds, bounds); + return {m_pdata, bounds}; + } +private: + + friend iterator; + friend const_iterator; + template + friend class basic_span; +}; + +template +struct dim +{ + static const std::ptrdiff_t value = DimSize; +}; +template <> +struct dim +{ + static const std::ptrdiff_t value = dynamic_range; + const std::ptrdiff_t dvalue; + dim(std::ptrdiff_t size) : dvalue(size) {} +}; + +template +class span; + +template +class strided_span; + +namespace details +{ + template + struct ArrayViewTypeTraits + { + using value_type = T; + using size_type = size_t; + }; + + template + struct ArrayViewTypeTraits::type> + { + using value_type = typename Traits::span_traits::value_type; + using size_type = typename Traits::span_traits::size_type; + }; + + template + struct ArrayViewArrayTraits { + using type = span; + using value_type = T; + using bounds_type = static_bounds; + using pointer = T*; + using reference = T&; + }; + template + struct ArrayViewArrayTraits : ArrayViewArrayTraits {}; + + template + BoundsType newBoundsHelperImpl(std::ptrdiff_t totalSize, std::true_type) // dynamic size + { + fail_fast_assert(totalSize <= PTRDIFF_MAX); + return BoundsType{totalSize}; + } + template + BoundsType newBoundsHelperImpl(std::ptrdiff_t totalSize, std::false_type) // static size + { + fail_fast_assert(BoundsType::static_size == totalSize); + return {}; + } + template + BoundsType newBoundsHelper(std::ptrdiff_t totalSize) + { + static_assert(BoundsType::dynamic_rank <= 1, "dynamic rank must less or equal to 1"); + return newBoundsHelperImpl(totalSize, std::integral_constant()); + } + + struct Sep{}; + + template + T static_as_span_helper(Sep, Args... args) + { + return T{static_cast(args)...}; + } + template + std::enable_if_t>::value && !std::is_same::value, T> static_as_span_helper(Arg, Args... args) + { + return static_as_span_helper(args...); + } + template + T static_as_span_helper(dim val, Args ... args) + { + return static_as_span_helper(args..., val.dvalue); + } + + template + struct static_as_span_static_bounds_helper + { + using type = static_bounds<(Dimensions::value)...>; + }; + + template + struct is_span_oracle : std::false_type + {}; + + template + struct is_span_oracle> : std::true_type + {}; + + template + struct is_span_oracle> : std::true_type + {}; + + template + struct is_span : is_span_oracle> + {}; + +} + + +template +class span : public basic_span > +{ + template + friend class span; + + using Base = basic_span>; + +public: + using typename Base::bounds_type; + using typename Base::size_type; + using typename Base::pointer; + using typename Base::value_type; + using typename Base::index_type; + using typename Base::iterator; + using typename Base::const_iterator; + using typename Base::reference; + using Base::rank; + +public: + // basic + constexpr span(pointer ptr, size_type size) : Base(ptr, bounds_type{ size }) + {} + + constexpr span(pointer ptr, bounds_type bounds) : Base(ptr, std::move(bounds)) + {} + + constexpr span(std::nullptr_t) : Base(nullptr, bounds_type{}) + {} + + constexpr span(std::nullptr_t, size_type size) : Base(nullptr, bounds_type{}) + { + fail_fast_assert(size == 0); + } + + // default + template > + constexpr span() : Base(nullptr, bounds_type()) + {} + + // from n-dimensions dynamic array (e.g. new int[m][4]) (precedence will be lower than the 1-dimension pointer) + template + /*typename Dummy = std::enable_if_t::value>*/> + constexpr span(T* const& data, size_type size) : Base(data, typename Helper::bounds_type{size}) + {} + + // from n-dimensions static array + template , + typename = std::enable_if_t::value>> + constexpr span (T (&arr)[N]) : Base(arr, typename Helper::bounds_type()) + {} + + // from n-dimensions static array with size + template , + typename = std::enable_if_t::value> + > + constexpr span(T(&arr)[N], size_type size) : Base(arr, typename Helper::bounds_type{size}) + { + fail_fast_assert(size <= N); + } + + // from std array + template , typename Base::bounds_type>::value> + > + constexpr span (std::array, N> & arr) : Base(arr.data(), static_bounds()) + {} + + template , typename Base::bounds_type>::value + && std::is_const::value> + > + constexpr span (const std::array, N> & arr) : Base(arr.data(), static_bounds()) + {} + + // from begin, end pointers. We don't provide iterator pair since no way to guarantee the contiguity + template ::value + && details::LessThan::value> + > // remove literal 0 case + constexpr span (pointer begin, Ptr end) : Base(begin, details::newBoundsHelper(static_cast(end) - begin)) + {} + + // from containers. It must has .size() and .data() two function signatures + template ::value + && std::is_convertible::value + && std::is_same().size(), *std::declval().data())>, DataType>::value> + > + constexpr span (Cont& cont) : Base(static_cast(cont.data()), details::newBoundsHelper(cont.size())) + {} + + constexpr span(const span &) = default; + + // convertible + template >, + typename OtherBaseType = basic_span>, + typename Dummy = std::enable_if_t::value> + > + constexpr span(const span &av) + : Base(static_cast::Base&>(av)) + {} + + // reshape + // DimCount here is a workaround for a bug in MSVC 2015 + template 0)>> + constexpr span as_span(Dimensions2... dims) + { + using BoundsType = typename span::bounds_type; + auto tobounds = details::static_as_span_helper(dims..., details::Sep{}); + details::verifyBoundsReshape(this->bounds(), tobounds); + return {this->data(), tobounds}; + } + + // to bytes array + template >::value> + auto as_bytes() const noexcept -> span + { + static_assert(Enabled, "The value_type of span must be standarded layout"); + return { reinterpret_cast(this->data()), this->bytes() }; + } + + template >::value> + auto as_writeable_bytes() const noexcept -> span + { + static_assert(Enabled, "The value_type of span must be standarded layout"); + return { reinterpret_cast(this->data()), this->bytes() }; + } + + // from bytes array + template::value, typename = std::enable_if_t> + constexpr auto as_span() const noexcept -> span(static_cast(Base::bounds_type::static_size) / sizeof(U)) : dynamic_range)> + { + static_assert(std::is_standard_layout::value && (Base::bounds_type::static_size == dynamic_range || Base::bounds_type::static_size % static_cast(sizeof(U)) == 0), + "Target type must be standard layout and its size must match the byte array size"); + fail_fast_assert((this->bytes() % sizeof(U)) == 0 && (this->bytes() / sizeof(U)) < PTRDIFF_MAX); + return { reinterpret_cast(this->data()), this->bytes() / static_cast(sizeof(U)) }; + } + + template::value, typename = std::enable_if_t> + constexpr auto as_span() const noexcept -> span(static_cast(Base::bounds_type::static_size) / sizeof(U)) : dynamic_range)> + { + static_assert(std::is_standard_layout::value && (Base::bounds_type::static_size == dynamic_range || Base::bounds_type::static_size % static_cast(sizeof(U)) == 0), + "Target type must be standard layout and its size must match the byte array size"); + fail_fast_assert((this->bytes() % sizeof(U)) == 0); + return { reinterpret_cast(this->data()), this->bytes() / static_cast(sizeof(U)) }; + } + + // section on linear space + template + constexpr span first() const noexcept + { + static_assert(bounds_type::static_size == dynamic_range || Count <= bounds_type::static_size, "Index is out of bound"); + fail_fast_assert(bounds_type::static_size != dynamic_range || Count <= this->size()); // ensures we only check condition when needed + return { this->data(), Count }; + } + + constexpr span first(size_type count) const noexcept + { + fail_fast_assert(count <= this->size()); + return { this->data(), count }; + } + + template + constexpr span last() const noexcept + { + static_assert(bounds_type::static_size == dynamic_range || Count <= bounds_type::static_size, "Index is out of bound"); + fail_fast_assert(bounds_type::static_size != dynamic_range || Count <= this->size()); + return { this->data() + this->size() - Count, Count }; + } + + constexpr span last(size_type count) const noexcept + { + fail_fast_assert(count <= this->size()); + return { this->data() + this->size() - count, count }; + } + + template + constexpr span sub() const noexcept + { + static_assert(bounds_type::static_size == dynamic_range || ((Offset == 0 || Offset <= bounds_type::static_size) && Offset + Count <= bounds_type::static_size), "Index is out of bound"); + fail_fast_assert(bounds_type::static_size != dynamic_range || ((Offset == 0 || Offset <= this->size()) && Offset + Count <= this->size())); + return { this->data() + Offset, Count }; + } + + constexpr span sub(size_type offset, size_type count = dynamic_range) const noexcept + { + fail_fast_assert((offset == 0 || offset <= this->size()) && (count == dynamic_range || (offset + count) <= this->size())); + return { this->data() + offset, count == dynamic_range ? this->length() - offset : count }; + } + + // size + constexpr size_type length() const noexcept + { + return this->size(); + } + + constexpr size_type used_length() const noexcept + { + return length(); + } + + constexpr size_type bytes() const noexcept + { + return sizeof(value_type) * this->size(); + } + + constexpr size_type used_bytes() const noexcept + { + return bytes(); + } + + // section + constexpr strided_span section(index_type origin, index_type extents) const + { + size_type size = this->bounds().total_size() - this->bounds().linearize(origin); + return{ &this->operator[](origin), size, strided_bounds {extents, details::make_stride(Base::bounds())} }; + } + + constexpr reference operator[](const index_type& idx) const + { + return Base::operator[](idx); + } + + template 1), typename Dummy = std::enable_if_t> + constexpr span operator[](size_type idx) const + { + auto ret = Base::operator[](idx); + return{ ret.data(), ret.bounds() }; + } + + using Base::operator==; + using Base::operator!=; + using Base::operator<; + using Base::operator<=; + using Base::operator>; + using Base::operator>=; +}; + +template +constexpr auto as_span(T* const& ptr, dim... args) -> span, Dimensions...> +{ + return {reinterpret_cast*>(ptr), details::static_as_span_helper>(args..., details::Sep{})}; +} + +template +constexpr auto as_span (T* arr, std::ptrdiff_t len) -> typename details::ArrayViewArrayTraits::type +{ + return {reinterpret_cast*>(arr), len}; +} + +template +constexpr auto as_span (T (&arr)[N]) -> typename details::ArrayViewArrayTraits::type +{ + return {arr}; +} + +template +constexpr span as_span(const std::array &arr) +{ + return {arr}; +} + +template +constexpr span as_span(const std::array &&) = delete; + +template +constexpr span as_span(std::array &arr) +{ + return {arr}; +} + +template +constexpr span as_span(T *begin, T *end) +{ + return {begin, end}; +} + +template +constexpr auto as_span(Cont &arr) -> std::enable_if_t>::value, + span, dynamic_range>> +{ + fail_fast_assert(arr.size() < PTRDIFF_MAX); + return {arr.data(), static_cast(arr.size())}; +} + +template +constexpr auto as_span(Cont &&arr) -> std::enable_if_t>::value, + span, dynamic_range>> = delete; + +template +class strided_span : public basic_span> +{ + using Base = basic_span>; + + template + friend class strided_span; + +public: + using Base::rank; + using typename Base::bounds_type; + using typename Base::size_type; + using typename Base::pointer; + using typename Base::value_type; + using typename Base::index_type; + using typename Base::iterator; + using typename Base::const_iterator; + using typename Base::reference; + + // from static array of size N + template + strided_span(value_type(&values)[N], bounds_type bounds) : Base(values, std::move(bounds)) + { + fail_fast_assert(this->bounds().total_size() <= N, "Bounds cross data boundaries"); + } + + // from raw data + strided_span(pointer ptr, size_type size, bounds_type bounds): Base(ptr, std::move(bounds)) + { + fail_fast_assert(this->bounds().total_size() <= size, "Bounds cross data boundaries"); + } + + // from array view + template > + strided_span(span av, bounds_type bounds) : Base(av.data(), std::move(bounds)) + { + fail_fast_assert(this->bounds().total_size() <= av.bounds().total_size(), "Bounds cross data boundaries"); + } + + // convertible + template >, + typename OtherBaseType = basic_span>, + typename Dummy = std::enable_if_t::value> + > + constexpr strided_span(const strided_span &av) : Base(static_cast::Base &>(av)) // static_cast is required + {} + + // convert from bytes + template + strided_span::value, OtherValueType>::type, rank> as_strided_span() const + { + static_assert((sizeof(OtherValueType) >= sizeof(value_type)) && (sizeof(OtherValueType) % sizeof(value_type) == 0), "OtherValueType should have a size to contain a multiple of ValueTypes"); + auto d = static_cast(sizeof(OtherValueType) / sizeof(value_type)); + + size_type size = this->bounds().total_size() / d; + return{ (OtherValueType*)this->data(), size, bounds_type{ resize_extent(this->bounds().index_bounds(), d), resize_stride(this->bounds().strides(), d)} }; + } + + strided_span section(index_type origin, index_type extents) const + { + size_type size = this->bounds().total_size() - this->bounds().linearize(origin); + return { &this->operator[](origin), size, bounds_type {extents, details::make_stride(Base::bounds())}}; + } + + constexpr reference operator[](const index_type& idx) const + { + return Base::operator[](idx); + } + + template 1), typename Dummy = std::enable_if_t> + constexpr strided_span operator[](size_type idx) const + { + auto ret = Base::operator[](idx); + return{ ret.data(), ret.bounds().total_size(), ret.bounds() }; + } + +private: + static index_type resize_extent(const index_type& extent, std::ptrdiff_t d) + { + fail_fast_assert(extent[rank - 1] >= d && (extent[rank-1] % d == 0), "The last dimension of the array needs to contain a multiple of new type elements"); + + index_type ret = extent; + ret[rank - 1] /= d; + + return ret; + } + + template > + static index_type resize_stride(const index_type& strides, std::ptrdiff_t , void * = 0) + { + fail_fast_assert(strides[rank - 1] == 1, "Only strided arrays with regular strides can be resized"); + + return strides; + } + + template 1), typename Dummy = std::enable_if_t> + static index_type resize_stride(const index_type& strides, std::ptrdiff_t d) + { + fail_fast_assert(strides[rank - 1] == 1, "Only strided arrays with regular strides can be resized"); + fail_fast_assert(strides[rank - 2] >= d && (strides[rank - 2] % d == 0), "The strides must have contiguous chunks of memory that can contain a multiple of new type elements"); + + for (size_t i = rank - 1; i > 0; --i) + fail_fast_assert((strides[i-1] >= strides[i]) && (strides[i-1] % strides[i] == 0), "Only strided arrays with regular strides can be resized"); + + index_type ret = strides / d; + ret[rank - 1] = 1; + + return ret; + } +}; + +template +class contiguous_span_iterator : public std::iterator +{ + using Base = std::iterator; +public: + using typename Base::reference; + using typename Base::pointer; + using typename Base::difference_type; + +private: + template + friend class basic_span; + + pointer m_pdata; + const ArrayView * m_validator; + void validateThis() const + { + fail_fast_assert(m_pdata >= m_validator->m_pdata && m_pdata < m_validator->m_pdata + m_validator->size(), "iterator is out of range of the array"); + } + contiguous_span_iterator (const ArrayView *container, bool isbegin) : + m_pdata(isbegin ? container->m_pdata : container->m_pdata + container->size()), m_validator(container) {} +public: + reference operator*() const noexcept + { + validateThis(); + return *m_pdata; + } + pointer operator->() const noexcept + { + validateThis(); + return m_pdata; + } + contiguous_span_iterator& operator++() noexcept + { + ++m_pdata; + return *this; + } + contiguous_span_iterator operator++(int)noexcept + { + auto ret = *this; + ++(*this); + return ret; + } + contiguous_span_iterator& operator--() noexcept + { + --m_pdata; + return *this; + } + contiguous_span_iterator operator--(int)noexcept + { + auto ret = *this; + --(*this); + return ret; + } + contiguous_span_iterator operator+(difference_type n) const noexcept + { + contiguous_span_iterator ret{ *this }; + return ret += n; + } + contiguous_span_iterator& operator+=(difference_type n) noexcept + { + m_pdata += n; + return *this; + } + contiguous_span_iterator operator-(difference_type n) const noexcept + { + contiguous_span_iterator ret{ *this }; + return ret -= n; + } + contiguous_span_iterator& operator-=(difference_type n) noexcept + { + return *this += -n; + } + difference_type operator-(const contiguous_span_iterator& rhs) const noexcept + { + fail_fast_assert(m_validator == rhs.m_validator); + return m_pdata - rhs.m_pdata; + } + reference operator[](difference_type n) const noexcept + { + return *(*this + n); + } + bool operator==(const contiguous_span_iterator& rhs) const noexcept + { + fail_fast_assert(m_validator == rhs.m_validator); + return m_pdata == rhs.m_pdata; + } + bool operator!=(const contiguous_span_iterator& rhs) const noexcept + { + return !(*this == rhs); + } + bool operator<(const contiguous_span_iterator& rhs) const noexcept + { + fail_fast_assert(m_validator == rhs.m_validator); + return m_pdata < rhs.m_pdata; + } + bool operator<=(const contiguous_span_iterator& rhs) const noexcept + { + return !(rhs < *this); + } + bool operator>(const contiguous_span_iterator& rhs) const noexcept + { + return rhs < *this; + } + bool operator>=(const contiguous_span_iterator& rhs) const noexcept + { + return !(rhs > *this); + } + void swap(contiguous_span_iterator& rhs) noexcept + { + std::swap(m_pdata, rhs.m_pdata); + std::swap(m_validator, rhs.m_validator); + } +}; + +template +contiguous_span_iterator operator+(typename contiguous_span_iterator::difference_type n, const contiguous_span_iterator& rhs) noexcept +{ + return rhs + n; +} + +template +class general_span_iterator : public std::iterator +{ + using Base = std::iterator; +public: + using typename Base::reference; + using typename Base::pointer; + using typename Base::difference_type; + using typename Base::value_type; +private: + template + friend class basic_span; + + const ArrayView * m_container; + typename ArrayView::bounds_type::iterator m_itr; + general_span_iterator(const ArrayView *container, bool isbegin) : + m_container(container), m_itr(isbegin ? m_container->bounds().begin() : m_container->bounds().end()) + {} +public: + reference operator*() noexcept + { + return (*m_container)[*m_itr]; + } + pointer operator->() noexcept + { + return &(*m_container)[*m_itr]; + } + general_span_iterator& operator++() noexcept + { + ++m_itr; + return *this; + } + general_span_iterator operator++(int)noexcept + { + auto ret = *this; + ++(*this); + return ret; + } + general_span_iterator& operator--() noexcept + { + --m_itr; + return *this; + } + general_span_iterator operator--(int)noexcept + { + auto ret = *this; + --(*this); + return ret; + } + general_span_iterator operator+(difference_type n) const noexcept + { + general_span_iterator ret{ *this }; + return ret += n; + } + general_span_iterator& operator+=(difference_type n) noexcept + { + m_itr += n; + return *this; + } + general_span_iterator operator-(difference_type n) const noexcept + { + general_span_iterator ret{ *this }; + return ret -= n; + } + general_span_iterator& operator-=(difference_type n) noexcept + { + return *this += -n; + } + difference_type operator-(const general_span_iterator& rhs) const noexcept + { + fail_fast_assert(m_container == rhs.m_container); + return m_itr - rhs.m_itr; + } + value_type operator[](difference_type n) const noexcept + { + return (*m_container)[m_itr[n]];; + } + bool operator==(const general_span_iterator& rhs) const noexcept + { + fail_fast_assert(m_container == rhs.m_container); + return m_itr == rhs.m_itr; + } + bool operator !=(const general_span_iterator& rhs) const noexcept + { + return !(*this == rhs); + } + bool operator<(const general_span_iterator& rhs) const noexcept + { + fail_fast_assert(m_container == rhs.m_container); + return m_itr < rhs.m_itr; + } + bool operator<=(const general_span_iterator& rhs) const noexcept + { + return !(rhs < *this); + } + bool operator>(const general_span_iterator& rhs) const noexcept + { + return rhs < *this; + } + bool operator>=(const general_span_iterator& rhs) const noexcept + { + return !(rhs > *this); + } + void swap(general_span_iterator& rhs) noexcept + { + std::swap(m_itr, rhs.m_itr); + std::swap(m_container, rhs.m_container); + } +}; + +template +general_span_iterator operator+(typename general_span_iterator::difference_type n, const general_span_iterator& rhs) noexcept +{ + return rhs + n; +} + +} // namespace gsl + +#ifdef _MSC_VER + +#undef constexpr +#pragma pop_macro("constexpr") + +#if _MSC_VER <= 1800 +#pragma warning(pop) + +#ifndef GSL_THROWS_FOR_TESTING +#pragma undef noexcept +#endif // GSL_THROWS_FOR_TESTING + +#undef GSL_MSVC_HAS_VARIADIC_CTOR_BUG +#pragma pop_macro("GSL_MSVC_HAS_VARIADIC_CTOR_BUG") + + +#endif // _MSC_VER <= 1800 + +#endif // _MSC_VER + +#if defined(GSL_THROWS_FOR_TESTING) +#undef noexcept +#endif // GSL_THROWS_FOR_TESTING + + +#endif // GSL_SPAN_H diff --git a/include/string_span.h b/include/string_span.h new file mode 100644 index 0000000..7194c85 --- /dev/null +++ b/include/string_span.h @@ -0,0 +1,227 @@ +/////////////////////////////////////////////////////////////////////////////// +// +// Copyright (c) 2015 Microsoft Corporation. All rights reserved. +// +// This code is licensed under the MIT License (MIT). +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +// THE SOFTWARE. +// +/////////////////////////////////////////////////////////////////////////////// + +#pragma once + +#ifndef GSL_STRING_SPAN_H +#define GSL_STRING_SPAN_H + +#include "span.h" +#include + +// VS 2013 workarounds +#ifdef _MSC_VER +#if _MSC_VER <= 1800 + +#pragma push_macro("GSL_MSVC_HAS_TYPE_DEDUCTION_BUG") +#define GSL_MSVC_HAS_TYPE_DEDUCTION_BUG + +#endif // _MSC_VER <= 1800 +#endif // _MSC_VER + +namespace gsl +{ +// +// czstring and wzstring +// +// These are "tag" typedef's for C-style strings (i.e. null-terminated character arrays) +// that allow static analysis to help find bugs. +// +// There are no additional features/semantics that we can find a way to add inside the +// type system for these types that will not either incur significant runtime costs or +// (sometimes needlessly) break existing programs when introduced. +// +template +using czstring = const char*; + +template +using cwzstring = const wchar_t*; + +template +using zstring = char*; + +template +using wzstring = wchar_t*; + +// +// string_span and relatives +// +// Note that Extent is always single-dimension only +// +template +using basic_string_span = span; + +template +using string_span = basic_string_span; + +template +using cstring_span = basic_string_span; + +template +using wstring_span = basic_string_span; + +template +using cwstring_span = basic_string_span; + + +// +// ensure_sentinel() +// +// Provides a way to obtain an span from a contiguous sequence +// that ends with a (non-inclusive) sentinel value. +// +// Will fail-fast if sentinel cannot be found before max elements are examined. +// +template +span ensure_sentinel(const T* seq, std::ptrdiff_t max = PTRDIFF_MAX) +{ + auto cur = seq; + while ((cur - seq) < max && *cur != Sentinel) ++cur; + fail_fast_assert(*cur == Sentinel); + return{ seq, cur - seq }; +} + + +// +// ensure_z - creates a string_span for a czstring or cwzstring. +// Will fail fast if a null-terminator cannot be found before +// the limit of size_type. +// +template +inline basic_string_span ensure_z(T* const & sz, std::ptrdiff_t max = PTRDIFF_MAX) +{ + return ensure_sentinel(sz, max); +} + +// TODO (neilmac) there is probably a better template-magic way to get the const and non-const overloads to share an implementation +inline basic_string_span ensure_z(char* const& sz, std::ptrdiff_t max) +{ + auto len = strnlen(sz, max); + fail_fast_assert(sz[len] == 0); + return{ sz, static_cast(len) }; +} + +inline basic_string_span ensure_z(const char* const& sz, std::ptrdiff_t max) +{ + auto len = strnlen(sz, max); + fail_fast_assert(sz[len] == 0); return{ sz, static_cast(len) }; +} + +inline basic_string_span ensure_z(wchar_t* const& sz, std::ptrdiff_t max) +{ + auto len = wcsnlen(sz, max); + fail_fast_assert(sz[len] == 0); return{ sz, static_cast(len) }; +} + +inline basic_string_span ensure_z(const wchar_t* const& sz, std::ptrdiff_t max) +{ + auto len = wcsnlen(sz, max); + fail_fast_assert(sz[len] == 0); return{ sz, static_cast(len) }; +} + +template +basic_string_span ensure_z(T(&sz)[N]) { return ensure_z(&sz[0], static_cast(N)); } + +template +basic_string_span::type, dynamic_range> ensure_z(Cont& cont) +{ + return ensure_z(cont.data(), static_cast(cont.length())); +} + +// +// to_string() allow (explicit) conversions from string_span to string +// +#ifndef GSL_MSVC_HAS_TYPE_DEDUCTION_BUG + +template +std::basic_string::type> to_string(basic_string_span view) +{ + return{ view.data(), static_cast(view.length()) }; +} + +#else + +inline std::string to_string(cstring_span<> view) +{ + return{ view.data(), view.length() }; +} + +inline std::string to_string(string_span<> view) +{ + return{ view.data(), view.length() }; +} + +inline std::wstring to_string(cwstring_span<> view) +{ + return{ view.data(), view.length() }; +} + +inline std::wstring to_string(wstring_span<> view) +{ + return{ view.data(), view.length() }; +} + +#endif + +template +class basic_zstring_builder +{ +public: + using string_span_type = basic_string_span; + using value_type = CharT; + using pointer = CharT*; + using size_type = typename string_span_type::size_type; + using iterator = typename string_span_type::iterator; + + basic_zstring_builder(CharT* data, size_type length) : sv_(data, length) {} + + template + basic_zstring_builder(CharT(&arr)[Size]) : sv_(arr) {} + + pointer data() const { return sv_.data(); } + string_span_type view() const { return sv_; } + + size_type length() const { return sv_.length(); } + + pointer assume0() const { return data(); } + string_span_type ensure_z() const { return gsl::ensure_z(sv_); } + + iterator begin() const { return sv_.begin(); } + iterator end() const { return sv_.end(); } + +private: + string_span_type sv_; +}; + +template +using zstring_builder = basic_zstring_builder; + +template +using wzstring_builder = basic_zstring_builder; +} + +// VS 2013 workarounds +#ifdef _MSC_VER +#if _MSC_VER <= 1800 + +#pragma pop_macro("GSL_MSVC_HAS_TYPE_DEDUCTION_BUG") +#undef GSL_MSVC_HAS_TYPE_DEDUCTION_BUG + +#endif // _MSC_VER <= 1800 +#endif // _MSC_VER + + +#endif // GSL_STRING_SPAN_H diff --git a/include/string_view.h b/include/string_view.h deleted file mode 100644 index 4076d52..0000000 --- a/include/string_view.h +++ /dev/null @@ -1,183 +0,0 @@ -/////////////////////////////////////////////////////////////////////////////// -// -// Copyright (c) 2015 Microsoft Corporation. All rights reserved. -// -// This code is licensed under the MIT License (MIT). -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -// THE SOFTWARE. -// -/////////////////////////////////////////////////////////////////////////////// - -#pragma once - -#ifndef GSL_STRING_VIEW_H -#define GSL_STRING_VIEW_H - -#include "array_view.h" -#include - -namespace gsl -{ -// -// czstring and wzstring -// -// These are "tag" typedef's for C-style strings (i.e. null-terminated character arrays) -// that allow static analysis to help find bugs. -// -// There are no additional features/semantics that we can find a way to add inside the -// type system for these types that will not either incur significant runtime costs or -// (sometimes needlessly) break existing programs when introduced. -// -template -using czstring = const char*; - -template -using cwzstring = const wchar_t*; - -template -using zstring = char*; - -template -using wzstring = wchar_t*; - -// -// string_view and relatives -// -// Note that Extent is always single-dimension only -// Note that SizeType is defaulted to be smaller than size_t which is the array_view default -// -// TODO (neilmac) once array_view regains configurable size_type, update these typedef's -// -template -using basic_string_view = array_view; - -template -using string_view = basic_string_view; - -template -using cstring_view = basic_string_view; - -template -using wstring_view = basic_string_view; - -template -using cwstring_view = basic_string_view; - - -// -// ensure_sentinel() -// -// Provides a way to obtain an array_view from a contiguous sequence -// that ends with a (non-inclusive) sentinel value. -// -// Will fail-fast if sentinel cannot be found before max elements are examined. -// -template -array_view ensure_sentinel(const T* seq, SizeType max = std::numeric_limits::max()) -{ - auto cur = seq; - while ((cur - seq) < max && *cur != Sentinel) ++cur; - fail_fast_assert(*cur == Sentinel); - return{ seq, cur - seq }; -} - - -// -// ensure_z - creates a string_view for a czstring or cwzstring. -// Will fail fast if a null-terminator cannot be found before -// the limit of size_type. -// -template -inline basic_string_view ensure_z(T* const & sz, size_t max = std::numeric_limits::max()) -{ - return ensure_sentinel<0>(sz, max); -} - -// TODO (neilmac) there is probably a better template-magic way to get the const and non-const overloads to share an implementation -inline basic_string_view ensure_z(char* const & sz, size_t max) -{ - auto len = strnlen(sz, max); - fail_fast_assert(sz[len] == 0); return{ sz, len }; -} - -inline basic_string_view ensure_z(const char* const& sz, size_t max) -{ - auto len = strnlen(sz, max); - fail_fast_assert(sz[len] == 0); return{ sz, len }; -} - -inline basic_string_view ensure_z(wchar_t* const & sz, size_t max) -{ - auto len = wcsnlen(sz, max); - fail_fast_assert(sz[len] == 0); return{ sz, len }; -} - -inline basic_string_view ensure_z(const wchar_t* const & sz, size_t max) -{ - auto len = wcsnlen(sz, max); - fail_fast_assert(sz[len] == 0); return{ sz, len }; -} - -template -basic_string_view ensure_z(T(&sz)[N]) { return ensure_z(&sz[0], N); } - -template -basic_string_view::type, dynamic_range> ensure_z(Cont& cont) -{ - return ensure_z(cont.data(), cont.length()); -} - -// -// to_string() allow (explicit) conversions from string_view to string -// -template -std::basic_string::type> to_string(basic_string_view view) -{ - return{ view.data(), view.length() }; -} - - -template -class basic_zstring_builder -{ -public: - using string_view_type = basic_string_view; - using value_type = CharT; - using pointer = CharT*; - using size_type = typename string_view_type::size_type; - using iterator = typename string_view_type::iterator; - - basic_zstring_builder(CharT* data, size_type length) : sv_(data, length) {} - - template - basic_zstring_builder(CharT(&arr)[Size]) : sv_(arr) {} - - pointer data() const { return sv_.data(); } - string_view_type view() const { return sv_; } - - size_type length() const { return sv_.length(); } - - pointer assume0() const { return data(); } - string_view_type ensure_z() const { return gsl::ensure_z(sv_); } - - iterator begin() const { return sv_.begin(); } - iterator end() const { return sv_.end(); } - -private: - string_view_type sv_; -}; - -template -using zstring_builder = basic_zstring_builder; - -template -using wzstring_builder = basic_zstring_builder; -} - -#endif // GSL_STRING_VIEW_H diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 5e4c395..5529cda 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -14,14 +14,15 @@ add_definitions(-DGSL_THROWS_FOR_TESTING) if(MSVC14 OR MSVC12) # has the support we need # remove unnecessary warnings about unchecked iterators add_definitions(-D_SCL_SECURE_NO_WARNINGS) + add_compile_options(/W4) else() include(CheckCXXCompilerFlag) CHECK_CXX_COMPILER_FLAG("-std=c++14" COMPILER_SUPPORTS_CXX14) CHECK_CXX_COMPILER_FLAG("-std=c++11" COMPILER_SUPPORTS_CXX11) if(COMPILER_SUPPORTS_CXX14) - set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++14") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++14 -Wall -Wno-missing-braces") elseif(COMPILER_SUPPORTS_CXX11) - set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -Wall -Wno-missing-braces") else() message(STATUS "The compiler ${CMAKE_CXX_COMPILER} has no C++11 support. Please use a different C++ compiler.") endif() @@ -43,8 +44,8 @@ function(add_gsl_test name) ) endfunction() -add_gsl_test(array_view_tests) -add_gsl_test(string_view_tests) +add_gsl_test(span_tests) +add_gsl_test(string_span_tests) add_gsl_test(at_tests) add_gsl_test(bounds_tests) add_gsl_test(notnull_tests) diff --git a/tests/bounds_tests.cpp b/tests/bounds_tests.cpp index c3f549f..0665260 100644 --- a/tests/bounds_tests.cpp +++ b/tests/bounds_tests.cpp @@ -15,7 +15,7 @@ /////////////////////////////////////////////////////////////////////////////// #include -#include +#include #include using namespace std; @@ -23,16 +23,18 @@ using namespace gsl;; namespace { - void use(unsigned int&) {} + void use(std::ptrdiff_t&) {} } SUITE(bounds_test) { TEST(basic_bounds) { - for (auto point : static_bounds { 2 }) + for (auto point : static_bounds { 2 }) { - for (unsigned int j = 0; j < decltype(point)::rank; j++) + for (decltype(point)::size_type j = 0; + j < static_cast(decltype(point)::rank); + j++) { use(j); use(point[j]); @@ -42,24 +44,25 @@ SUITE(bounds_test) TEST(bounds_basic) { - static_bounds b; + static_bounds<3, 4, 5> b; auto a = b.slice(); - static_bounds x{ 4 }; + (void)a; + static_bounds<4, dynamic_range, 2> x{ 4 }; x.slice().slice(); } TEST (arrayview_iterator) { - static_bounds bounds{ 3 }; + static_bounds<4, dynamic_range, 2> bounds{ 3 }; auto itr = bounds.begin(); - + (void)itr; #ifdef CONFIRM_COMPILATION_ERRORS - array_view< int, 4, dynamic_range, 2> av(nullptr, bounds); + span av(nullptr, bounds); auto itr2 = av.cbegin(); - for (auto & v : av) { + for (auto& v : av) { v = 4; } fill(av.begin(), av.end(), 0); @@ -68,24 +71,25 @@ SUITE(bounds_test) TEST (bounds_convertible) { - static_bounds b1; - static_bounds b2 = b1; - + static_bounds<7, 4, 2> b1; + static_bounds<7, dynamic_range, 2> b2 = b1; + (void)b2; #ifdef CONFIRM_COMPILATION_ERRORS - static_bounds b4 = b2; + static_bounds<7, dynamic_range, 1> b4 = b2; #endif - static_bounds b3 = b1; - static_bounds b4 = b3; + static_bounds b3 = b1; + static_bounds<7, 4, 2> b4 = b3; + (void)b4; - static_bounds b11; + static_bounds b11; - static_bounds b5; - static_bounds b6; + static_bounds b5; + static_bounds<34> b6; - b5 = static_bounds(); + b5 = static_bounds<20>(); CHECK_THROW(b6 = b5, fail_fast); - b5 = static_bounds(); + b5 = static_bounds<34>(); b6 = b5; CHECK(b5 == b6); diff --git a/tests/notnull_tests.cpp b/tests/notnull_tests.cpp index a9624b8..67b478a 100644 --- a/tests/notnull_tests.cpp +++ b/tests/notnull_tests.cpp @@ -69,7 +69,8 @@ SUITE(NotNullTests) MyDerived derived; Unrelated unrelated; not_null u = &unrelated; - not_null p = &derived; + (void)u; + not_null p = &derived; not_null q = &base; q = p; // allowed with heterogeneous copy ctor CHECK(q == p); diff --git a/tests/array_view_tests.cpp b/tests/span_tests.cpp similarity index 52% rename from tests/array_view_tests.cpp rename to tests/span_tests.cpp index 3a8acc2..6a67b02 100644 --- a/tests/array_view_tests.cpp +++ b/tests/span_tests.cpp @@ -15,7 +15,7 @@ /////////////////////////////////////////////////////////////////////////////// #include -#include +#include #include #include @@ -27,16 +27,15 @@ using namespace gsl; namespace { - void use(int&) {} struct BaseClass {}; struct DerivedClass : BaseClass {}; } -SUITE(array_view_tests) +SUITE(span_tests) { TEST(basics) { - auto ptr = as_array_view(new int[10], 10); + auto ptr = as_span(new int[10], 10); fill(ptr.begin(), ptr.end(), 99); for (int num : ptr) { @@ -46,48 +45,49 @@ SUITE(array_view_tests) delete[] ptr.data(); - static_bounds bounds{ 3 }; + static_bounds<4, dynamic_range, 2> bounds{ 3 }; #ifdef CONFIRM_COMPILATION_ERRORS - array_view av(nullptr, bounds); + span av(nullptr, bounds); av.extent(); av.extent<2>(); av[8][4][3]; #endif } - TEST (array_view_convertible) + TEST (span_convertible) { #ifdef CONFIRM_COMPILATION_ERRORS - array_view av1(nullptr, b1); + span av1(nullptr, b1); #endif - auto f = [&]() { array_view av1(nullptr); }; + auto f = [&]() { span av1(nullptr); }; CHECK_THROW(f(), fail_fast); - array_view av1(nullptr); + span av1(nullptr); #ifdef CONFIRM_COMPILATION_ERRORS static_bounds b12(b11); b12 = b11; b11 = b12; - array_view av1 = nullptr; - array_view av2(av1); - array_view av2(av1); + span av1 = nullptr; + span av2(av1); + span av2(av1); #endif - array_view avd; + span avd; #ifdef CONFIRM_COMPILATION_ERRORS - array_view avb = avd; + span avb = avd; #endif - array_view avcd = avd; + span avcd = avd; + (void)avcd; } TEST(boundary_checks) { int arr[10][2]; - auto av = as_array_view(arr); + auto av = as_span(arr); fill(begin(av), end(av), 0); @@ -102,32 +102,32 @@ SUITE(array_view_tests) CHECK_THROW((av[{10,2}]), fail_fast); } - void overloaded_func(array_view exp, int expected_value) { + void overloaded_func(span exp, int expected_value) { for (auto val : exp) { CHECK(val == expected_value); } } - void overloaded_func(array_view exp, char expected_value) { + void overloaded_func(span exp, char expected_value) { for (auto val : exp) { CHECK(val == expected_value); } } - void fixed_func(array_view exp, int expected_value) { + void fixed_func(span exp, int expected_value) { for (auto val : exp) { CHECK(val == expected_value); } } - TEST(array_view_parameter_test) + TEST(span_parameter_test) { auto data = new int[4][3][5]; - auto av = as_array_view(data, 4); + auto av = as_span(data, 4); CHECK(av.size() == 60); @@ -138,7 +138,7 @@ SUITE(array_view_tests) CHECK(count == 34 * 60); overloaded_func(av, 34); - overloaded_func(av.as_array_view(dim<>(4), dim<>(3), dim<>(5)), 34); + overloaded_func(av.as_span(dim<>(4), dim<>(3), dim<>(5)), 34); //fixed_func(av, 34); delete[] data; @@ -147,20 +147,20 @@ SUITE(array_view_tests) TEST(md_access) { - unsigned int width = 5, height = 20; + auto width = 5, height = 20; - unsigned int imgSize = width * height; + auto imgSize = width * height; auto image_ptr = new int[imgSize][3]; // size check will be done - auto image_view = as_array_view(image_ptr, imgSize).as_array_view(dim<>(height), dim<>(width), dim<3>()); + auto image_view = as_span(image_ptr, imgSize).as_span(dim<>(height), dim<>(width), dim<3>()); iota(image_view.begin(), image_view.end(), 1); int expected = 0; - for (unsigned int i = 0; i < height; i++) + for (auto i = 0; i < height; i++) { - for (unsigned int j = 0; j < width; j++) + for (auto j = 0; j < width; j++) { CHECK(expected + 1 == image_view[i][j][0]); CHECK(expected + 2 == image_view[i][j][1]); @@ -178,12 +178,12 @@ SUITE(array_view_tests) } } - TEST(array_view_factory_test) + TEST(span_factory_test) { { int * arr = new int[150]; - auto av = as_array_view(arr, dim<10>(), dim<>(3), dim<5>()); + auto av = as_span(arr, dim<10>(), dim<>(3), dim<5>()); fill(av.begin(), av.end(), 24); overloaded_func(av, 24); @@ -192,152 +192,158 @@ SUITE(array_view_tests) array stdarr{ 0 }; - auto av2 = as_array_view(stdarr); - overloaded_func(av2.as_array_view(dim<>(1), dim<3>(), dim<5>()), 0); + auto av2 = as_span(stdarr); + overloaded_func(av2.as_span(dim<>(1), dim<3>(), dim<5>()), 0); string str = "ttttttttttttttt"; // size = 15 auto t = str.data(); - auto av3 = as_array_view(str); - overloaded_func(av3.as_array_view(dim<>(1), dim<3>(), dim<5>()), 't'); + (void)t; + auto av3 = as_span(str); + overloaded_func(av3.as_span(dim<>(1), dim<3>(), dim<5>()), 't'); } { int a[3][4][5]; - auto av = as_array_view(a); + auto av = as_span(a); const int (*b)[4][5]; b = a; - auto bv = as_array_view(b, 3); + auto bv = as_span(b, 3); CHECK(av == bv); const std::array arr = {0.0, 0.0, 0.0}; - auto cv = as_array_view(arr); + auto cv = as_span(arr); + (void)cv; vector vec(3); - auto dv = as_array_view(vec); + auto dv = as_span(vec); + (void)dv; #ifdef CONFIRM_COMPILATION_ERRORS - auto dv2 = as_array_view(std::move(vec)); + auto dv2 = as_span(std::move(vec)); #endif } } - - TEST (array_view_reshape_test) + + template void fn(const Bounds&) { static_assert(Bounds::static_size == 60, "static bounds is wrong size"); } + TEST (span_reshape_test) { int a[3][4][5]; - auto av = as_array_view(a); - auto av2 = av.as_array_view(dim<60>()); - auto av3 = av2.as_array_view(dim<3>(), dim<4>(), dim<5>()); - auto av4 = av3.as_array_view(dim<4>(), dim<>(3), dim<5>()); - auto av5 = av4.as_array_view(dim<3>(), dim<4>(), dim<5>()); - auto av6 = av5.as_array_view(dim<12>(), dim<>(5)); + auto av = as_span(a); + fn(av.bounds()); + auto av2 = av.as_span(dim<60>()); + auto av3 = av2.as_span(dim<3>(), dim<4>(), dim<5>()); + auto av4 = av3.as_span(dim<4>(), dim<>(3), dim<5>()); + auto av5 = av4.as_span(dim<3>(), dim<4>(), dim<5>()); + auto av6 = av5.as_span(dim<12>(), dim<>(5)); fill(av6.begin(), av6.end(), 1); auto av7 = av6.as_bytes(); - auto av8 = av7.as_array_view(); + auto av8 = av7.as_span(); CHECK(av8.size() == av6.size()); - for (size_t i = 0; i < av8.size(); i++) + for (auto i = 0; i < av8.size(); i++) { CHECK(av8[i] == 1); } #ifdef CONFIRM_COMPILATION_ERRORS struct Foo {char c[11];}; - auto av9 = av7.as_array_view(); + auto av9 = av7.as_span(); #endif } - TEST (array_view_section_test) + TEST (span_section_test) { int a[30][4][5]; - auto av = as_array_view(a); + auto av = as_span(a); auto sub = av.section({15, 0, 0}, gsl::index<3>{2, 2, 2}); auto subsub = sub.section({1, 0, 0}, gsl::index<3>{1, 1, 1}); + (void)subsub; } - TEST(array_view_section) + TEST(span_section) { std::vector data(5 * 10); std::iota(begin(data), end(data), 0); - const array_view av = as_array_view(data).as_array_view(dim<5>(), dim<10>()); + const span av = as_span(data).as_span(dim<5>(), dim<10>()); - strided_array_view av_section_1 = av.section({ 1, 2 }, { 3, 4 }); + strided_span av_section_1 = av.section({ 1, 2 }, { 3, 4 }); CHECK((av_section_1[{0, 0}] == 12)); CHECK((av_section_1[{0, 1}] == 13)); CHECK((av_section_1[{1, 0}] == 22)); CHECK((av_section_1[{2, 3}] == 35)); - strided_array_view av_section_2 = av_section_1.section({ 1, 2 }, { 2,2 }); + strided_span av_section_2 = av_section_1.section({ 1, 2 }, { 2,2 }); CHECK((av_section_2[{0, 0}] == 24)); CHECK((av_section_2[{0, 1}] == 25)); CHECK((av_section_2[{1, 0}] == 34)); } - TEST(strided_array_view_constructors) + TEST(strided_span_constructors) { // Check stride constructor { int arr[] = { 1, 2, 3, 4, 5, 6, 7, 8, 9 }; const int carr[] = { 1, 2, 3, 4, 5, 6, 7, 8, 9 }; - strided_array_view sav1{ arr, {{9}, {1}} }; // T -> T + strided_span sav1{ arr, {{9}, {1}} }; // T -> T CHECK(sav1.bounds().index_bounds() == index<1>{ 9 }); CHECK(sav1.bounds().stride() == 1); CHECK(sav1[0] == 1 && sav1[8] == 9); - strided_array_view sav2{ carr, {{ 4 }, { 2 }} }; // const T -> const T + strided_span sav2{ carr, {{ 4 }, { 2 }} }; // const T -> const T CHECK(sav2.bounds().index_bounds() == index<1>{ 4 }); CHECK(sav2.bounds().strides() == index<1>{2}); CHECK(sav2[0] == 1 && sav2[3] == 7); - strided_array_view sav3{ arr, {{ 2, 2 },{ 6, 2 }} }; // T -> const T + strided_span sav3{ arr, {{ 2, 2 },{ 6, 2 }} }; // T -> const T CHECK((sav3.bounds().index_bounds() == index<2>{ 2, 2 })); CHECK((sav3.bounds().strides() == index<2>{ 6, 2 })); CHECK((sav3[{0, 0}] == 1 && sav3[{0, 1}] == 3 && sav3[{1, 0}] == 7)); } - // Check array_view constructor + // Check span constructor { int arr[] = { 1, 2 }; // From non-cv-qualified source { - const array_view src{ arr }; + const span src = arr; - strided_array_view sav{ src, {2, 1} }; + strided_span sav{ src, {2, 1} }; CHECK(sav.bounds().index_bounds() == index<1>{ 2 }); CHECK(sav.bounds().strides() == index<1>{ 1 }); CHECK(sav[1] == 2); #if _MSC_VER > 1800 - strided_array_view sav_c{ {src}, {2, 1} }; + strided_span sav_c{ {src}, {2, 1} }; #else - strided_array_view sav_c{ array_view{src}, strided_bounds<1>{2, 1} }; + strided_span sav_c{ span{src}, strided_bounds<1>{2, 1} }; #endif CHECK(sav_c.bounds().index_bounds() == index<1>{ 2 }); CHECK(sav_c.bounds().strides() == index<1>{ 1 }); CHECK(sav_c[1] == 2); #if _MSC_VER > 1800 - strided_array_view sav_v{ {src}, {2, 1} }; + strided_span sav_v{ {src}, {2, 1} }; #else - strided_array_view sav_v{ array_view{src}, strided_bounds<1>{2, 1} }; + strided_span sav_v{ span{src}, strided_bounds<1>{2, 1} }; #endif CHECK(sav_v.bounds().index_bounds() == index<1>{ 2 }); CHECK(sav_v.bounds().strides() == index<1>{ 1 }); CHECK(sav_v[1] == 2); #if _MSC_VER > 1800 - strided_array_view sav_cv{ {src}, {2, 1} }; + strided_span sav_cv{ {src}, {2, 1} }; #else - strided_array_view sav_cv{ array_view{src}, strided_bounds<1>{2, 1} }; + strided_span sav_cv{ span{src}, strided_bounds<1>{2, 1} }; #endif CHECK(sav_cv.bounds().index_bounds() == index<1>{ 2 }); CHECK(sav_cv.bounds().strides() == index<1>{ 1 }); @@ -346,17 +352,17 @@ SUITE(array_view_tests) // From const-qualified source { - const array_view src{ arr }; + const span src{ arr }; - strided_array_view sav_c{ src, {2, 1} }; + strided_span sav_c{ src, {2, 1} }; CHECK(sav_c.bounds().index_bounds() == index<1>{ 2 }); CHECK(sav_c.bounds().strides() == index<1>{ 1 }); CHECK(sav_c[1] == 2); #if _MSC_VER > 1800 - strided_array_view sav_cv{ {src}, {2, 1} }; + strided_span sav_cv{ {src}, {2, 1} }; #else - strided_array_view sav_cv{ array_view{src}, strided_bounds<1>{2, 1} }; + strided_span sav_cv{ span{src}, strided_bounds<1>{2, 1} }; #endif CHECK(sav_cv.bounds().index_bounds() == index<1>{ 2 }); @@ -366,17 +372,17 @@ SUITE(array_view_tests) // From volatile-qualified source { - const array_view src{ arr }; + const span src{ arr }; - strided_array_view sav_v{ src, {2, 1} }; + strided_span sav_v{ src, {2, 1} }; CHECK(sav_v.bounds().index_bounds() == index<1>{ 2 }); CHECK(sav_v.bounds().strides() == index<1>{ 1 }); CHECK(sav_v[1] == 2); #if _MSC_VER > 1800 - strided_array_view sav_cv{ {src}, {2, 1} }; + strided_span sav_cv{ {src}, {2, 1} }; #else - strided_array_view sav_cv{ array_view{src}, strided_bounds<1>{2, 1} }; + strided_span sav_cv{ span{src}, strided_bounds<1>{2, 1} }; #endif CHECK(sav_cv.bounds().index_bounds() == index<1>{ 2 }); CHECK(sav_cv.bounds().strides() == index<1>{ 1 }); @@ -385,9 +391,9 @@ SUITE(array_view_tests) // From cv-qualified source { - const array_view src{ arr }; + const span src{ arr }; - strided_array_view sav_cv{ src, {2, 1} }; + strided_span sav_cv{ src, {2, 1} }; CHECK(sav_cv.bounds().index_bounds() == index<1>{ 2 }); CHECK(sav_cv.bounds().strides() == index<1>{ 1 }); CHECK(sav_cv[1] == 2); @@ -398,34 +404,34 @@ SUITE(array_view_tests) { int arr[2] = { 4, 5 }; - const array_view av(arr, 2); - array_view av2{ av }; + const span av(arr, 2); + span av2{ av }; CHECK(av2[1] == 5); - static_assert(std::is_convertible, array_view>::value, "ctor is not implicit!"); + static_assert(std::is_convertible, span>::value, "ctor is not implicit!"); - const strided_array_view src{ arr, {2, 1} }; - strided_array_view sav{ src }; + const strided_span src{ arr, {2, 1} }; + strided_span sav{ src }; CHECK(sav.bounds().index_bounds() == index<1>{ 2 }); CHECK(sav.bounds().stride() == 1); CHECK(sav[1] == 5); - static_assert(std::is_convertible, strided_array_view>::value, "ctor is not implicit!"); + static_assert(std::is_convertible, strided_span>::value, "ctor is not implicit!"); } // Check copy constructor { int arr1[2] = { 3, 4 }; - const strided_array_view src1{ arr1, {2, 1} }; - strided_array_view sav1{ src1 }; + const strided_span src1{ arr1, {2, 1} }; + strided_span sav1{ src1 }; CHECK(sav1.bounds().index_bounds() == index<1>{ 2 }); CHECK(sav1.bounds().stride() == 1); CHECK(sav1[0] == 3); int arr2[6] = { 1, 2, 3, 4, 5, 6 }; - const strided_array_view src2{ arr2, {{ 3, 2 }, { 2, 1 }} }; - strided_array_view sav2{ src2 }; + const strided_span src2{ arr2, {{ 3, 2 }, { 2, 1 }} }; + strided_span sav2{ src2 }; CHECK((sav2.bounds().index_bounds() == index<2>{ 3, 2 })); CHECK((sav2.bounds().strides() == index<2>{ 2, 1 })); CHECK((sav2[{0, 0}] == 1 && sav2[{2, 0}] == 5)); @@ -436,9 +442,9 @@ SUITE(array_view_tests) int arr1[2] = { 1, 2 }; int arr2[6] = { 3, 4, 5, 6, 7, 8 }; - const strided_array_view src{ arr1, {{2}, {1}} }; - strided_array_view sav{ arr2, {{3}, {2}} }; - strided_array_view& sav_ref = (sav = src); + const strided_span src{ arr1, {{2}, {1}} }; + strided_span sav{ arr2, {{3}, {2}} }; + strided_span& sav_ref = (sav = src); CHECK(sav.bounds().index_bounds() == index<1>{ 2 }); CHECK(sav.bounds().strides() == index<1>{ 1 }); CHECK(sav[0] == 1); @@ -449,9 +455,9 @@ SUITE(array_view_tests) { int arr1[2] = { 3, 4 }; int arr1b[1] = { 0 }; - const strided_array_view src1{ arr1, {2, 1} }; - strided_array_view sav1{ arr1b, {1, 1} }; - strided_array_view& sav1_ref = (sav1 = src1); + const strided_span src1{ arr1, {2, 1} }; + strided_span sav1{ arr1b, {1, 1} }; + strided_span& sav1_ref = (sav1 = src1); CHECK(sav1.bounds().index_bounds() == index<1>{ 2 }); CHECK(sav1.bounds().strides() == index<1>{ 1 }); CHECK(sav1[0] == 3); @@ -459,9 +465,9 @@ SUITE(array_view_tests) const int arr2[6] = { 1, 2, 3, 4, 5, 6 }; const int arr2b[1] = { 0 }; - const strided_array_view src2{ arr2, {{ 3, 2 },{ 2, 1 }} }; - strided_array_view sav2{ arr2b, {{ 1, 1 },{ 1, 1 }} }; - strided_array_view& sav2_ref = (sav2 = src2); + const strided_span src2{ arr2, {{ 3, 2 },{ 2, 1 }} }; + strided_span sav2{ arr2b, {{ 1, 1 },{ 1, 1 }} }; + strided_span& sav2_ref = (sav2 = src2); CHECK((sav2.bounds().index_bounds() == index<2>{ 3, 2 })); CHECK((sav2.bounds().strides() == index<2>{ 2, 1 })); CHECK((sav2[{0, 0}] == 1 && sav2[{2, 0}] == 5)); @@ -469,23 +475,23 @@ SUITE(array_view_tests) } } - TEST(strided_array_view_slice) + TEST(strided_span_slice) { std::vector data(5 * 10); std::iota(begin(data), end(data), 0); - const array_view src = as_array_view(data).as_array_view(dim<5>(), dim<10>()); + const span src = as_span(data).as_span(dim<5>(), dim<10>()); - const strided_array_view sav{ src, {{5, 10}, {10, 1}} }; + const strided_span sav{ src, {{5, 10}, {10, 1}} }; #ifdef CONFIRM_COMPILATION_ERRORS - const strided_array_view csav{ {src},{ { 5, 10 },{ 10, 1 } } }; + const strided_span csav{ {src},{ { 5, 10 },{ 10, 1 } } }; #endif - const strided_array_view csav{ array_view{ src }, { { 5, 10 },{ 10, 1 } } }; + const strided_span csav{ span{ src }, { { 5, 10 },{ 10, 1 } } }; - strided_array_view sav_sl = sav[2]; + strided_span sav_sl = sav[2]; CHECK(sav_sl[0] == 20); CHECK(sav_sl[9] == 29); - strided_array_view csav_sl = sav[3]; + strided_span csav_sl = sav[3]; CHECK(csav_sl[0] == 30); CHECK(csav_sl[9] == 39); @@ -493,9 +499,9 @@ SUITE(array_view_tests) CHECK(sav[4][9] == 49); } - TEST(strided_array_view_column_major) + TEST(strided_span_column_major) { - // strided_array_view may be used to accomodate more peculiar + // strided_span may be used to accomodate more peculiar // use cases, such as column-major multidimensional array // (aka. "FORTRAN" layout). @@ -504,7 +510,7 @@ SUITE(array_view_tests) 2, 5, 8, 11, 14, 3, 6, 9, 12, 15 }; - strided_array_view cm_sav{ cm_array, {{ 5, 3 },{ 1, 5 }} }; + strided_span cm_sav{ cm_array, {{ 5, 3 },{ 1, 5 }} }; // Accessing elements CHECK((cm_sav[{0, 0}] == 1)); @@ -513,14 +519,14 @@ SUITE(array_view_tests) CHECK((cm_sav[{4, 2}] == 15)); // Slice - strided_array_view cm_sl = cm_sav[3]; + strided_span cm_sl = cm_sav[3]; CHECK(cm_sl[0] == 10); CHECK(cm_sl[1] == 11); CHECK(cm_sl[2] == 12); // Section - strided_array_view cm_sec = cm_sav.section( { 2, 1 }, { 3, 2 }); + strided_span cm_sec = cm_sav.section( { 2, 1 }, { 3, 2 }); CHECK((cm_sec.bounds().index_bounds() == index<2>{3, 2})); CHECK((cm_sec[{0, 0}] == 8)); @@ -529,10 +535,10 @@ SUITE(array_view_tests) CHECK((cm_sec[{2, 1}] == 15)); } - TEST(strided_array_view_bounds) + TEST(strided_span_bounds) { int arr[] = { 0, 1, 2, 3 }; - array_view av(arr); + span av(arr); { // incorrect sections @@ -550,7 +556,7 @@ SUITE(array_view_tests) { // zero stride - strided_array_view sav{ av,{ { 4 },{} } }; + strided_span sav{ av,{ { 4 },{} } }; CHECK(sav[0] == 0); CHECK(sav[3] == 0); CHECK_THROW(sav[4], fail_fast); @@ -558,19 +564,19 @@ SUITE(array_view_tests) { // zero extent - strided_array_view sav{ av,{ {},{ 1 } } }; + strided_span sav{ av,{ {},{ 1 } } }; CHECK_THROW(sav[0], fail_fast); } { // zero extent and stride - strided_array_view sav{ av,{ {},{} } }; + strided_span sav{ av,{ {},{} } }; CHECK_THROW(sav[0], fail_fast); } { // strided array ctor with matching strided bounds - strided_array_view sav{ arr,{ 4, 1 } }; + strided_span sav{ arr,{ 4, 1 } }; CHECK(sav.bounds().index_bounds() == index<1>{ 4 }); CHECK(sav[3] == 3); CHECK_THROW(sav[4], fail_fast); @@ -578,7 +584,7 @@ SUITE(array_view_tests) { // strided array ctor with smaller strided bounds - strided_array_view sav{ arr,{ 2, 1 } }; + strided_span sav{ arr,{ 2, 1 } }; CHECK(sav.bounds().index_bounds() == index<1>{ 2 }); CHECK(sav[1] == 1); CHECK_THROW(sav[2], fail_fast); @@ -586,7 +592,7 @@ SUITE(array_view_tests) { // strided array ctor with fitting irregular bounds - strided_array_view sav{ arr,{ 2, 3 } }; + strided_span sav{ arr,{ 2, 3 } }; CHECK(sav.bounds().index_bounds() == index<1>{ 2 }); CHECK(sav[0] == 0); CHECK(sav[1] == 3); @@ -595,92 +601,92 @@ SUITE(array_view_tests) { // bounds cross data boundaries - from static arrays - CHECK_THROW((strided_array_view { arr, { 3, 2 } }), fail_fast); - CHECK_THROW((strided_array_view { arr, { 3, 3 } }), fail_fast); - CHECK_THROW((strided_array_view { arr, { 4, 5 } }), fail_fast); - CHECK_THROW((strided_array_view { arr, { 5, 1 } }), fail_fast); - CHECK_THROW((strided_array_view { arr, { 5, 5 } }), fail_fast); + CHECK_THROW((strided_span { arr, { 3, 2 } }), fail_fast); + CHECK_THROW((strided_span { arr, { 3, 3 } }), fail_fast); + CHECK_THROW((strided_span { arr, { 4, 5 } }), fail_fast); + CHECK_THROW((strided_span { arr, { 5, 1 } }), fail_fast); + CHECK_THROW((strided_span { arr, { 5, 5 } }), fail_fast); } { // bounds cross data boundaries - from array view - CHECK_THROW((strided_array_view { av, { 3, 2 } }), fail_fast); - CHECK_THROW((strided_array_view { av, { 3, 3 } }), fail_fast); - CHECK_THROW((strided_array_view { av, { 4, 5 } }), fail_fast); - CHECK_THROW((strided_array_view { av, { 5, 1 } }), fail_fast); - CHECK_THROW((strided_array_view { av, { 5, 5 } }), fail_fast); + CHECK_THROW((strided_span { av, { 3, 2 } }), fail_fast); + CHECK_THROW((strided_span { av, { 3, 3 } }), fail_fast); + CHECK_THROW((strided_span { av, { 4, 5 } }), fail_fast); + CHECK_THROW((strided_span { av, { 5, 1 } }), fail_fast); + CHECK_THROW((strided_span { av, { 5, 5 } }), fail_fast); } { // bounds cross data boundaries - from dynamic arrays - CHECK_THROW((strided_array_view { av.data(), 4, { 3, 2 } }), fail_fast); - CHECK_THROW((strided_array_view { av.data(), 4, { 3, 3 } }), fail_fast); - CHECK_THROW((strided_array_view { av.data(), 4, { 4, 5 } }), fail_fast); - CHECK_THROW((strided_array_view { av.data(), 4, { 5, 1 } }), fail_fast); - CHECK_THROW((strided_array_view { av.data(), 4, { 5, 5 } }), fail_fast); - CHECK_THROW((strided_array_view { av.data(), 2, { 2, 2 } }), fail_fast); + CHECK_THROW((strided_span { av.data(), 4, { 3, 2 } }), fail_fast); + CHECK_THROW((strided_span { av.data(), 4, { 3, 3 } }), fail_fast); + CHECK_THROW((strided_span { av.data(), 4, { 4, 5 } }), fail_fast); + CHECK_THROW((strided_span { av.data(), 4, { 5, 1 } }), fail_fast); + CHECK_THROW((strided_span { av.data(), 4, { 5, 5 } }), fail_fast); + CHECK_THROW((strided_span { av.data(), 2, { 2, 2 } }), fail_fast); } #ifdef CONFIRM_COMPILATION_ERRORS { - strided_array_view sav0{ av.data(), { 3, 2 } }; - strided_array_view sav1{ arr, { 1 } }; - strided_array_view sav2{ arr, { 1,1,1 } }; - strided_array_view sav3{ av, { 1 } }; - strided_array_view sav4{ av, { 1,1,1 } }; - strided_array_view sav5{ av.as_array_view(dim<2>(), dim<2>()), { 1 } }; - strided_array_view sav6{ av.as_array_view(dim<2>(), dim<2>()), { 1,1,1 } }; - strided_array_view sav7{ av.as_array_view(dim<2>(), dim<2>()), { { 1,1 },{ 1,1 },{ 1,1 } } }; + strided_span sav0{ av.data(), { 3, 2 } }; + strided_span sav1{ arr, { 1 } }; + strided_span sav2{ arr, { 1,1,1 } }; + strided_span sav3{ av, { 1 } }; + strided_span sav4{ av, { 1,1,1 } }; + strided_span sav5{ av.as_span(dim<2>(), dim<2>()), { 1 } }; + strided_span sav6{ av.as_span(dim<2>(), dim<2>()), { 1,1,1 } }; + strided_span sav7{ av.as_span(dim<2>(), dim<2>()), { { 1,1 },{ 1,1 },{ 1,1 } } }; index<1> index{ 0, 1 }; - strided_array_view sav8{ arr,{ 1,{ 1,1 } } }; - strided_array_view sav9{ arr,{ { 1,1 },{ 1,1 } } }; - strided_array_view sav10{ av,{ 1,{ 1,1 } } }; - strided_array_view sav11{ av,{ { 1,1 },{ 1,1 } } }; - strided_array_view sav12{ av.as_array_view(dim<2>(), dim<2>()),{ { 1 },{ 1 } } }; - strided_array_view sav13{ av.as_array_view(dim<2>(), dim<2>()),{ { 1 },{ 1,1,1 } } }; - strided_array_view sav14{ av.as_array_view(dim<2>(), dim<2>()),{ { 1,1,1 },{ 1 } } }; + strided_span sav8{ arr,{ 1,{ 1,1 } } }; + strided_span sav9{ arr,{ { 1,1 },{ 1,1 } } }; + strided_span sav10{ av,{ 1,{ 1,1 } } }; + strided_span sav11{ av,{ { 1,1 },{ 1,1 } } }; + strided_span sav12{ av.as_span(dim<2>(), dim<2>()),{ { 1 },{ 1 } } }; + strided_span sav13{ av.as_span(dim<2>(), dim<2>()),{ { 1 },{ 1,1,1 } } }; + strided_span sav14{ av.as_span(dim<2>(), dim<2>()),{ { 1,1,1 },{ 1 } } }; } #endif } - TEST(strided_array_view_type_conversion) + TEST(strided_span_type_conversion) { int arr[] = { 0, 1, 2, 3 }; - array_view av(arr); + span av(arr); { - strided_array_view sav{ av.data(), av.size(), { av.size() / 2, 2 } }; + strided_span sav{ av.data(), av.size(), { av.size() / 2, 2 } }; #ifdef CONFIRM_COMPILATION_ERRORS - strided_array_view lsav1 = sav.as_strided_array_view(); + strided_span lsav1 = sav.as_strided_span(); #endif } { - strided_array_view sav{ av, { av.size() / 2, 2 } }; + strided_span sav{ av, { av.size() / 2, 2 } }; #ifdef CONFIRM_COMPILATION_ERRORS - strided_array_view lsav1 = sav.as_strided_array_view(); + strided_span lsav1 = sav.as_strided_span(); #endif } - array_view bytes = av.as_bytes(); + span bytes = av.as_bytes(); // retype strided array with regular strides - from raw data { strided_bounds<2> bounds{ { 2, bytes.size() / 4 }, { bytes.size() / 2, 1 } }; - strided_array_view sav2{ bytes.data(), bytes.size(), bounds }; - strided_array_view sav3 = sav2.as_strided_array_view(); + strided_span sav2{ bytes.data(), bytes.size(), bounds }; + strided_span sav3 = sav2.as_strided_span(); CHECK(sav3[0][0] == 0); CHECK(sav3[1][0] == 2); CHECK_THROW(sav3[1][1], fail_fast); CHECK_THROW(sav3[0][1], fail_fast); } - // retype strided array with regular strides - from array_view + // retype strided array with regular strides - from span { strided_bounds<2> bounds{ { 2, bytes.size() / 4 }, { bytes.size() / 2, 1 } }; - array_view bytes2 = bytes.as_array_view(dim<2>(), dim<>(bytes.size() / 2)); - strided_array_view sav2{ bytes2, bounds }; - strided_array_view sav3 = sav2.as_strided_array_view(); + span bytes2 = bytes.as_span(dim<2>(), dim<>(bytes.size() / 2)); + strided_span sav2{ bytes2, bounds }; + strided_span sav3 = sav2.as_strided_span(); CHECK(sav3[0][0] == 0); CHECK(sav3[1][0] == 2); CHECK_THROW(sav3[1][1], fail_fast); @@ -690,47 +696,47 @@ SUITE(array_view_tests) // retype strided array with not enough elements - last dimension of the array is too small { strided_bounds<2> bounds{ { 4,2 },{ 4, 1 } }; - array_view bytes2 = bytes.as_array_view(dim<2>(), dim<>(bytes.size() / 2)); - strided_array_view sav2{ bytes2, bounds }; - CHECK_THROW(sav2.as_strided_array_view(), fail_fast); + span bytes2 = bytes.as_span(dim<2>(), dim<>(bytes.size() / 2)); + strided_span sav2{ bytes2, bounds }; + CHECK_THROW(sav2.as_strided_span(), fail_fast); } // retype strided array with not enough elements - strides are too small { strided_bounds<2> bounds{ { 4,2 },{ 2, 1 } }; - array_view bytes2 = bytes.as_array_view(dim<2>(), dim<>(bytes.size() / 2)); - strided_array_view sav2{ bytes2, bounds }; - CHECK_THROW(sav2.as_strided_array_view(), fail_fast); + span bytes2 = bytes.as_span(dim<2>(), dim<>(bytes.size() / 2)); + strided_span sav2{ bytes2, bounds }; + CHECK_THROW(sav2.as_strided_span(), fail_fast); } // retype strided array with not enough elements - last dimension does not divide by the new typesize { strided_bounds<2> bounds{ { 2,6 },{ 4, 1 } }; - array_view bytes2 = bytes.as_array_view(dim<2>(), dim<>(bytes.size() / 2)); - strided_array_view sav2{ bytes2, bounds }; - CHECK_THROW(sav2.as_strided_array_view(), fail_fast); + span bytes2 = bytes.as_span(dim<2>(), dim<>(bytes.size() / 2)); + strided_span sav2{ bytes2, bounds }; + CHECK_THROW(sav2.as_strided_span(), fail_fast); } // retype strided array with not enough elements - strides does not divide by the new typesize { strided_bounds<2> bounds{ { 2, 1 },{ 6, 1 } }; - array_view bytes2 = bytes.as_array_view(dim<2>(), dim<>(bytes.size() / 2)); - strided_array_view sav2{ bytes2, bounds }; - CHECK_THROW(sav2.as_strided_array_view(), fail_fast); + span bytes2 = bytes.as_span(dim<2>(), dim<>(bytes.size() / 2)); + strided_span sav2{ bytes2, bounds }; + CHECK_THROW(sav2.as_strided_span(), fail_fast); } // retype strided array with irregular strides - from raw data { strided_bounds<1> bounds{ bytes.size() / 2, 2 }; - strided_array_view sav2{ bytes.data(), bytes.size(), bounds }; - CHECK_THROW(sav2.as_strided_array_view(), fail_fast); + strided_span sav2{ bytes.data(), bytes.size(), bounds }; + CHECK_THROW(sav2.as_strided_span(), fail_fast); } - // retype strided array with irregular strides - from array_view + // retype strided array with irregular strides - from span { strided_bounds<1> bounds{ bytes.size() / 2, 2 }; - strided_array_view sav2{ bytes, bounds }; - CHECK_THROW(sav2.as_strided_array_view(), fail_fast); + strided_span sav2{ bytes, bounds }; + CHECK_THROW(sav2.as_strided_span(), fail_fast); } } @@ -738,14 +744,14 @@ SUITE(array_view_tests) { #ifdef CONFIRM_COMPILATION_ERRORS { - array_view empty; - strided_array_view empty2; - strided_array_view empty3{ nullptr,{ 0, 1 } }; + span empty; + strided_span empty2; + strided_span empty3{ nullptr,{ 0, 1 } }; } #endif { - array_view empty_av(nullptr); + span empty_av(nullptr); CHECK(empty_av.bounds().index_bounds() == index<1>{ 0 }); CHECK_THROW(empty_av[0], fail_fast); @@ -753,25 +759,27 @@ SUITE(array_view_tests) CHECK_THROW(empty_av.cbegin()[0], fail_fast); for (auto& v : empty_av) { + (void)v; CHECK(false); } } { - array_view empty_av = {}; + span empty_av = {}; CHECK(empty_av.bounds().index_bounds() == index<1>{ 0 }); CHECK_THROW(empty_av[0], fail_fast); CHECK_THROW(empty_av.begin()[0], fail_fast); CHECK_THROW(empty_av.cbegin()[0], fail_fast); for (auto& v : empty_av) { + (void)v; CHECK(false); } } { - array_view empty_av(nullptr); - strided_array_view empty_sav{ empty_av, { 0, 1 } }; + span empty_av(nullptr); + strided_span empty_sav{ empty_av, { 0, 1 } }; CHECK(empty_sav.bounds().index_bounds() == index<1>{ 0 }); CHECK_THROW(empty_sav[0], fail_fast); @@ -780,12 +788,13 @@ SUITE(array_view_tests) for (auto& v : empty_sav) { + (void)v; CHECK(false); } } { - strided_array_view empty_sav{ nullptr, 0, { 0, 1 } }; + strided_span empty_sav{ nullptr, 0, { 0, 1 } }; CHECK(empty_sav.bounds().index_bounds() == index<1>{ 0 }); CHECK_THROW(empty_sav[0], fail_fast); @@ -794,6 +803,7 @@ SUITE(array_view_tests) for (auto& v : empty_sav) { + (void)v; CHECK(false); } } @@ -808,15 +818,15 @@ SUITE(array_view_tests) arr[2 * i + 1] = i; } - array_view av(arr, 8); + span av(arr, 8); - size_t a[1] = { 0 }; + ptrdiff_t a[1] = { 0 }; index<1> i = a; CHECK(av[i] == 4); - auto av2 = av.as_array_view(dim<4>(), dim<>(2)); - size_t a2[2] = { 0, 1 }; + auto av2 = av.as_span(dim<4>(), dim<>(2)); + ptrdiff_t a2[2] = { 0, 1 }; index<2> i2 = a2; CHECK(av2[i2] == 0); @@ -846,20 +856,12 @@ SUITE(array_view_tests) index<3> i4 = i3; CHECK(i4[0] == 0); - // from other index of bigger size type - index<3, short> i5 = i4; - CHECK(i5[0] == 0); - - // from other index of smaller size type - index<3, long long> i6 = i4; - CHECK(i6[0] == 0); - // default - index<3, long long> i7; + index<3> i7; CHECK(i7[0] == 0); // default - index<3, long long> i9 = {}; + index<3> i9 = {}; CHECK(i9[0] == 0); } @@ -885,20 +887,12 @@ SUITE(array_view_tests) index<1> i5 = i3; CHECK(i5[0] == 0); - // from other index of bigger size type - index<1, short> i6 = i5; - CHECK(i6[0] == 0); - - // from other index of smaller size type - index<1, long long> i7 = i6; - CHECK(i7[0] == 0); - // default - index<1, long long> i8; + index<1> i8; CHECK(i8[0] == 0); // default - index<1, long long> i9 = {}; + index<1> i9 = {}; CHECK(i9[0] == 0); } @@ -915,8 +909,8 @@ SUITE(array_view_tests) TEST(index_operations) { - size_t a[3] = { 0, 1, 2 }; - size_t b[3] = { 3, 4, 5 }; + ptrdiff_t a[3] = { 0, 1, 2 }; + ptrdiff_t b[3] = { 3, 4, 5 }; index<3> i = a; index<3> j = b; @@ -969,7 +963,7 @@ SUITE(array_view_tests) } - void iterate_second_column(array_view av) + void iterate_second_column(span av) { auto length = av.size() / 2; @@ -977,12 +971,12 @@ SUITE(array_view_tests) auto section = av.section({ 0,1 }, { length,1 }); CHECK(section.size() == length); - for (unsigned int i = 0; i < section.size(); ++i) + for (auto i = 0; i < section.size(); ++i) { CHECK(section[i][0] == av[i][1]); } - for (unsigned int i = 0; i < section.size(); ++i) + for (auto i = 0; i < section.size(); ++i) { auto idx = index<2>{ i,0 }; // avoid braces inside the CHECK macro CHECK(section[idx] == av[i][1]); @@ -990,9 +984,9 @@ SUITE(array_view_tests) CHECK(section.bounds().index_bounds()[0] == length); CHECK(section.bounds().index_bounds()[1] == 1); - for (unsigned int i = 0; i < section.bounds().index_bounds()[0]; ++i) + for (auto i = 0; i < section.bounds().index_bounds()[0]; ++i) { - for (unsigned int j = 0; j < section.bounds().index_bounds()[1]; ++j) + for (auto j = 0; j < section.bounds().index_bounds()[1]; ++j) { auto idx = index<2>{ i,j }; // avoid braces inside the CHECK macro CHECK(section[idx] == av[i][1]); @@ -1000,13 +994,13 @@ SUITE(array_view_tests) } size_t check_sum = 0; - for (size_t i = 0; i < length; ++i) + for (auto i = 0; i < length; ++i) { check_sum += av[i][1]; } { - size_t idx = 0; + auto idx = 0; size_t sum = 0; for (auto num : section) { @@ -1031,65 +1025,65 @@ SUITE(array_view_tests) } } - TEST(array_view_section_iteration) + TEST(span_section_iteration) { int arr[4][2] = { { 4,0 },{ 5,1 },{ 6,2 },{ 7,3 } }; // static bounds { - array_view av = arr; + span av = arr; iterate_second_column(av); } // first bound is dynamic { - array_view av = arr; + span av = arr; iterate_second_column(av); } // second bound is dynamic { - array_view av = arr; + span av = arr; iterate_second_column(av); } // both bounds are dynamic { - array_view av(arr, 4); + span av = arr; iterate_second_column(av); } } - TEST(dynamic_array_view_section_iteration) + TEST(dynamic_span_section_iteration) { - unsigned int height = 4, width = 2; - unsigned int size = height * width; + auto height = 4, width = 2; + auto size = height * width; auto arr = new int[size]; - for (int unsigned i = 0; i < size; ++i) + for (auto i = 0; i < size; ++i) { arr[i] = i; } - auto av = as_array_view(arr, size); + auto av = as_span(arr, size); // first bound is dynamic { - array_view av2 = av.as_array_view(dim<>(height), dim<>(width)); + span av2 = av.as_span(dim<>(height), dim<>(width)); iterate_second_column(av2); } // second bound is dynamic { - array_view av2 = av.as_array_view(dim<>(height), dim<>(width)); + span av2 = av.as_span(dim<>(height), dim<>(width)); iterate_second_column(av2); } // both bounds are dynamic { - array_view av2 = av.as_array_view(dim<>(height), dim<>(width)); + span av2 = av.as_span(dim<>(height), dim<>(width)); iterate_second_column(av2); } delete[] arr; } - void iterate_every_other_element(array_view av) + void iterate_every_other_element(span av) { // pick every other element @@ -1099,11 +1093,11 @@ SUITE(array_view_tests) #else auto bounds = strided_bounds<1>(index<1>{ length }, index<1>{ 2 }); #endif - strided_array_view strided(&av.data()[1], av.size() - 1, bounds); + strided_span strided(&av.data()[1], av.size() - 1, bounds); CHECK(strided.size() == length); CHECK(strided.bounds().index_bounds()[0] == length); - for (unsigned int i = 0; i < strided.size(); ++i) + for (auto i = 0; i < strided.size(); ++i) { CHECK(strided[i] == av[2 * i + 1]); } @@ -1116,24 +1110,24 @@ SUITE(array_view_tests) } } - TEST(strided_array_view_section_iteration) + TEST(strided_span_section_iteration) { int arr[8] = {4,0,5,1,6,2,7,3}; // static bounds { - array_view av(arr, 8); + span av(arr, 8); iterate_every_other_element(av); } // dynamic bounds { - array_view av(arr, 8); + span av(arr, 8); iterate_every_other_element(av); } } - TEST(dynamic_strided_array_view_section_iteration) + TEST(dynamic_strided_span_section_iteration) { auto arr = new int[8]; for (int i = 0; i < 4; ++i) @@ -1142,31 +1136,31 @@ SUITE(array_view_tests) arr[2 * i + 1] = i; } - auto av = as_array_view(arr, 8); + auto av = as_span(arr, 8); iterate_every_other_element(av); delete[] arr; } - void iterate_second_slice(array_view av) + void iterate_second_slice(span av) { int expected[6] = { 2,3,10,11,18,19 }; auto section = av.section({ 0,1,0 }, { 3,1,2 }); - for (unsigned int i = 0; i < section.extent<0>(); ++i) + for (auto i = 0; i < section.extent<0>(); ++i) { - for (unsigned int j = 0; j < section.extent<1>(); ++j) - for (unsigned int k = 0; k < section.extent<2>(); ++k) + for (auto j = 0; j < section.extent<1>(); ++j) + for (auto k = 0; k < section.extent<2>(); ++k) { auto idx = index<3>{ i,j,k }; // avoid braces in the CHECK macro CHECK(section[idx] == expected[2 * i + 2 * j + k]); } } - for (unsigned int i = 0; i < section.extent<0>(); ++i) + for (auto i = 0; i < section.extent<0>(); ++i) { - for (unsigned int j = 0; j < section.extent<1>(); ++j) - for (unsigned int k = 0; k < section.extent<2>(); ++k) + for (auto j = 0; j < section.extent<1>(); ++j) + for (auto k = 0; k < section.extent<2>(); ++k) CHECK(section[i][j][k] == expected[2 * i + 2 * j + k]); } @@ -1178,69 +1172,69 @@ SUITE(array_view_tests) } } - TEST(strided_array_view_section_iteration_3d) + TEST(strided_span_section_iteration_3d) { int arr[3][4][2]; - for (int i = 0; i < 3; ++i) + for (auto i = 0; i < 3; ++i) { - for (int j = 0; j < 4; ++j) - for (unsigned int k = 0; k < 2; ++k) + for (auto j = 0; j < 4; ++j) + for (auto k = 0; k < 2; ++k) arr[i][j][k] = 8 * i + 2 * j + k; } { - array_view av = arr; + span av = arr; iterate_second_slice(av); } } - TEST(dynamic_strided_array_view_section_iteration_3d) + TEST(dynamic_strided_span_section_iteration_3d) { - unsigned int height = 12, width = 2; - unsigned int size = height * width; + auto height = 12, width = 2; + auto size = height * width; auto arr = new int[size]; - for (int unsigned i = 0; i < size; ++i) + for (auto i = 0; i < size; ++i) { arr[i] = i; } { - auto av = as_array_view(arr, 24).as_array_view(dim<3>(),dim<4>(),dim<2>()); + auto av = as_span(arr, 24).as_span(dim<3>(),dim<4>(),dim<2>()); iterate_second_slice(av); } { - auto av = as_array_view(arr, 24).as_array_view(dim<>(3), dim<4>(), dim<2>()); + auto av = as_span(arr, 24).as_span(dim<>(3), dim<4>(), dim<2>()); iterate_second_slice(av); } { - auto av = as_array_view(arr, 24).as_array_view(dim<3>(), dim<>(4), dim<2>()); + auto av = as_span(arr, 24).as_span(dim<3>(), dim<>(4), dim<2>()); iterate_second_slice(av); } { - auto av = as_array_view(arr, 24).as_array_view(dim<3>(), dim<4>(), dim<>(2)); + auto av = as_span(arr, 24).as_span(dim<3>(), dim<4>(), dim<>(2)); iterate_second_slice(av); } delete[] arr; } - TEST(strided_array_view_conversion) + TEST(strided_span_conversion) { - // get an array_view of 'c' values from the list of X's + // get an span of 'c' values from the list of X's struct X { int a; int b; int c; }; X arr[4] = { { 0,1,2 },{ 3,4,5 },{ 6,7,8 },{ 9,10,11 } }; - auto s = sizeof(int) / sizeof(byte); + int s = sizeof(int) / sizeof(byte); auto d2 = 3 * s; auto d1 = sizeof(int) * 12 / d2; // convert to 4x12 array of bytes - auto av = as_array_view(arr, 4).as_bytes().as_array_view(dim<>(d1), dim<>(d2)); + auto av = as_span(arr, 4).as_bytes().as_span(dim<>(d1), dim<>(d2)); CHECK(av.bounds().index_bounds()[0] == 4); CHECK(av.bounds().index_bounds()[1] == 12); @@ -1249,7 +1243,7 @@ SUITE(array_view_tests) auto section = av.section({ 0, 2 * s }, { 4, s }); // { { arr[0].c[0], arr[0].c[1], arr[0].c[2], arr[0].c[3] } , { arr[1].c[0], ... } , ... } // convert to array 4x1 array of integers - auto cs = section.as_strided_array_view(); // { { arr[0].c }, {arr[1].c } , ... } + auto cs = section.as_strided_span(); // { { arr[0].c }, {arr[1].c } , ... } CHECK(cs.bounds().index_bounds()[0] == 4); CHECK(cs.bounds().index_bounds()[1] == 1); @@ -1260,10 +1254,10 @@ SUITE(array_view_tests) { cs.bounds().strides()[1], cs.bounds().strides()[0] } }; - strided_array_view transposed{ cs.data(), cs.bounds().total_size(), reverse_bounds }; + strided_span transposed{ cs.data(), cs.bounds().total_size(), reverse_bounds }; // slice to get a one-dimensional array of c's - strided_array_view result = transposed[0]; + strided_span result = transposed[0]; CHECK(result.bounds().index_bounds()[0] == 4); CHECK_THROW(result.bounds().index_bounds()[1], fail_fast); @@ -1277,357 +1271,211 @@ SUITE(array_view_tests) } - template - index Convert(index index) - { - return{ index }; - } - - TEST(DomainConverters) - { - // to smaller - { - index<2, int> int_index{ 0,1 }; - index<2, short> short_index{ int_index }; - - CHECK(short_index[0] == 0); - CHECK(short_index[1] == 1); - } - - // to smaller (failure) - { - index<2, int> big_int_index{ std::numeric_limits::max(), 1 }; - CHECK_THROW((Convert<2,int, short int>(big_int_index)), fail_fast); - } - - // to same, sign mismatch - { - index<2, int> int_index{ 0,1 }; - index<2, unsigned int> uint_index{ int_index }; - - CHECK(uint_index[0] == 0); - CHECK(uint_index[1] == 1); - } - - // to same, sign mismatch, reversed - { - index<2, unsigned int> uint_index{ 0,1 }; - index<2, int> int_index{ uint_index }; - - CHECK(int_index[0] == 0); - CHECK(int_index[1] == 1); - } - - // to smaller, sign mismatch - { - index<2, int> int_index{ 0,1 }; - index<2, unsigned short> ushort_index{ int_index }; - - CHECK(ushort_index[0] == 0); - CHECK(ushort_index[1] == 1); - } - - // to bigger - { - index<2, int> int_index{ 0,1 }; - index<2, long long> longlong_index{ int_index }; - - CHECK(longlong_index[0] == 0); - CHECK(longlong_index[1] == 1); - } - - // to bigger with max index - { - index<2, int> big_int_index{ std::numeric_limits::max(), 1 }; - index<2, long long> longlong_index{ big_int_index }; - - CHECK(longlong_index[0] == std::numeric_limits::max()); - CHECK(longlong_index[1] == 1); - } - - // to bigger, sign mismatch - { - index<2, int> int_index{ 0,1 }; - index<2, unsigned long long> ulonglong_index{ int_index }; - - CHECK(ulonglong_index[0] == 0); - CHECK(ulonglong_index[1] == 1); - } - - } - - TEST(DomainConvertersRank1) - { - // to smaller - { - index<1, int> int_index{ 0 }; - index<1, short> short_index{ int_index }; - - CHECK(short_index[0] == 0); - } - - // to smaller (failure) - { - index<1, int> big_int_index{ std::numeric_limits::max() }; - - CHECK_THROW((Convert<1, int, short int>(big_int_index)), fail_fast); - } - - // to same, sign mismatch - { - index<1, int> int_index{ 0 }; - index<1, unsigned int> uint_index{ int_index }; - - CHECK(uint_index[0] == 0); - } - - // to same, sign mismatch, reversed - { - index<1, unsigned int> uint_index{ 0 }; - index<1, int> int_index{ uint_index }; - - CHECK(int_index[0] == 0); - } - - // to smaller, sign mismatch - { - index<1, int> int_index{ 0 }; - index<1, unsigned short> ushort_index{ int_index }; - - CHECK(ushort_index[0] == 0); - } - - // to bigger - { - index<1, int> int_index{ 0 }; - index<1, long long> longlong_index{ int_index }; - - CHECK(longlong_index[0] == 0); - } - - // to bigger with max index - { - index<1, int> big_int_index{ std::numeric_limits::max() }; - index<1, long long> longlong_index{ big_int_index }; - - CHECK(longlong_index[0] == std::numeric_limits::max()); - } - - // to bigger, sign mismatch - { - index<1, int> int_index{ 0 }; - index<1, unsigned long long> ulonglong_index{ int_index }; - - CHECK(ulonglong_index[0] == 0); - } - - } - TEST(constructors) { - array_view av(nullptr); + span av(nullptr); CHECK(av.length() == 0); - array_view av2; + span av2; CHECK(av2.length() == 0); - array_view av3(nullptr, 0); + span av3(nullptr, 0); CHECK(av3.length() == 0); // Constructing from a nullptr + length is specifically disallowed - auto f = [&]() {array_view av4(nullptr, 2);}; + auto f = [&]() {span av4(nullptr, 2);}; CHECK_THROW(f(), fail_fast); int arr1[2][3]; - array_view av5(arr1); + span av5(arr1); array arr2; - array_view av6(arr2); + span av6(arr2); vector vec1(19); - array_view av7(vec1); + span av7(vec1); CHECK(av7.length() == 19); - array_view av8; + span av8; CHECK(av8.length() == 0); - array_view av9(arr2); + span av9(arr2); CHECK(av9.length() == 15); #ifdef CONFIRM_COMPILATION_ERRORS - array_view av10; + span av10; DerivedClass *p = nullptr; - array_view av11(p, 0); + span av11(p, 0); #endif } TEST(copyandassignment) { - array_view av1; + span av1; int arr[] = {3, 4, 5}; av1 = arr; - array_view, dynamic_range> av2; + span av2; av2 = av1; } - TEST(array_view_first) + TEST(span_first) { int arr[5] = { 1, 2, 3, 4, 5 }; { - array_view av = arr; - CHECK((av.first<2>().bounds() == static_bounds())); + span av = arr; + CHECK((av.first<2>().bounds() == static_bounds<2>())); CHECK(av.first<2>().length() == 2); CHECK(av.first(2).length() == 2); } { - array_view av = arr; - CHECK((av.first<0>().bounds() == static_bounds())); + span av = arr; + CHECK((av.first<0>().bounds() == static_bounds<0>())); CHECK(av.first<0>().length() == 0); CHECK(av.first(0).length() == 0); } { - array_view av = arr; - CHECK((av.first<5>().bounds() == static_bounds())); + span av = arr; + CHECK((av.first<5>().bounds() == static_bounds<5>())); CHECK(av.first<5>().length() == 5); CHECK(av.first(5).length() == 5); } { - array_view av = arr; + span av = arr; #ifdef CONFIRM_COMPILATION_ERRORS - CHECK(av.first<6>().bounds() == static_bounds()); + CHECK(av.first<6>().bounds() == static_bounds<6>()); CHECK(av.first<6>().length() == 6); #endif CHECK_THROW(av.first(6).length(), fail_fast); } { - array_view av; - CHECK((av.first<0>().bounds() == static_bounds())); + span av; + CHECK((av.first<0>().bounds() == static_bounds<0>())); CHECK(av.first<0>().length() == 0); CHECK(av.first(0).length() == 0); } } - TEST(array_view_last) + TEST(span_last) { int arr[5] = { 1, 2, 3, 4, 5 }; { - array_view av = arr; - CHECK((av.last<2>().bounds() == static_bounds())); + span av = arr; + CHECK((av.last<2>().bounds() == static_bounds<2>())); CHECK(av.last<2>().length() == 2); CHECK(av.last(2).length() == 2); } { - array_view av = arr; - CHECK((av.last<0>().bounds() == static_bounds())); + span av = arr; + CHECK((av.last<0>().bounds() == static_bounds<0>())); CHECK(av.last<0>().length() == 0); CHECK(av.last(0).length() == 0); } { - array_view av = arr; - CHECK((av.last<5>().bounds() == static_bounds())); + span av = arr; + CHECK((av.last<5>().bounds() == static_bounds<5>())); CHECK(av.last<5>().length() == 5); CHECK(av.last(5).length() == 5); } { - array_view av = arr; + span av = arr; #ifdef CONFIRM_COMPILATION_ERRORS - CHECK((av.last<6>().bounds() == static_bounds())); + CHECK((av.last<6>().bounds() == static_bounds<6>())); CHECK(av.last<6>().length() == 6); #endif CHECK_THROW(av.last(6).length(), fail_fast); } { - array_view av; - CHECK((av.last<0>().bounds() == static_bounds())); + span av; + CHECK((av.last<0>().bounds() == static_bounds<0>())); CHECK(av.last<0>().length() == 0); CHECK(av.last(0).length() == 0); } } - TEST(custmized_array_view_size) + TEST(custmized_span_size) { double (*arr)[3][4] = new double[100][3][4]; - array_view, dynamic_range, 3, 4> av1(arr, (char)10); + span av1(arr, 10); struct EffectiveStructure { double* v1; - char v2; + ptrdiff_t v2; }; CHECK(sizeof(av1) == sizeof(EffectiveStructure)); CHECK_THROW(av1[10][3][4], fail_fast); - array_view av2 = av1.as_array_view(dim<>(5), dim<6>(), dim<4>()); - + span av2 = av1.as_span(dim<>(5), dim<6>(), dim<4>()); + (void)av2; } - TEST(array_view_sub) + TEST(span_sub) { int arr[5] = { 1, 2, 3, 4, 5 }; { - array_view av = arr; - CHECK((av.sub<2,2>().bounds() == static_bounds())); + span av = arr; + CHECK((av.sub<2,2>().bounds() == static_bounds<2>())); CHECK((av.sub<2,2>().length() == 2)); CHECK(av.sub(2,2).length() == 2); - CHECK(av.sub(2,3).length() == 3); + CHECK(av.sub(2,3).length() == 3); } { - array_view av = arr; - CHECK((av.sub<0,0>().bounds() == static_bounds())); + span av = arr; + CHECK((av.sub<0,0>().bounds() == static_bounds<0>())); CHECK((av.sub<0,0>().length() == 0)); CHECK(av.sub(0,0).length() == 0); } { - array_view av = arr; - CHECK((av.sub<0,5>().bounds() == static_bounds())); + span av = arr; + CHECK((av.sub<0,5>().bounds() == static_bounds<5>())); CHECK((av.sub<0,5>().length() == 5)); CHECK(av.sub(0,5).length() == 5); - CHECK_THROW(av.sub(0,6).length(), fail_fast); - CHECK_THROW(av.sub(1,5).length(), fail_fast); + CHECK_THROW(av.sub(0,6).length(), fail_fast); + CHECK_THROW(av.sub(1,5).length(), fail_fast); } { - array_view av = arr; - CHECK((av.sub<5,0>().bounds() == static_bounds())); - CHECK((av.sub<5, 0>().length() == 0)); - CHECK(av.sub(5,0).length() == 0); - CHECK_THROW(av.sub(6,0).length(), fail_fast); + span av = arr; + CHECK((av.sub<5,0>().bounds() == static_bounds<0>())); + CHECK((av.sub<5, 0>().length() == 0)); + CHECK(av.sub(5,0).length() == 0); + CHECK_THROW(av.sub(6,0).length(), fail_fast); } { - array_view av; - CHECK((av.sub<0,0>().bounds() == static_bounds())); + span av; + CHECK((av.sub<0,0>().bounds() == static_bounds<0>())); CHECK((av.sub<0,0>().length() == 0)); CHECK(av.sub(0,0).length() == 0); - CHECK_THROW((av.sub<1,0>().length()), fail_fast); + CHECK_THROW((av.sub<1,0>().length()), fail_fast); } { - array_view av; + span av; CHECK(av.sub(0).length() == 0); CHECK_THROW(av.sub(1).length(), fail_fast); } { - array_view av = arr; + span av = arr; CHECK(av.sub(0).length() == 5); CHECK(av.sub(1).length() == 4); CHECK(av.sub(4).length() == 1); @@ -1639,7 +1487,7 @@ SUITE(array_view_tests) } { - array_view av = arr; + span av = arr; CHECK(av.sub(0).length() == 5); CHECK(av.sub(1).length() == 4); CHECK(av.sub(4).length() == 1); @@ -1651,7 +1499,7 @@ SUITE(array_view_tests) } } - void AssertNullEmptyProperties(array_view& av) + void AssertNullEmptyProperties(span& av) { CHECK(av.length() == 0); CHECK(av.data() == nullptr); @@ -1662,16 +1510,16 @@ SUITE(array_view_tests) void AssertContentsMatch(T a1, U a2) { CHECK(a1.length() == a2.length()); - for (size_t i = 0; i < a1.length(); ++i) + for (auto i = 0; i < a1.length(); ++i) CHECK(a1[i] == a2[i]); } TEST(TestNullConstruction) { - array_view av; + span av; AssertNullEmptyProperties(av); - array_view av2(nullptr); + span av2(nullptr); AssertNullEmptyProperties(av2); } @@ -1679,13 +1527,13 @@ SUITE(array_view_tests) { int a[] = { 1, 2, 3, 4 }; - array_view av = { &a[1], 3 }; + span av = { &a[1], 3 }; CHECK(av.length() == 3); - array_view av3 = { a, 2 }; + span av3 = { a, 2 }; CHECK(av3.length() == 2); - array_view av2 = a; + span av2 = a; CHECK(av2.length() == 4); } @@ -1694,11 +1542,11 @@ SUITE(array_view_tests) int a[] = { 1, 2, 3, 4 }; #ifdef CONFIRM_COMPILATION_ERRORS - array_view cav = a; - array_view av = cav; + span cav = a; + span av = cav; #else - array_view av = a; - array_view cav = av; + span av = a; + span cav = av; #endif AssertContentsMatch(av, cav); } @@ -1707,43 +1555,46 @@ SUITE(array_view_tests) { int arr[] = { 1, 2, 3, 4 }; - // converting to an array_view from an equal size array is ok - array_view av4 = arr; + // converting to an span from an equal size array is ok + span av4 = arr; CHECK(av4.length() == 4); // converting to dynamic_range a_v is always ok { - array_view av = av4; + span av = av4; + (void)av; } { - array_view av = arr; + span av = arr; + (void)av; } - // initialization or assignment to static array_view that REDUCES size is NOT ok + // initialization or assignment to static span that REDUCES size is NOT ok #ifdef CONFIRM_COMPILATION_ERRORS { - array_view av2 = arr; + span av2 = arr; } { - array_view av2 = av4; + span av2 = av4; } #endif { - array_view av = arr; - array_view av2 = av; + span av = arr; + span av2 = av; + (void)av2; } #ifdef CONFIRM_COMPILATION_ERRORS { - array_view av = arr; - array_view av2 = av.as_array_view(dim<2>(), dim<2>()); + span av = arr; + span av2 = av.as_span(dim<2>(), dim<2>()); } #endif { - array_view av = arr; - auto f = [&]() {array_view av2 = av.as_array_view(dim<>(2), dim<>(2));}; + span av = arr; + auto f = [&]() {span av2 = av.as_span(dim<>(2), dim<>(2)); (void)av2; }; CHECK_THROW(f(), fail_fast); } @@ -1751,38 +1602,41 @@ SUITE(array_view_tests) // you can convert statically { - array_view av2 = {arr, 2}; + span av2 = {arr, 2}; + (void)av2; } { - array_view av2 = av4.first<1>(); + span av2 = av4.first<1>(); + (void)av2; } // ...or dynamically { - // NB: implicit conversion to array_view from array_view - array_view av2 = av4.first(1); + // NB: implicit conversion to span from span + span av2 = av4.first(1); + (void)av2; } - // initialization or assignment to static array_view that requires size INCREASE is not ok. + // initialization or assignment to static span that requires size INCREASE is not ok. int arr2[2] = { 1, 2 }; #ifdef CONFIRM_COMPILATION_ERRORS { - array_view av4 = arr2; + span av4 = arr2; } { - array_view av2 = arr2; - array_view av4 = av2; + span av2 = arr2; + span av4 = av2; } #endif { - auto f = [&]() {array_view av4 = {arr2, 2};}; + auto f = [&]() {span av4 = {arr2, 2}; (void)av4; }; CHECK_THROW(f(), fail_fast); } // this should fail - we are trying to assign a small dynamic a_v to a fixed_size larger one - array_view av = arr2; - auto f = [&](){ array_view av2 = av; }; + span av = arr2; + auto f = [&](){ span av2 = av; (void)av2; }; CHECK_THROW(f(), fail_fast); } @@ -1793,13 +1647,13 @@ SUITE(array_view_tests) { #ifdef CONFIRM_COMPILATION_ERRORS // you should not be able to get writeable bytes for const objects - array_view av = a; + span av = a; auto wav = av.as_writeable_bytes(); #endif } { - array_view av; + span av; auto wav = av.as_writeable_bytes(); CHECK(wav.length() == av.length()); CHECK(wav.length() == 0); @@ -1807,7 +1661,7 @@ SUITE(array_view_tests) } { - array_view av = a; + span av = a; auto wav = av.as_writeable_bytes(); CHECK(wav.data() == (byte*)&a[0]); CHECK(wav.length() == sizeof(a)); @@ -1819,7 +1673,7 @@ SUITE(array_view_tests) int a[] = { 1, 2, 3, 4 }; { - array_view av = a; + span av = a; auto wav = av.as_writeable_bytes(); for (auto& b : wav) { @@ -1832,7 +1686,7 @@ SUITE(array_view_tests) } { - array_view av = a; + span av = a; for (auto& n : av) { n = 1; @@ -1848,12 +1702,12 @@ SUITE(array_view_tests) { { int arr[10][2]; - auto av1 = as_array_view(arr); - array_view av2 = av1; + auto av1 = as_span(arr); + span av2 = av1; CHECK(av1 == av2); - array_view, 20> av3 = av1.as_array_view(dim<>(20)); + span av3 = av1.as_span(dim<>(20)); CHECK(av3 == av2 && av3 == av1); } @@ -1877,8 +1731,8 @@ SUITE(array_view_tests) { int arr[] = { 2, 1 }; // bigger - array_view av1 = nullptr; - array_view av2 = arr; + span av1 = nullptr; + span av2 = arr; CHECK(av1 != av2); CHECK(av2 != av1); @@ -1897,8 +1751,8 @@ SUITE(array_view_tests) { int arr1[] = { 1, 2 }; int arr2[] = { 1, 2 }; - array_view av1 = arr1; - array_view av2 = arr2; + span av1 = arr1; + span av2 = arr2; CHECK(av1 == av2); CHECK(!(av1 != av2)); @@ -1917,8 +1771,8 @@ SUITE(array_view_tests) { int arr[] = { 1, 2, 3 }; - array_view av1 = { &arr[0], 2 }; // shorter - array_view av2 = arr; // longer + span av1 = { &arr[0], 2 }; // shorter + span av2 = arr; // longer CHECK(av1 != av2); CHECK(av2 != av1); @@ -1938,8 +1792,8 @@ SUITE(array_view_tests) int arr1[] = { 1, 2 }; // smaller int arr2[] = { 2, 1 }; // bigger - array_view av1 = arr1; - array_view av2 = arr2; + span av1 = arr1; + span av2 = arr2; CHECK(av1 != av2); CHECK(av2 != av1); diff --git a/tests/string_view_tests.cpp b/tests/string_span_tests.cpp similarity index 60% rename from tests/string_view_tests.cpp rename to tests/string_span_tests.cpp index fb57845..efdf0ff 100644 --- a/tests/string_view_tests.cpp +++ b/tests/string_span_tests.cpp @@ -15,39 +15,40 @@ /////////////////////////////////////////////////////////////////////////////// #include -#include +#include #include #include using namespace std; using namespace gsl; -SUITE(string_view_tests) + +SUITE(string_span_tests) { TEST(TestLiteralConstruction) { - cwstring_view<> v = ensure_z(L"Hello"); + cwstring_span<> v = ensure_z(L"Hello"); CHECK(5 == v.length()); #ifdef CONFIRM_COMPILATION_ERRORS - wstring_view<> v2 = ensure0(L"Hello"); + wstring_span<> v2 = ensure0(L"Hello"); #endif } TEST(TestConstructFromStdString) { std::string s = "Hello there world"; - cstring_view<> v = s; - CHECK(v.length() == s.length()); + cstring_span<> v = s; + CHECK(v.length() == static_cast::size_type>(s.length())); } TEST(TestConstructFromStdVector) { std::vector vec(5, 'h'); - string_view<> v = vec; - CHECK(v.length() == vec.size()); + string_span<> v = vec; + CHECK(v.length() == static_cast::size_type>(vec.size())); } TEST(TestStackArrayConstruction) @@ -55,47 +56,68 @@ SUITE(string_view_tests) wchar_t stack_string[] = L"Hello"; { - cwstring_view<> v = ensure_z(stack_string); + cwstring_span<> v = ensure_z(stack_string); CHECK(v.length() == 5); CHECK(v.used_length() == v.length()); } { - cwstring_view<> v = stack_string; + cwstring_span<> v = stack_string; CHECK(v.length() == 6); CHECK(v.used_length() == v.length()); } { - wstring_view<> v = ensure_z(stack_string); + wstring_span<> v = ensure_z(stack_string); CHECK(v.length() == 5); CHECK(v.used_length() == v.length()); } { - wstring_view<> v = stack_string; + wstring_span<> v = stack_string; CHECK(v.length() == 6); CHECK(v.used_length() == v.length()); } } + TEST(TestConstructFromConstCharPointer) + { + const char* s = "Hello"; + cstring_span<> v = ensure_z(s); + CHECK(v.length() == 5); + CHECK(v.used_length() == v.length()); + } + TEST(TestConversionToConst) { char stack_string[] = "Hello"; - string_view<> v = ensure_z(stack_string); - cstring_view<> v2 = v; + string_span<> v = ensure_z(stack_string); + cstring_span<> v2 = v; CHECK(v.length() == v2.length()); } TEST(TestConversionFromConst) { char stack_string[] = "Hello"; - cstring_view<> v = ensure_z(stack_string); + cstring_span<> v = ensure_z(stack_string); + (void)v; #ifdef CONFIRM_COMPILATION_ERRORS - string_view<> v2 = v; - string_view<> v3 = "Hello"; + string_span<> v2 = v; + string_span<> v3 = "Hello"; #endif } + + TEST(TestToString) + { + auto s = gsl::to_string(cstring_span<>{}); + CHECK(s.length() == 0); + + char stack_string[] = "Hello"; + cstring_span<> v = ensure_z(stack_string); + auto s2 = gsl::to_string(v); + CHECK(static_cast::size_type>(s2.length()) == v.length()); + CHECK(s2.length() == 5); + } } int main(int, const char *[])