/////////////////////////////////////////////////////////////////////////////// // // 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. // /////////////////////////////////////////////////////////////////////////////// #ifndef GSL_MULTI_SPAN_H #define GSL_MULTI_SPAN_H #include // for Expects #include // for byte #include // for narrow_cast #include // for transform, lexicographical_compare #include // for array #include // for ptrdiff_t, size_t, nullptr_t #include // for PTRDIFF_MAX #include // for divides, multiplies, minus, negate, plus #include // for initializer_list #include // for iterator, random_access_iterator_tag #include // for numeric_limits #include #include #include #include // for basic_string #include // for enable_if_t, remove_cv_t, is_same, is_co... #include #if defined(_MSC_VER) && !defined(__clang__) // turn off some warnings that are noisy about our Expects statements #pragma warning(push) #pragma warning(disable : 4127) // conditional expression is constant #pragma warning(disable : 4702) // unreachable code // Turn MSVC /analyze rules that generate too much noise. TODO: fix in the tool. #pragma warning(disable : 26495) // uninitalized member when constructor calls constructor #pragma warning(disable : 26473) // in some instantiations we cast to the same type #pragma warning(disable : 26490) // TODO: bug in parser - attributes and templates #pragma warning(disable : 26465) // TODO: bug - suppression does not work on template functions #pragma warning(disable : 4996) // use of function or classes marked [[deprecated]] #if _MSC_VER < 1910 #pragma push_macro("constexpr") #define constexpr /*constexpr*/ #endif // _MSC_VER < 1910 #endif // _MSC_VER // GCC 7 does not like the signed unsigned missmatch (size_t ptrdiff_t) // While there is a conversion from signed to unsigned, it happens at // compiletime, so the compiler wouldn't have to warn indiscriminently, but // could check if the source value actually doesn't fit into the target type // and only warn in those cases. #if defined(__GNUC__) && __GNUC__ > 6 #pragma GCC diagnostic push #pragma GCC diagnostic ignored "-Wsign-conversion" #endif namespace gsl { /* ** begin definitions of index and bounds */ namespace details { template struct [[deprecated]] SizeTypeTraits { static const SizeType max_value = std::numeric_limits::max(); }; template class [[deprecated]] are_integral : public std::integral_constant { }; template class [[deprecated]] are_integral : public std::integral_constant::value && are_integral::value> { }; } // namespace details template class [[deprecated]] multi_span_index final { static_assert(Rank > 0, "Rank must be greater than 0!"); template friend class multi_span_index; public: static const std::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 multi_span_index() noexcept {} constexpr multi_span_index(const value_type(&values)[Rank]) noexcept { GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute GSL_SUPPRESS(bounds.3) // NO-FORMAT: attribute std::copy(values, values + Rank, elems); } template ::value>> constexpr multi_span_index(Ts... ds) noexcept : elems{narrow_cast(ds)...} {} constexpr multi_span_index(const multi_span_index& other) noexcept = default; constexpr multi_span_index& operator=(const multi_span_index& rhs) noexcept = default; // Preconditions: component_idx < rank GSL_SUPPRESS(bounds.2) // NO-FORMAT: attribute GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute constexpr reference operator[](std::size_t component_idx) { Expects(component_idx < Rank); // Component index must be less than rank return elems[component_idx]; } // Preconditions: component_idx < rank GSL_SUPPRESS(bounds.2) // NO-FORMAT: attribute GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute constexpr const_reference operator[](std::size_t component_idx) const { Expects(component_idx < Rank); // Component index must be less than rank return elems[component_idx]; } GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute GSL_SUPPRESS(bounds.3) // NO-FORMAT: attribute constexpr bool operator==(const multi_span_index& rhs) const { return std::equal(elems, elems + rank, rhs.elems); } constexpr bool operator!=(const multi_span_index& rhs) const { return !(*this == rhs); } constexpr multi_span_index operator+() const noexcept { return *this; } constexpr multi_span_index operator-() const { multi_span_index ret = *this; std::transform(ret, ret + rank, ret, std::negate{}); return ret; } constexpr multi_span_index operator+(const multi_span_index& rhs) const { multi_span_index ret = *this; ret += rhs; return ret; } constexpr multi_span_index operator-(const multi_span_index& rhs) const { multi_span_index ret = *this; ret -= rhs; return ret; } constexpr multi_span_index& operator+=(const multi_span_index& rhs) { GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute GSL_SUPPRESS(bounds.3) // NO-FORMAT: attribute std::transform(elems, elems + rank, rhs.elems, elems, std::plus{}); return *this; } constexpr multi_span_index& operator-=(const multi_span_index& rhs) { GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute GSL_SUPPRESS(bounds.3) // NO-FORMAT: attribute std::transform(elems, elems + rank, rhs.elems, elems, std::minus{}); return *this; } constexpr multi_span_index operator*(value_type v) const { multi_span_index ret = *this; ret *= v; return ret; } constexpr multi_span_index operator/(value_type v) const { multi_span_index ret = *this; ret /= v; return ret; } friend constexpr multi_span_index operator*(value_type v, const multi_span_index& rhs) { return rhs * v; } constexpr multi_span_index& operator*=(value_type v) { GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute GSL_SUPPRESS(bounds.3) // NO-FORMAT: attribute std::transform(elems, elems + rank, elems, [v](value_type x) { return std::multiplies{}(x, v); }); return *this; } constexpr multi_span_index& operator/=(value_type v) { GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute GSL_SUPPRESS(bounds.3) // NO-FORMAT: attribute std::transform(elems, elems + rank, elems, [v](value_type x) { return std::divides{}(x, v); }); return *this; } private: value_type elems[Rank] = {}; }; #if !defined(_MSC_VER) || _MSC_VER >= 1910 struct [[deprecated]] static_bounds_dynamic_range_t { template ::value>> constexpr operator T() const noexcept { return narrow_cast(-1); } }; constexpr bool operator==(static_bounds_dynamic_range_t, static_bounds_dynamic_range_t) noexcept { return true; } constexpr bool operator!=(static_bounds_dynamic_range_t, static_bounds_dynamic_range_t) noexcept { return false; } template ::value>> constexpr bool operator==(static_bounds_dynamic_range_t, T other) noexcept { return narrow_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!=(static_bounds_dynamic_range_t, T other) noexcept { return narrow_cast(-1) != other; } 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 [[deprecated]] generalized_mapping_tag { }; struct[[deprecated]] contiguous_mapping_tag : generalized_mapping_tag{}; namespace details { template struct [[deprecated]] LessThan { static const bool value = Left < Right; }; template struct [[deprecated]] 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 constexpr BoundsRanges(const OtherRange&, bool /* firstLevel */) {} constexpr BoundsRanges(const std::ptrdiff_t* const) {} constexpr BoundsRanges() noexcept = default; template constexpr void serialize(T&) const {} template constexpr size_type linearize(const T&) const { return 0; } template constexpr size_type contains(const T&) const { return -1; } constexpr size_type elementNum(std::size_t) const noexcept { return 0; } constexpr size_type totalSize() const noexcept { return TotalSize; } constexpr bool operator==(const BoundsRanges&) const noexcept { return true; } }; template struct[[deprecated]] BoundsRanges : BoundsRanges { using Base = BoundsRanges; using size_type = std::ptrdiff_t; static const std::size_t Depth = Base::Depth + 1; static const std::size_t DynamicNum = Base::DynamicNum + 1; static const size_type CurrentRange = dynamic_range; static const size_type TotalSize = dynamic_range; private: size_type m_bound; public: GSL_SUPPRESS( f.23) // NO-FORMAT: attribute // this pointer type is cannot be assigned nullptr - issue in not_null GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute constexpr BoundsRanges(const std::ptrdiff_t* const arr) : Base(arr + 1), m_bound(*arr * this->Base::totalSize()) { Expects(0 <= *arr); } constexpr BoundsRanges() noexcept : m_bound(0) {} template constexpr BoundsRanges(const BoundsRanges& other, bool /* firstLevel */ = true) : Base(static_cast&>(other), false) , m_bound(other.totalSize()) {} template constexpr void serialize(T & arr) const { arr[Dim] = elementNum(); this->Base::template serialize(arr); } template GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute constexpr size_type linearize(const T& arr) const { const size_type index = this->Base::totalSize() * arr[Dim]; Expects(index < m_bound); return index + this->Base::template linearize(arr); } template constexpr 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; } GSL_SUPPRESS( c.128) // NO-FORMAT: attribute // no pointers to BoundsRanges should be ever used constexpr size_type totalSize() const noexcept { return m_bound; } GSL_SUPPRESS( c.128) // NO-FORMAT: attribute // no pointers to BoundsRanges should be ever used constexpr size_type elementNum() const noexcept { return totalSize() / this->Base::totalSize(); } GSL_SUPPRESS( c.128) // NO-FORMAT: attribute // no pointers to BoundsRanges should be ever used constexpr size_type elementNum(std::size_t dim) const noexcept { if (dim > 0) return this->Base::elementNum(dim - 1); else return elementNum(); } constexpr bool operator==(const BoundsRanges& rhs) const noexcept { return m_bound == rhs.m_bound && static_cast(*this) == static_cast(rhs); } }; template struct[[deprecated]] BoundsRanges : BoundsRanges { using Base = BoundsRanges; using size_type = std::ptrdiff_t; static const std::size_t Depth = Base::Depth + 1; static const std::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; constexpr BoundsRanges(const std::ptrdiff_t* const arr) : Base(arr) {} constexpr BoundsRanges() = default; template constexpr BoundsRanges(const BoundsRanges& other, bool firstLevel = true) : Base(static_cast&>(other), false) { GSL_SUPPRESS(type.4) // NO-FORMAT: attribute // TODO: false positive (void) firstLevel; } template constexpr void serialize(T & arr) const { arr[Dim] = elementNum(); this->Base::template serialize(arr); } template constexpr size_type linearize(const T& arr) const { GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute Expects(arr[Dim] >= 0 && arr[Dim] < CurrentRange); // Index is out of range GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute const ptrdiff_t d = arr[Dim]; return this->Base::totalSize() * d + this->Base::template linearize(arr); } template constexpr 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; } GSL_SUPPRESS( c.128) // NO-FORMAT: attribute // no pointers to BoundsRanges should be ever used constexpr size_type totalSize() const noexcept { return CurrentRange * this->Base::totalSize(); } GSL_SUPPRESS( c.128) // NO-FORMAT: attribute // no pointers to BoundsRanges should be ever used constexpr size_type elementNum() const noexcept { return CurrentRange; } GSL_SUPPRESS( c.128) // NO-FORMAT: attribute // no pointers to BoundsRanges should be ever used constexpr size_type elementNum(std::size_t dim) const noexcept { if (dim > 0) return this->Base::elementNum(dim - 1); else return elementNum(); } constexpr bool operator==(const BoundsRanges& rhs) const noexcept { return static_cast(*this) == static_cast(rhs); } }; template struct[[deprecated]] BoundsRangeConvertible : public std::integral_constant= TargetType::TotalSize || TargetType::TotalSize == dynamic_range || SourceType::TotalSize == dynamic_range || TargetType::TotalSize == 0)>{}; template struct [[deprecated]] TypeListIndexer { const TypeChain& obj_; constexpr TypeListIndexer(const TypeChain& obj) : obj_(obj) {} template constexpr const TypeChain& getObj(std::true_type) { return obj_; } template constexpr auto getObj(std::false_type) ->decltype(TypeListIndexer(static_cast(obj_)).template get()) { return TypeListIndexer(static_cast(obj_)).template get(); } template constexpr auto get()->decltype(getObj(std::integral_constant())) { return getObj(std::integral_constant()); } }; template constexpr TypeListIndexer createTypeListIndexer(const TypeChain& obj) { return TypeListIndexer(obj); } template 1), typename Ret = std::enable_if_t>> constexpr Ret shift_left(const multi_span_index& other) noexcept { Ret ret{}; for (std::size_t i = 0; i < Rank - 1; ++i) { GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute ret[i] = other[i + 1]; } return ret; } } // namespace details template class [[deprecated]] bounds_iterator; template class [[deprecated]] static_bounds { public: static_bounds(const details::BoundsRanges&) {} }; template class[[deprecated]] static_bounds { using MyRanges = details::BoundsRanges; MyRanges m_ranges; constexpr static_bounds(const MyRanges& range) noexcept : m_ranges(range) {} template friend class static_bounds; public: static const std::size_t rank = MyRanges::Depth; static const std::size_t dynamic_rank = MyRanges::DynamicNum; static const std::ptrdiff_t static_size = MyRanges::TotalSize; using size_type = std::ptrdiff_t; using index_type = multi_span_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() /*noexcept*/ = default; template struct BoundsRangeConvertible2; template > static auto helpBoundsRangeConvertible(SourceType, TargetType, std::true_type)->Ret; template static 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 , details::BoundsRanges>::value>> constexpr static_bounds(const static_bounds& other) : m_ranges(other.m_ranges) { Expects((MyRanges::DynamicNum == 0 && details::BoundsRanges::DynamicNum == 0) || MyRanges::DynamicNum > 0 || other.m_ranges.totalSize() >= m_ranges.totalSize()); } constexpr static_bounds(std::initializer_list il) : m_ranges(il.begin()) { // Size of the initializer list must match the rank of the array Expects((MyRanges::DynamicNum == 0 && il.size() == 1 && *il.begin() == static_size) || MyRanges::DynamicNum == il.size()); // Size of the range must be less than the max element of the size type Expects(m_ranges.totalSize() <= PTRDIFF_MAX); } 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[](std::size_t idx) const noexcept { return m_ranges.elementNum(idx); } 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(); } template constexpr size_type extent(IntType dim) const { static_assert(std::is_integral::value, "Dimension parameter must be supplied as an integral type."); auto real_dim = narrow_cast(dim); Expects(real_dim < rank); return m_ranges.elementNum(real_dim); } 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 [[deprecated]] strided_bounds { template friend class strided_bounds; public: static const std::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 = multi_span_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; } GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute constexpr size_type total_size() const noexcept { size_type ret = 0; for (std::size_t i = 0; i < rank; ++i) { ret += (m_extents[i] - 1) * m_strides[i]; } return ret + 1; } GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute constexpr size_type size() const noexcept { size_type ret = 1; for (std::size_t i = 0; i < rank; ++i) { ret *= m_extents[i]; } return ret; } constexpr bool contains(const index_type& idx) const noexcept { for (std::size_t i = 0; i < rank; ++i) { if (idx[i] < 0 || idx[i] >= m_extents[i]) return false; } return true; } GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute constexpr size_type linearize(const index_type& idx) const { size_type ret = 0; for (std::size_t i = 0; i < rank; i++) { Expects(idx[i] < m_extents[i]); // index is out of bounds of the array ret += idx[i] * m_strides[i]; } return ret; } GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute 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 GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute 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[[deprecated]] is_bounds : std::integral_constant{}; template struct[[deprecated]] is_bounds> : std::integral_constant{}; template struct[[deprecated]] is_bounds> : std::integral_constant{}; template class [[deprecated]] bounds_iterator { public: static const std::size_t rank = IndexType::rank; using iterator_category = std::random_access_iterator_tag; using value_type = IndexType; using difference_type = std::ptrdiff_t; using pointer = value_type*; using reference = 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_; } GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute GSL_SUPPRESS(bounds.2) // NO-FORMAT: attribute constexpr bounds_iterator& operator++() noexcept { for (std::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; } GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute constexpr bounds_iterator& operator--() { if (!less(curr_, boundary_)) { // if at the past-the-end, set to last element for (std::size_t i = 0; i < rank; ++i) { curr_[i] = boundary_[i] - 1; } return *this; } for (std::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" Expects(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; } GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute constexpr bounds_iterator& operator+=(difference_type n) { auto linear_idx = linearize(curr_) + n; std::remove_const_t stride = 0; stride[rank - 1] = 1; for (std::size_t i = rank - 1; i-- > 0;) { stride[i] = stride[i + 1] * boundary_[i + 1]; } for (std::size_t i = 0; i < rank; ++i) { curr_[i] = linear_idx / stride[i]; linear_idx = linear_idx % stride[i]; } // index is out of bounds of the array Expects(!less(curr_, index_type{}) && !less(boundary_, curr_)); 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: GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute constexpr bool less(index_type & one, index_type & other) const noexcept { for (std::size_t i = 0; i < rank; ++i) { if (one[i] < other[i]) return true; } return false; } GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute 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 (std::size_t i = rank; i-- > 0;) { res += (idx[i] - 1) * multiplier; multiplier *= boundary_[i]; } } else { for (std::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; } namespace details { template constexpr std::enable_if_t< std::is_same::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< std::is_same::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 (std::size_t i = 1; i < Bounds::rank; ++i) { GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute GSL_SUPPRESS(bounds.2) // NO-FORMAT: attribute 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"); Expects(src.size() == dest.size()); } } // namespace details template class [[deprecated]] contiguous_span_iterator; template class [[deprecated]] general_span_iterator; template struct [[deprecated]] dim_t { static const std::ptrdiff_t value = DimSize; }; template <> struct [[deprecated]] dim_t { static const std::ptrdiff_t value = dynamic_range; const std::ptrdiff_t dvalue; constexpr dim_t(std::ptrdiff_t size) noexcept : dvalue(size) {} }; template = 0)>> constexpr dim_t dim() noexcept { return dim_t(); } template > constexpr dim_t dim(std::ptrdiff_t n) noexcept { return dim_t<>(n); } template class [[deprecated]] multi_span; template class [[deprecated]] strided_span; namespace details { template struct [[deprecated]] SpanTypeTraits { using value_type = T; using size_type = std::size_t; }; template struct [[deprecated]] SpanTypeTraits< Traits, typename std::is_reference::type> { using value_type = typename Traits::span_traits::value_type; using size_type = typename Traits::span_traits::size_type; }; template struct [[deprecated]] SpanArrayTraits { using type = multi_span; using value_type = T; using bounds_type = static_bounds; using pointer = T*; using reference = T&; }; template struct [[deprecated]] SpanArrayTraits : SpanArrayTraits { }; template BoundsType newBoundsHelperImpl(std::ptrdiff_t totalSize, std::true_type) // dynamic size { Expects(totalSize >= 0 && totalSize <= PTRDIFF_MAX); return BoundsType{totalSize}; } template BoundsType newBoundsHelperImpl(std::ptrdiff_t totalSize, std::false_type) // static size { Expects(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 [[deprecated]] Sep { }; template T static_as_multi_span_helper(Sep, Args... args) { return T{narrow_cast(args)...}; } template std::enable_if_t< !std::is_same>::value && !std::is_same::value, T> static_as_multi_span_helper(Arg, Args... args) { return static_as_multi_span_helper(args...); } template T static_as_multi_span_helper(dim_t val, Args... args) { return static_as_multi_span_helper(args..., val.dvalue); } template struct [[deprecated]] static_as_multi_span_static_bounds_helper { using type = static_bounds<(Dimensions::value)...>; }; template struct [[deprecated]] is_multi_span_oracle : std::false_type { }; template struct [[deprecated]] is_multi_span_oracle> : std::true_type { }; template struct [[deprecated]] is_multi_span_oracle> : std::true_type { }; template struct [[deprecated]] is_multi_span : is_multi_span_oracle> { }; } // namespace details template class [[deprecated("This concept is not present in the C++ Core Guidelines")]] multi_span { // TODO do we still need this? template friend class multi_span; public: using bounds_type = static_bounds; static const std::size_t Rank = bounds_type::rank; 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 = std::add_pointer_t; using reference = std::add_lvalue_reference_t; using iterator = contiguous_span_iterator; using const_span = multi_span; using const_iterator = contiguous_span_iterator; using reverse_iterator = std::reverse_iterator; using const_reverse_iterator = std::reverse_iterator; using sliced_type = std::conditional_t>; private: pointer data_; bounds_type bounds_; friend iterator; friend const_iterator; public: // default constructor - same as constructing from nullptr_t GSL_SUPPRESS(type.6) // NO-FORMAT: attribute // TODO: false positive constexpr multi_span() noexcept : multi_span(nullptr, bounds_type{}) { static_assert(bounds_type::dynamic_rank != 0 || (bounds_type::dynamic_rank == 0 && bounds_type::static_size == 0), "Default construction of multi_span only possible " "for dynamic or fixed, zero-length spans."); } // construct from nullptr - get an empty multi_span GSL_SUPPRESS(type.6) // NO-FORMAT: attribute // TODO: false positive constexpr multi_span(std::nullptr_t) noexcept : multi_span(nullptr, bounds_type{}) { static_assert(bounds_type::dynamic_rank != 0 || (bounds_type::dynamic_rank == 0 && bounds_type::static_size == 0), "nullptr_t construction of multi_span only possible " "for dynamic or fixed, zero-length spans."); } // construct from nullptr with size of 0 (helps with template function calls) template ::value>> // GSL_SUPPRESS(type.6) // NO-FORMAT: attribute // TODO: false positive // TODO: parser bug constexpr multi_span(std::nullptr_t, IntType size) : multi_span(nullptr, bounds_type{}) { static_assert(bounds_type::dynamic_rank != 0 || (bounds_type::dynamic_rank == 0 && bounds_type::static_size == 0), "nullptr_t construction of multi_span only possible " "for dynamic or fixed, zero-length spans."); Expects(size == 0); } // construct from a single element GSL_SUPPRESS(type.6) // NO-FORMAT: attribute // TODO: false positive constexpr multi_span(reference data) noexcept : multi_span(&data, bounds_type{1}) { static_assert(bounds_type::dynamic_rank > 0 || bounds_type::static_size == 0 || bounds_type::static_size == 1, "Construction from a single element only possible " "for dynamic or fixed spans of length 0 or 1."); } // prevent constructing from temporaries for single-elements constexpr multi_span(value_type &&) = delete; // construct from pointer + length GSL_SUPPRESS(type.6) // NO-FORMAT: attribute // TODO: false positive constexpr multi_span(pointer ptr, size_type size) : multi_span(ptr, bounds_type{size}) {} // construct from pointer + length - multidimensional constexpr multi_span(pointer data, bounds_type bounds) : data_(data), bounds_(std::move(bounds)) { Expects((bounds_.size() > 0 && data != nullptr) || bounds_.size() == 0); } // construct from begin,end pointer pair template ::value && details::LessThan::value>> constexpr multi_span(pointer begin, Ptr end) : multi_span(begin, details::newBoundsHelper(static_cast(end) - begin)) { Expects(begin != nullptr && end != nullptr && begin <= static_cast(end)); } // construct from n-dimensions static array template > constexpr multi_span(T(&arr)[N]) : multi_span(reinterpret_cast(arr), bounds_type{typename Helper::bounds_type{}}) { static_assert(std::is_convertible::value, "Cannot convert from source type to target multi_span type."); static_assert(std::is_convertible::value, "Cannot construct a multi_span from an array with fewer elements."); } // construct from n-dimensions dynamic array (e.g. new int[m][4]) // (precedence will be lower than the 1-dimension pointer) template > constexpr multi_span(T* const& data, size_type size) : multi_span(reinterpret_cast(data), typename Helper::bounds_type{size}) { static_assert(std::is_convertible::value, "Cannot convert from source type to target multi_span type."); } // construct from std::array template constexpr multi_span(std::array & arr) : multi_span(arr.data(), bounds_type{static_bounds{}}) { static_assert( std::is_convertible(*)[]>::value, "Cannot convert from source type to target multi_span type."); static_assert(std::is_convertible, bounds_type>::value, "You cannot construct a multi_span from a std::array of smaller size."); } // construct from const std::array template constexpr multi_span(const std::array& arr) : multi_span(arr.data(), bounds_type{static_bounds{}}) { static_assert( std::is_convertible(*)[]>::value, "Cannot convert from source type to target multi_span type."); static_assert(std::is_convertible, bounds_type>::value, "You cannot construct a multi_span from a std::array of smaller size."); } // prevent constructing from temporary std::array template constexpr multi_span(std::array && arr) = delete; // construct from containers // future: could use contiguous_iterator_traits to identify only contiguous containers // type-requirements: container must have .size(), operator[] which are value_type compatible template ::value && std::is_convertible::value && std::is_same().size(), *std::declval().data())>, DataType>::value>> constexpr multi_span(Cont & cont) : multi_span(static_cast(cont.data()), details::newBoundsHelper(narrow_cast(cont.size()))) {} // prevent constructing from temporary containers template ::value && std::is_convertible::value && std::is_same().size(), *std::declval().data())>, DataType>::value>> explicit constexpr multi_span(Cont && cont) = delete; // construct from a convertible multi_span template , typename = std::enable_if_t::value && std::is_convertible::value>> constexpr multi_span(multi_span other) : data_(other.data_), bounds_(other.bounds_) {} // trivial copy and move constexpr multi_span(const multi_span&) = default; constexpr multi_span(multi_span &&) = default; // trivial assignment constexpr multi_span& operator=(const multi_span&) = default; constexpr multi_span& operator=(multi_span&&) = default; // first() - extract the first Count elements into a new multi_span template constexpr multi_span first() const { static_assert(Count >= 0, "Count must be >= 0."); static_assert(bounds_type::static_size == dynamic_range || Count <= bounds_type::static_size, "Count is out of bounds."); Expects(bounds_type::static_size != dynamic_range || Count <= this->size()); return {this->data(), Count}; } // first() - extract the first count elements into a new multi_span constexpr multi_span first(size_type count) const { Expects(count >= 0 && count <= this->size()); return {this->data(), count}; } // last() - extract the last Count elements into a new multi_span template constexpr multi_span last() const { static_assert(Count >= 0, "Count must be >= 0."); static_assert(bounds_type::static_size == dynamic_range || Count <= bounds_type::static_size, "Count is out of bounds."); Expects(bounds_type::static_size != dynamic_range || Count <= this->size()); return {this->data() + this->size() - Count, Count}; } // last() - extract the last count elements into a new multi_span constexpr multi_span last(size_type count) const { Expects(count >= 0 && count <= this->size()); return {this->data() + this->size() - count, count}; } // subspan() - create a subview of Count elements starting at Offset template constexpr multi_span subspan() const { static_assert(Count >= 0, "Count must be >= 0."); static_assert(Offset >= 0, "Offset must be >= 0."); static_assert(bounds_type::static_size == dynamic_range || ((Offset <= bounds_type::static_size) && Count <= bounds_type::static_size - Offset), "You must describe a sub-range within bounds of the multi_span."); Expects(bounds_type::static_size != dynamic_range || (Offset <= this->size() && Count <= this->size() - Offset)); return {this->data() + Offset, Count}; } // subspan() - create a subview of count elements starting at offset // supplying dynamic_range for count will consume all available elements from offset constexpr multi_span subspan(size_type offset, size_type count = dynamic_range) const { Expects((offset >= 0 && offset <= this->size()) && (count == dynamic_range || (count <= this->size() - offset))); return {this->data() + offset, count == dynamic_range ? this->length() - offset : count}; } // section - creates a non-contiguous, strided multi_span from a contiguous one constexpr strided_span section(index_type origin, index_type extents) const { const size_type size = this->bounds().total_size() - this->bounds().linearize(origin); return {&this->operator[](origin), size, strided_bounds{extents, details::make_stride(bounds())}}; } // length of the multi_span in elements constexpr size_type size() const noexcept { return bounds_.size(); } // length of the multi_span in elements constexpr size_type length() const noexcept { return this->size(); } // length of the multi_span in bytes constexpr size_type size_bytes() const noexcept { return narrow_cast(sizeof(value_type)) * this->size(); } // length of the multi_span in bytes constexpr size_type length_bytes() const noexcept { return this->size_bytes(); } constexpr bool empty() const noexcept { return this->size() == 0; } static constexpr std::size_t rank() { return Rank; } template constexpr size_type extent() const noexcept { static_assert(Dim < Rank, "Dimension should be less than rank (dimension count starts from 0)."); return bounds_.template extent(); } template constexpr size_type extent(IntType dim) const { return bounds_.extent(dim); } constexpr bounds_type bounds() const noexcept { return bounds_; } constexpr pointer data() const noexcept { return data_; } template constexpr reference operator()(FirstIndex idx) { return this->operator[](narrow_cast(idx)); } template constexpr reference operator()(FirstIndex firstIndex, OtherIndices... indices) { const index_type idx = {narrow_cast(firstIndex), narrow_cast(indices)...}; return this->operator[](idx); } GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute constexpr reference operator[](const index_type& idx) const { return data_[bounds_.linearize(idx)]; } template 1), typename Ret = std::enable_if_t> GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute constexpr Ret operator[](size_type idx) const { Expects(idx >= 0 && idx < bounds_.size()); // index is out of bounds of the array const size_type ridx = idx * bounds_.stride(); // index is out of bounds of the underlying data Expects(ridx < bounds_.total_size()); return Ret{data_ + ridx, bounds_.slice()}; } constexpr iterator begin() const noexcept { return iterator{this, true}; } constexpr iterator end() const noexcept { return iterator{this, false}; } GSL_SUPPRESS(type.1) // NO-FORMAT: attribute constexpr const_iterator cbegin() const noexcept { return const_iterator{reinterpret_cast(this), true}; } constexpr const_iterator cend() const noexcept { return const_iterator{reinterpret_cast(this), false}; } constexpr reverse_iterator rbegin() const noexcept { return reverse_iterator{end()}; } constexpr reverse_iterator rend() const noexcept { return reverse_iterator{begin()}; } constexpr const_reverse_iterator crbegin() const noexcept { return const_reverse_iterator{cend()}; } constexpr const_reverse_iterator crend() const noexcept { return const_reverse_iterator{cbegin()}; } template , std::remove_cv_t>::value>> constexpr bool operator==(const multi_span& other) const { return bounds_.size() == other.bounds_.size() && (data_ == other.data_ || std::equal(this->begin(), this->end(), other.begin())); } template , std::remove_cv_t>::value>> constexpr bool operator!=(const multi_span& other) const { return !(*this == other); } template , std::remove_cv_t>::value>> constexpr bool operator<(const multi_span& other) const { return std::lexicographical_compare(this->begin(), this->end(), other.begin(), other.end()); } template , std::remove_cv_t>::value>> constexpr bool operator<=(const multi_span& other) const { return !(other < *this); } template , std::remove_cv_t>::value>> constexpr bool operator>(const multi_span& other) const noexcept { return (other < *this); } template , std::remove_cv_t>::value>> constexpr bool operator>=(const multi_span& other) const { return !(*this < other); } }; // // Free functions for manipulating spans // // reshape a multi_span into a different dimensionality // DimCount and Enabled here are workarounds for a bug in MSVC 2015 template 0), typename = std::enable_if_t> constexpr auto as_multi_span(SpanType s, Dimensions2... dims) -> multi_span { static_assert(details::is_multi_span::value, "Variadic as_multi_span() is for reshaping existing spans."); using BoundsType = typename multi_span::bounds_type; const auto tobounds = details::static_as_multi_span_helper(dims..., details::Sep{}); details::verifyBoundsReshape(s.bounds(), tobounds); return {s.data(), tobounds}; } // convert a multi_span to a multi_span template multi_span as_bytes(multi_span s) noexcept { static_assert(std::is_trivial>::value, "The value_type of multi_span must be a trivial type."); return {reinterpret_cast(s.data()), s.size_bytes()}; } // convert a multi_span to a multi_span (a writeable byte multi_span) // this is not currently a portable function that can be relied upon to work // on all implementations. It should be considered an experimental extension // to the standard GSL interface. template multi_span as_writeable_bytes(multi_span s) noexcept { static_assert(std::is_trivial>::value, "The value_type of multi_span must be a trivial type."); return {reinterpret_cast(s.data()), s.size_bytes()}; } // convert a multi_span to a multi_span // this is not currently a portable function that can be relied upon to work // on all implementations. It should be considered an experimental extension // to the standard GSL interface. template constexpr auto as_multi_span(multi_span s) -> multi_span< const U, static_cast( multi_span::bounds_type::static_size != dynamic_range ? (static_cast( multi_span::bounds_type::static_size) / sizeof(U)) : dynamic_range)> { using ConstByteSpan = multi_span; static_assert( std::is_trivial>::value && (ConstByteSpan::bounds_type::static_size == dynamic_range || ConstByteSpan::bounds_type::static_size % narrow_cast(sizeof(U)) == 0), "Target type must be a trivial type and its size must match the byte array size"); Expects((s.size_bytes() % narrow_cast(sizeof(U))) == 0 && (s.size_bytes() / narrow_cast(sizeof(U))) < PTRDIFF_MAX); return {reinterpret_cast(s.data()), s.size_bytes() / narrow_cast(sizeof(U))}; } // convert a multi_span to a multi_span // this is not currently a portable function that can be relied upon to work // on all implementations. It should be considered an experimental extension // to the standard GSL interface. template constexpr auto as_multi_span(multi_span s) -> multi_span( multi_span::bounds_type::static_size != dynamic_range ? static_cast( multi_span::bounds_type::static_size) / sizeof(U) : dynamic_range)> { using ByteSpan = multi_span; static_assert(std::is_trivial>::value && (ByteSpan::bounds_type::static_size == dynamic_range || ByteSpan::bounds_type::static_size % sizeof(U) == 0), "Target type must be a trivial type and its size must match the byte array size"); Expects((s.size_bytes() % sizeof(U)) == 0); return {reinterpret_cast(s.data()), s.size_bytes() / narrow_cast(sizeof(U))}; } template constexpr auto as_multi_span(T* const& ptr, dim_t... args) -> multi_span, Dimensions...> { return {reinterpret_cast*>(ptr), details::static_as_multi_span_helper>(args..., details::Sep{})}; } template constexpr auto as_multi_span(T* arr, std::ptrdiff_t len) -> typename details::SpanArrayTraits::type { return {reinterpret_cast*>(arr), len}; } template constexpr auto as_multi_span(T (&arr)[N]) -> typename details::SpanArrayTraits::type { return {arr}; } template constexpr multi_span as_multi_span(const std::array& arr) { return {arr}; } template constexpr multi_span as_multi_span(const std::array&&) = delete; template constexpr multi_span as_multi_span(std::array& arr) { return {arr}; } template constexpr multi_span as_multi_span(T* begin, T* end) { return {begin, end}; } template constexpr auto as_multi_span(Cont& arr) -> std::enable_if_t< !details::is_multi_span>::value, multi_span, dynamic_range>> { Expects(arr.size() < PTRDIFF_MAX); return {arr.data(), narrow_cast(arr.size())}; } template constexpr auto as_multi_span(Cont&& arr) -> std::enable_if_t< !details::is_multi_span>::value, multi_span, dynamic_range>> = delete; // from basic_string which doesn't have nonconst .data() member like other contiguous containers template GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute constexpr auto as_multi_span(std::basic_string& str) -> multi_span { Expects(str.size() < PTRDIFF_MAX); return {&str[0], narrow_cast(str.size())}; } // strided_span is an extension that is not strictly part of the GSL at this time. // It is kept here while the multidimensional interface is still being defined. template class [[deprecated]] strided_span { public: using bounds_type = strided_bounds; 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 = std::add_pointer_t; using reference = std::add_lvalue_reference_t; using iterator = general_span_iterator; using const_strided_span = strided_span; using const_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 data_; bounds_type bounds_; friend iterator; friend const_iterator; template friend class strided_span; public: // from raw data constexpr strided_span(pointer ptr, size_type size, bounds_type bounds) : data_(ptr), bounds_(std::move(bounds)) { Expects((bounds_.size() > 0 && ptr != nullptr) || bounds_.size() == 0); // Bounds cross data boundaries Expects(this->bounds().total_size() <= size); GSL_SUPPRESS(type.4) // NO-FORMAT: attribute // TODO: false positive (void) size; } // from static array of size N template constexpr strided_span(value_type (&values)[N], bounds_type bounds) : strided_span(values, N, std::move(bounds)) {} // from array view template ::value, typename = std::enable_if_t> constexpr strided_span(multi_span av, bounds_type bounds) : strided_span(av.data(), av.bounds().total_size(), std::move(bounds)) {} // convertible template ::value>> constexpr strided_span(const strided_span& other) : data_(other.data_), bounds_(other.bounds_) {} // convert from bytes template constexpr strided_span< typename std::enable_if::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 = narrow_cast(sizeof(OtherValueType) / sizeof(value_type)); const size_type size = this->bounds().total_size() / d; GSL_SUPPRESS(type.3) // NO-FORMAT: attribute return {const_cast(reinterpret_cast(this->data())), size, bounds_type{resize_extent(this->bounds().index_bounds(), d), resize_stride(this->bounds().strides(), d)}}; } constexpr strided_span section(index_type origin, index_type extents) const { const size_type size = this->bounds().total_size() - this->bounds().linearize(origin); return {&this->operator[](origin), size, bounds_type{extents, details::make_stride(bounds())}}; } GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute constexpr reference operator[](const index_type& idx) const { return data_[bounds_.linearize(idx)]; } template 1), typename Ret = std::enable_if_t> GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute constexpr Ret operator[](size_type idx) const { Expects(idx < bounds_.size()); // index is out of bounds of the array const size_type ridx = idx * bounds_.stride(); // index is out of bounds of the underlying data Expects(ridx < bounds_.total_size()); return {data_ + ridx, bounds_.slice().total_size(), bounds_.slice()}; } constexpr bounds_type bounds() const noexcept { return bounds_; } template constexpr size_type extent() const noexcept { static_assert(Dim < Rank, "dimension should be less than Rank (dimension count starts from 0)"); return bounds_.template extent(); } constexpr size_type size() const noexcept { return bounds_.size(); } constexpr pointer data() const noexcept { return data_; } constexpr bool empty() const noexcept { return this->size() == 0; } constexpr explicit operator bool() const noexcept { return data_ != 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 strided_span& other) const { return bounds_.size() == other.bounds_.size() && (data_ == other.data_ || std::equal(this->begin(), this->end(), other.begin())); } template , std::remove_cv_t>::value>> constexpr bool operator!=(const strided_span& other) const { return !(*this == other); } template , std::remove_cv_t>::value>> constexpr bool operator<(const strided_span& other) const { return std::lexicographical_compare(this->begin(), this->end(), other.begin(), other.end()); } template , std::remove_cv_t>::value>> constexpr bool operator<=(const strided_span& other) const { return !(other < *this); } template , std::remove_cv_t>::value>> constexpr bool operator>(const strided_span& other) const { return (other < *this); } template , std::remove_cv_t>::value>> constexpr bool operator>=(const strided_span& other) const { return !(*this < other); } private: static index_type resize_extent(const index_type& extent, std::ptrdiff_t d) { // The last dimension of the array needs to contain a multiple of new type elements GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute Expects(extent[Rank - 1] >= d && (extent[Rank - 1] % d == 0)); index_type ret = extent; ret[Rank - 1] /= d; return ret; } template > static index_type resize_stride(const index_type& strides, std::ptrdiff_t, void* = nullptr) { // Only strided arrays with regular strides can be resized GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute Expects(strides[Rank - 1] == 1); return strides; } template 1), typename = std::enable_if_t> GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute static index_type resize_stride(const index_type& strides, std::ptrdiff_t d) { // Only strided arrays with regular strides can be resized Expects(strides[Rank - 1] == 1); // The strides must have contiguous chunks of // memory that can contain a multiple of new type elements Expects(strides[Rank - 2] >= d && (strides[Rank - 2] % d == 0)); for (std::size_t i = Rank - 1; i > 0; --i) { // Only strided arrays with regular strides can be resized Expects((strides[i - 1] >= strides[i]) && (strides[i - 1] % strides[i] == 0)); } index_type ret = strides / d; ret[Rank - 1] = 1; return ret; } }; template class [[deprecated]] contiguous_span_iterator { public: using iterator_category = std::random_access_iterator_tag; using value_type = typename Span::value_type; using difference_type = std::ptrdiff_t; using pointer = value_type*; using reference = value_type&; private: template friend class multi_span; pointer data_; const Span* m_validator; GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute void validateThis() const { // iterator is out of range of the array Expects(data_ >= m_validator->data_ && data_ < m_validator->data_ + m_validator->size()); } GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute contiguous_span_iterator(const Span* container, bool isbegin) : data_(isbegin ? container->data_ : container->data_ + container->size()) , m_validator(container) {} public: reference operator*() const { validateThis(); return *data_; } pointer operator->() const { validateThis(); return data_; } GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute contiguous_span_iterator& operator++() noexcept { ++data_; return *this; } contiguous_span_iterator operator++(int) noexcept { auto ret = *this; ++(*this); return ret; } GSL_SUPPRESS(bounds.1) // NO-FORMAT: attribute contiguous_span_iterator& operator--() noexcept { --data_; 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 { data_ += 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) { return *this += -n; } difference_type operator-(const contiguous_span_iterator& rhs) const { Expects(m_validator == rhs.m_validator); return data_ - rhs.data_; } reference operator[](difference_type n) const { return *(*this + n); } bool operator==(const contiguous_span_iterator& rhs) const { Expects(m_validator == rhs.m_validator); return data_ == rhs.data_; } bool operator!=(const contiguous_span_iterator& rhs) const { return !(*this == rhs); } bool operator<(const contiguous_span_iterator& rhs) const { Expects(m_validator == rhs.m_validator); return data_ < rhs.data_; } bool operator<=(const contiguous_span_iterator& rhs) const { return !(rhs < *this); } bool operator>(const contiguous_span_iterator& rhs) const { return rhs < *this; } bool operator>=(const contiguous_span_iterator& rhs) const { return !(rhs > *this); } void swap(contiguous_span_iterator & rhs) noexcept { std::swap(data_, rhs.data_); 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 [[deprecated]] general_span_iterator { public: using iterator_category = std::random_access_iterator_tag; using value_type = typename Span::value_type; using difference_type = std::ptrdiff_t; using pointer = value_type*; using reference = value_type&; private: template friend class strided_span; const Span* m_container; typename Span::bounds_type::iterator m_itr; general_span_iterator(const Span* 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 { Expects(m_container == rhs.m_container); return m_itr - rhs.m_itr; } GSL_SUPPRESS(bounds.4) // NO-FORMAT: attribute value_type operator[](difference_type n) const { return (*m_container)[m_itr[n]]; } bool operator==(const general_span_iterator& rhs) const { Expects(m_container == rhs.m_container); return m_itr == rhs.m_itr; } bool operator!=(const general_span_iterator& rhs) const { return !(*this == rhs); } bool operator<(const general_span_iterator& rhs) const { Expects(m_container == rhs.m_container); return m_itr < rhs.m_itr; } bool operator<=(const general_span_iterator& rhs) const { return !(rhs < *this); } bool operator>(const general_span_iterator& rhs) const { return rhs < *this; } bool operator>=(const general_span_iterator& rhs) const { 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 #if defined(_MSC_VER) && !defined(__clang__) #if _MSC_VER < 1910 #undef constexpr #pragma pop_macro("constexpr") #endif // _MSC_VER < 1910 #pragma warning(pop) #endif // _MSC_VER #if defined(__GNUC__) && __GNUC__ > 6 #pragma GCC diagnostic pop #endif // __GNUC__ > 6 #endif // GSL_MULTI_SPAN_H