xtensor
Loading...
Searching...
No Matches
xt::xiterator< St, S, L > Class Template Reference
Inheritance diagram for xt::xiterator< St, S, L >:

Public Types

using self_type = xiterator<St, S, L>
using stepper_type = St
using value_type = typename stepper_type::value_type
using reference = typename stepper_type::reference
using pointer = typename stepper_type::pointer
using difference_type = typename stepper_type::difference_type
using size_type = typename stepper_type::size_type
using iterator_category = std::random_access_iterator_tag
using private_base = detail::shape_storage<S>
using shape_type = typename private_base::shape_type
using shape_param_type = typename private_base::param_type
using index_type = xindex_type_t<shape_type>

Public Member Functions

 xiterator (St st, shape_param_type shape, bool end_index)
self_type & operator++ ()
self_type & operator-- ()
self_type & operator+= (difference_type n)
self_type & operator-= (difference_type n)
difference_type operator- (const self_type &rhs) const
reference operator* () const
pointer operator-> () const
bool equal (const xiterator &rhs) const
bool less_than (const xiterator &rhs) const

Detailed Description

template<class St, class S, layout_type L>
class xt::xiterator< St, S, L >

Definition at line 286 of file xiterator.hpp.

Member Typedef Documentation

◆ difference_type

template<class St, class S, layout_type L>
using xt::xiterator< St, S, L >::difference_type = typename stepper_type::difference_type

Definition at line 302 of file xiterator.hpp.

◆ index_type

template<class St, class S, layout_type L>
using xt::xiterator< St, S, L >::index_type = xindex_type_t<shape_type>

Definition at line 309 of file xiterator.hpp.

◆ iterator_category

template<class St, class S, layout_type L>
using xt::xiterator< St, S, L >::iterator_category = std::random_access_iterator_tag

Definition at line 304 of file xiterator.hpp.

◆ pointer

template<class St, class S, layout_type L>
using xt::xiterator< St, S, L >::pointer = typename stepper_type::pointer

Definition at line 301 of file xiterator.hpp.

◆ private_base

template<class St, class S, layout_type L>
using xt::xiterator< St, S, L >::private_base = detail::shape_storage<S>

Definition at line 306 of file xiterator.hpp.

◆ reference

template<class St, class S, layout_type L>
using xt::xiterator< St, S, L >::reference = typename stepper_type::reference

Definition at line 300 of file xiterator.hpp.

◆ self_type

template<class St, class S, layout_type L>
using xt::xiterator< St, S, L >::self_type = xiterator<St, S, L>

Definition at line 296 of file xiterator.hpp.

◆ shape_param_type

template<class St, class S, layout_type L>
using xt::xiterator< St, S, L >::shape_param_type = typename private_base::param_type

Definition at line 308 of file xiterator.hpp.

◆ shape_type

template<class St, class S, layout_type L>
using xt::xiterator< St, S, L >::shape_type = typename private_base::shape_type

Definition at line 307 of file xiterator.hpp.

◆ size_type

template<class St, class S, layout_type L>
using xt::xiterator< St, S, L >::size_type = typename stepper_type::size_type

Definition at line 303 of file xiterator.hpp.

◆ stepper_type

template<class St, class S, layout_type L>
using xt::xiterator< St, S, L >::stepper_type = St

Definition at line 298 of file xiterator.hpp.

◆ value_type

template<class St, class S, layout_type L>
using xt::xiterator< St, S, L >::value_type = typename stepper_type::value_type

Definition at line 299 of file xiterator.hpp.

Constructor & Destructor Documentation

◆ xiterator()

template<class St, class S, layout_type L>
xt::xiterator< St, S, L >::xiterator ( St st,
shape_param_type shape,
bool end_index )
inline

Definition at line 1084 of file xiterator.hpp.

Member Function Documentation

◆ equal()

template<class St, class S, layout_type L>
bool xt::xiterator< St, S, L >::equal ( const xiterator< St, S, L > & rhs) const
inline

Definition at line 1184 of file xiterator.hpp.

◆ less_than()

template<class St, class S, layout_type L>
bool xt::xiterator< St, S, L >::less_than ( const xiterator< St, S, L > & rhs) const
inline

Definition at line 1191 of file xiterator.hpp.

◆ operator*()

template<class St, class S, layout_type L>
auto xt::xiterator< St, S, L >::operator* ( ) const
inline

Definition at line 1172 of file xiterator.hpp.

◆ operator++()

template<class St, class S, layout_type L>
auto xt::xiterator< St, S, L >::operator++ ( )
inline

Definition at line 1120 of file xiterator.hpp.

◆ operator+=()

template<class St, class S, layout_type L>
auto xt::xiterator< St, S, L >::operator+= ( difference_type n)
inline

Definition at line 1136 of file xiterator.hpp.

◆ operator-()

template<class St, class S, layout_type L>
auto xt::xiterator< St, S, L >::operator- ( const self_type & rhs) const
inline

Definition at line 1166 of file xiterator.hpp.

◆ operator--()

template<class St, class S, layout_type L>
auto xt::xiterator< St, S, L >::operator-- ( )
inline

Definition at line 1128 of file xiterator.hpp.

◆ operator-=()

template<class St, class S, layout_type L>
auto xt::xiterator< St, S, L >::operator-= ( difference_type n)
inline

Definition at line 1151 of file xiterator.hpp.

◆ operator->()

template<class St, class S, layout_type L>
auto xt::xiterator< St, S, L >::operator-> ( ) const
inline

Definition at line 1178 of file xiterator.hpp.

The documentation for this class was generated from the following file:
  • /home/runner/work/xtensor/xtensor/include/xtensor/core/xiterator.hpp