Intel xvec
Experimental C++ simd class library
Loading...
Searching...
No Matches
xvec::simd::simd_iterator< _Simd > Class Template Reference

xvec implementation of the exposition-only SIMD iterator. More...

#include <iterator.hpp>

Public Types

using value_type = typename _Simd::value_type
using iterator_category = std::input_iterator_tag
using iterator_concept = std::random_access_iterator_tag
using difference_type = simd_size_type

Public Member Functions

constexpr simd_iterator ()=default
 Default-construct an iterator.
constexpr simd_iterator (const simd_iterator &)=default
 Copy an iterator.
constexpr simd_iterator (_Simd &s, simd_size_type x)
 Construct an iterator at element x of s.
constexpr simd_iterator & operator= (const simd_iterator &)=default
 Copy-assign an iterator.
constexpr simd_iterator (const simd_iterator< std::remove_const_t< _Simd > > &i)
 Convert a mutable iterator to a const iterator.
constexpr value_type operator* () const
 Return the current element.
constexpr value_type operator[] (difference_type i) const
 Return the element at the specified relative offset.
constexpr simd_iterator & operator++ ()
 Advance to the next element.
constexpr simd_iterator & operator-- ()
 Move to the previous element.
constexpr simd_iterator operator++ (int)
 Advance to the next element, returning the original iterator.
constexpr simd_iterator operator-- (int)
 Move to the previous element, returning the original iterator.
constexpr difference_type operator- (simd_iterator rhs) const
 Return the distance from another iterator.
constexpr simd_iterator & operator+= (difference_type x)
 Advance by the specified offset.
constexpr simd_iterator & operator-= (difference_type x)
 Move backward by the specified offset.

Public Attributes

_Simd * data = nullptr
simd_size_type index = 0

Friends

constexpr simd_iterator operator+ (difference_type x, const simd_iterator &it)
 Return an iterator advanced by the specified offset.
constexpr simd_iterator operator+ (const simd_iterator &it, difference_type x)
 Return an iterator advanced by the specified offset.
constexpr simd_iterator operator- (const simd_iterator &it, difference_type x)
 Return an iterator moved backward by the specified offset.
constexpr auto operator<=> (simd_iterator a, simd_iterator b)
 Compare iterator positions.
constexpr bool operator== (simd_iterator a, simd_iterator b)=default
 Test iterator equality.
constexpr bool operator== (simd_iterator a, std::default_sentinel_t) noexcept
 Test whether the iterator has reached the end.
constexpr difference_type operator- (simd_iterator a, std::default_sentinel_t) noexcept
 Return the signed distance from the end sentinel.
constexpr difference_type operator- (std::default_sentinel_t, simd_iterator a) noexcept
 Return the number of elements remaining before the end sentinel.

Detailed Description

template<vec_or_mask_type _Simd>
class xvec::simd::simd_iterator< _Simd >

xvec implementation of the exposition-only SIMD iterator.

Template Parameters
_SimdThe vector or mask type being traversed.

Member Data Documentation

◆ data

template<vec_or_mask_type _Simd>
_Simd* xvec::simd::simd_iterator< _Simd >::data = nullptr

The simd object over which iteration is happening.

◆ index

template<vec_or_mask_type _Simd>
simd_size_type xvec::simd::simd_iterator< _Simd >::index = 0

The current position of the iterator within the simd being iterated.


The documentation for this class was generated from the following file: