Intel xvec
Experimental C++ simd class library
Loading...
Searching...
No Matches
iterator.hpp
1//===----------------------------------------------------------------------===//
2//
3// Copyright (C) 2021 Intel Corporation
4//
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#pragma once
10
11#include <xvec/detail/config.hpp>
12
13#include <compare>
14#include <iterator> // std::random_access_iterator_tag
15#include <type_traits>
16
17namespace _XVEC_NAMESPACE::simd
18{
19
27
30template <vec_or_mask_type _Simd>
32{
33public:
34
37 _Simd* data = nullptr;
38
41 simd_size_type index = 0;
42
43 // Traits
44 using value_type = typename _Simd::value_type;
45 using iterator_category = std::input_iterator_tag;
46 using iterator_concept = std::random_access_iterator_tag;
47 using difference_type = simd_size_type;
48
50 constexpr simd_iterator() = default;
51
53 constexpr simd_iterator(const simd_iterator&) = default;
54
56 constexpr simd_iterator(_Simd& s, simd_size_type x) : data(std::addressof(s)), index(x) {}
57
59 constexpr simd_iterator& operator=(const simd_iterator&) = default;
60
62 constexpr simd_iterator(const simd_iterator<std::remove_const_t<_Simd>>& i)
63 requires std::is_const_v<_Simd> : data(i.data), index(i.index) {}
64
66 constexpr value_type operator*() const { return (*data)[index]; }
68 constexpr value_type operator[](difference_type i) const { return (*data)[index + i]; }
69
71 constexpr simd_iterator& operator++() { index += 1; return *this; }
72
74 constexpr simd_iterator& operator--() { index -= 1; return *this; }
75
78 {
79 simd_iterator i = *this;
80 index += 1;
81 return i;
82 }
83
85 constexpr simd_iterator
87 {
88 simd_iterator i = *this;
89 index -= 1;
90 return i;
91 }
92
94 constexpr difference_type operator-(simd_iterator rhs) const { return index - rhs.index; }
95
97 friend constexpr simd_iterator operator+(difference_type x, const simd_iterator& it) { return simd_iterator(*it.data, it.index + x); }
98
100 friend constexpr simd_iterator operator+(const simd_iterator& it, difference_type x) { return simd_iterator(*it.data, it.index + x); }
101
103 friend constexpr simd_iterator operator-(const simd_iterator& it, difference_type x) { return simd_iterator(*it.data, it.index - x); }
104
106 constexpr simd_iterator& operator+=(difference_type x) { index += x; return *this; }
107
109 constexpr simd_iterator& operator-=(difference_type x) { index -= x; return *this; }
110
112 friend constexpr auto operator<=>(simd_iterator a, simd_iterator b) { return a.index <=> b.index; }
113
115 friend constexpr bool operator==(simd_iterator a, simd_iterator b) = default;
116
118 friend constexpr bool operator==(simd_iterator a, std::default_sentinel_t) noexcept
119 { return a.index == static_cast<difference_type>(_Simd::size()); }
120
122 friend constexpr difference_type operator-(simd_iterator a, std::default_sentinel_t) noexcept
123 { return a.index - static_cast<difference_type>(_Simd::size()); }
124
125 friend constexpr difference_type operator-(std::default_sentinel_t, simd_iterator a) noexcept
126 { return static_cast<difference_type>(_Simd::size()) - a.index; }
127};
128
130
131}
xvec implementation of the exposition-only SIMD iterator.
Definition iterator.hpp:32
friend constexpr bool operator==(simd_iterator a, simd_iterator b)=default
Test iterator equality.
constexpr value_type operator*() const
Return the current element.
Definition iterator.hpp:66
constexpr simd_iterator operator--(int)
Move to the previous element, returning the original iterator.
Definition iterator.hpp:86
_Simd * data
Definition iterator.hpp:37
constexpr value_type operator[](difference_type i) const
Return the element at the specified relative offset.
Definition iterator.hpp:68
friend constexpr bool operator==(simd_iterator a, std::default_sentinel_t) noexcept
Test whether the iterator has reached the end.
Definition iterator.hpp:118
constexpr simd_iterator & operator+=(difference_type x)
Advance by the specified offset.
Definition iterator.hpp:106
friend constexpr difference_type operator-(simd_iterator a, std::default_sentinel_t) noexcept
Return the signed distance from the end sentinel.
Definition iterator.hpp:122
constexpr simd_iterator(const simd_iterator< std::remove_const_t< _Simd > > &i)
Convert a mutable iterator to a const iterator.
Definition iterator.hpp:62
friend constexpr auto operator<=>(simd_iterator a, simd_iterator b)
Compare iterator positions.
Definition iterator.hpp:112
constexpr simd_iterator & operator--()
Move to the previous element.
Definition iterator.hpp:74
constexpr simd_iterator & operator++()
Advance to the next element.
Definition iterator.hpp:71
constexpr simd_iterator operator++(int)
Advance to the next element, returning the original iterator.
Definition iterator.hpp:77
constexpr difference_type operator-(simd_iterator rhs) const
Return the distance from another iterator.
Definition iterator.hpp:94
simd_size_type index
Definition iterator.hpp:41
constexpr simd_iterator & operator=(const simd_iterator &)=default
Copy-assign an iterator.
constexpr simd_iterator(const simd_iterator &)=default
Copy an iterator.
friend constexpr simd_iterator operator-(const simd_iterator &it, difference_type x)
Return an iterator moved backward by the specified offset.
Definition iterator.hpp:103
friend constexpr difference_type operator-(std::default_sentinel_t, simd_iterator a) noexcept
Return the number of elements remaining before the end sentinel.
Definition iterator.hpp:125
friend constexpr simd_iterator operator+(const simd_iterator &it, difference_type x)
Return an iterator advanced by the specified offset.
Definition iterator.hpp:100
friend constexpr simd_iterator operator+(difference_type x, const simd_iterator &it)
Return an iterator advanced by the specified offset.
Definition iterator.hpp:97
constexpr simd_iterator(_Simd &s, simd_size_type x)
Construct an iterator at element x of s.
Definition iterator.hpp:56
constexpr simd_iterator()=default
Default-construct an iterator.
constexpr simd_iterator & operator-=(difference_type x)
Move backward by the specified offset.
Definition iterator.hpp:109