Base class for multidimensional iterable expressions. More...

#include <xiterable.hpp>

Inheritance diagram for xt::xiterable< D >:

Public Types
using	derived_type = D

using	base_type = xconst_iterable<D>

using	inner_shape_type = typename base_type::inner_shape_type

using	stepper = typename base_type::stepper

using	const_stepper = typename base_type::const_stepper

using	linear_iterator = typename base_type::linear_iterator

using	reverse_linear_iterator = typename base_type::reverse_linear_iterator

template<layout_type L>
using	layout_iterator = typename base_type::template layout_iterator<L>

template<layout_type L>
using	const_layout_iterator = typename base_type::template const_layout_iterator<L>

template<layout_type L>
using	reverse_layout_iterator = typename base_type::template reverse_layout_iterator<L>

template<layout_type L>
using	const_reverse_layout_iterator = typename base_type::template const_reverse_layout_iterator<L>

template<class S, layout_type L>
using	broadcast_iterator = typename base_type::template broadcast_iterator<S, L>

template<class S, layout_type L>
using	const_broadcast_iterator = typename base_type::template const_broadcast_iterator<S, L>

template<class S, layout_type L>
using	reverse_broadcast_iterator = typename base_type::template reverse_broadcast_iterator<S, L>

template<class S, layout_type L>
using	const_reverse_broadcast_iterator = typename base_type::template const_reverse_broadcast_iterator<S, L>

using	iterator = typename base_type::iterator

using	const_iterator = typename base_type::const_iterator

using	reverse_iterator = typename base_type::reverse_iterator

using	const_reverse_iterator = typename base_type::const_reverse_iterator

Public Types inherited from xt::xconst_iterable< D >
using	derived_type = D

using	iterable_types = xiterable_inner_types<D>

using	inner_shape_type = typename iterable_types::inner_shape_type

using	stepper = typename iterable_types::stepper

using	const_stepper = typename iterable_types::const_stepper

template<layout_type L>
using	layout_iterator = xiterator<stepper, inner_shape_type*, L>

template<layout_type L>
using	const_layout_iterator = xiterator<const_stepper, inner_shape_type*, L>

template<layout_type L>
using	reverse_layout_iterator = std::reverse_iterator<layout_iterator<L>>

template<layout_type L>
using	const_reverse_layout_iterator = std::reverse_iterator<const_layout_iterator<L>>

using	linear_iterator = layout_iterator< ::xt::layout_type::row_major >

using	const_linear_iterator = const_layout_iterator< ::xt::layout_type::row_major >

using	reverse_linear_iterator = reverse_layout_iterator< ::xt::layout_type::row_major >

using	const_reverse_linear_iterator = const_reverse_layout_iterator< ::xt::layout_type::row_major >

template<class S, layout_type L>
using	broadcast_iterator = xiterator<stepper, S, L>

template<class S, layout_type L>
using	const_broadcast_iterator = xiterator<const_stepper, S, L>

template<class S, layout_type L>
using	reverse_broadcast_iterator = std::reverse_iterator<broadcast_iterator<S, L>>

template<class S, layout_type L>
using	const_reverse_broadcast_iterator = std::reverse_iterator<const_broadcast_iterator<S, L>>

using	iterator = layout_iterator< ::xt::layout_type::row_major >

using	const_iterator = const_layout_iterator< ::xt::layout_type::row_major >

using	reverse_iterator = reverse_layout_iterator< ::xt::layout_type::row_major >

using	const_reverse_iterator = const_reverse_layout_iterator< ::xt::layout_type::row_major >

Public Member Functions
template<layout_type L = ::xt::layout_type::row_major>
layout_iterator< L >	begin () noexcept

template<layout_type L = ::xt::layout_type::row_major>
layout_iterator< L >	end () noexcept

template<layout_type L = ::xt::layout_type::row_major>
reverse_layout_iterator< L >	rbegin () noexcept

template<layout_type L = ::xt::layout_type::row_major>
reverse_layout_iterator< L >	rend () noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
broadcast_iterator< S, L >	begin (const S &shape) noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
broadcast_iterator< S, L >	end (const S &shape) noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
reverse_broadcast_iterator< S, L >	rbegin (const S &shape) noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
reverse_broadcast_iterator< S, L >	rend (const S &shape) noexcept

template<layout_type L = ::xt::layout_type::row_major>
const_layout_iterator< L >	begin () const noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
const_broadcast_iterator< S, L >	begin (const S &shape) const noexcept

template<layout_type L = ::xt::layout_type::row_major>
const_layout_iterator< L >	end () const noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
const_broadcast_iterator< S, L >	end (const S &shape) const noexcept

template<layout_type L = ::xt::layout_type::row_major>
const_reverse_layout_iterator< L >	rbegin () const noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
const_reverse_broadcast_iterator< S, L >	rbegin (const S &shape) const noexcept

template<layout_type L = ::xt::layout_type::row_major>
const_reverse_layout_iterator< L >	rend () const noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
const_reverse_broadcast_iterator< S, L >	rend (const S &shape) const noexcept

Iterators
template<layout_type L>
auto	begin () noexcept -> layout_iterator< L >
	Returns an iterator to the first element of the expression.

template<layout_type L>
auto	end () noexcept -> layout_iterator< L >
	Returns an iterator to the element following the last element of the expression.

Reverse iterators
template<layout_type L>
auto	rbegin () noexcept -> reverse_layout_iterator< L >
	Returns an iterator to the first element of the reversed expression.

template<layout_type L>
auto	rend () noexcept -> reverse_layout_iterator< L >
	Returns an iterator to the element following the last element of the reversed expression.

Broadcast iterators
template<layout_type L, class S>
auto	begin (const S &shape) noexcept -> broadcast_iterator< S, L >
	Returns an iterator to the first element of the expression.

template<layout_type L, class S>
auto	end (const S &shape) noexcept -> broadcast_iterator< S, L >
	Returns an iterator to the element following the last element of the expression.

Public Member Functions inherited from xt::xconst_iterable< D >
template<layout_type L = ::xt::layout_type::row_major>
const_layout_iterator< L >	begin () const noexcept

template<layout_type L = ::xt::layout_type::row_major>
const_layout_iterator< L >	end () const noexcept

template<layout_type L = ::xt::layout_type::row_major>
const_layout_iterator< L >	cbegin () const noexcept

template<layout_type L = ::xt::layout_type::row_major>
const_layout_iterator< L >	cend () const noexcept

template<layout_type L = ::xt::layout_type::row_major>
const_reverse_layout_iterator< L >	rbegin () const noexcept

template<layout_type L = ::xt::layout_type::row_major>
const_reverse_layout_iterator< L >	rend () const noexcept

template<layout_type L = ::xt::layout_type::row_major>
const_reverse_layout_iterator< L >	crbegin () const noexcept

template<layout_type L = ::xt::layout_type::row_major>
const_reverse_layout_iterator< L >	crend () const noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
const_broadcast_iterator< S, L >	begin (const S &shape) const noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
const_broadcast_iterator< S, L >	end (const S &shape) const noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
const_broadcast_iterator< S, L >	cbegin (const S &shape) const noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
const_broadcast_iterator< S, L >	cend (const S &shape) const noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
const_reverse_broadcast_iterator< S, L >	rbegin (const S &shape) const noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
const_reverse_broadcast_iterator< S, L >	rend (const S &shape) const noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
const_reverse_broadcast_iterator< S, L >	crbegin (const S &shape) const noexcept

template<layout_type L = ::xt::layout_type::row_major, class S>
const_reverse_broadcast_iterator< S, L >	crend (const S &shape) const noexcept

template<layout_type L>
auto	begin () const noexcept -> const_layout_iterator< L >
	Returns a constant iterator to the first element of the expression.

template<layout_type L>
auto	end () const noexcept -> const_layout_iterator< L >
	Returns a constant iterator to the element following the last element of the expression.

template<layout_type L>
auto	cbegin () const noexcept -> const_layout_iterator< L >
	Returns a constant iterator to the first element of the expression.

template<layout_type L>
auto	cend () const noexcept -> const_layout_iterator< L >
	Returns a constant iterator to the element following the last element of the expression.

template<layout_type L>
auto	rbegin () const noexcept -> const_reverse_layout_iterator< L >
	Returns a constant iterator to the first element of the reversed expression.

template<layout_type L>
auto	rend () const noexcept -> const_reverse_layout_iterator< L >
	Returns a constant iterator to the element following the last element of the reversed expression.

template<layout_type L>
auto	crbegin () const noexcept -> const_reverse_layout_iterator< L >
	Returns a constant iterator to the first element of the reversed expression.

template<layout_type L>
auto	crend () const noexcept -> const_reverse_layout_iterator< L >
	Returns a constant iterator to the element following the last element of the reversed expression.

template<layout_type L, class S>
auto	begin (const S &shape) const noexcept -> const_broadcast_iterator< S, L >
	Returns a constant iterator to the first element of the expression.

template<layout_type L, class S>
auto	end (const S &shape) const noexcept -> const_broadcast_iterator< S, L >
	Returns a constant iterator to the element following the last element of the expression.

template<layout_type L, class S>
auto	cbegin (const S &shape) const noexcept -> const_broadcast_iterator< S, L >
	Returns a constant iterator to the first element of the expression.

template<layout_type L, class S>
auto	cend (const S &shape) const noexcept -> const_broadcast_iterator< S, L >
	Returns a constant iterator to the element following the last element of the expression.

template<layout_type L, class S>
auto	rbegin (const S &shape) const noexcept -> const_reverse_broadcast_iterator< S, L >
	Returns a constant iterator to the first element of the reversed expression.

template<layout_type L, class S>
auto	rend (const S &shape) const noexcept -> const_reverse_broadcast_iterator< S, L >
	Returns a constant iterator to the element following the last element of the reversed expression.

template<layout_type L, class S>
auto	crbegin (const S &shape) const noexcept -> const_reverse_broadcast_iterator< S, L >
	Returns a constant iterator to the first element of the reversed expression.

template<layout_type L, class S>
auto	crend (const S &shape) const noexcept -> const_reverse_broadcast_iterator< S, L >
	Returns a constant iterator to the element following the last element of the reversed expression.

template<layout_type L>
auto	get_cbegin (bool end_index) const noexcept -> const_layout_iterator< L >

template<layout_type L>
auto	get_cend (bool end_index) const noexcept -> const_layout_iterator< L >

template<layout_type L, class S>
auto	get_cbegin (const S &shape, bool end_index) const noexcept -> const_broadcast_iterator< S, L >

template<layout_type L, class S>
auto	get_cend (const S &shape, bool end_index) const noexcept -> const_broadcast_iterator< S, L >

template<class S>
auto	get_stepper_begin (const S &shape) const noexcept -> const_stepper

template<class S>
auto	get_stepper_end (const S &shape, layout_type l) const noexcept -> const_stepper

Reverse broadcast iterators
template<layout_type L, class S>
auto	rbegin (const S &shape) noexcept -> reverse_broadcast_iterator< S, L >
	Returns an iterator to the first element of the reversed expression.

template<layout_type L, class S>
auto	rend (const S &shape) noexcept -> reverse_broadcast_iterator< S, L >
	Returns an iterator to the element following the last element of the reversed expression.

template<layout_type L>
auto	get_begin (bool end_index) noexcept -> layout_iterator< L >

template<layout_type L>
auto	get_end (bool end_index) noexcept -> layout_iterator< L >

template<layout_type L, class S>
auto	get_begin (const S &shape, bool end_index) noexcept -> broadcast_iterator< S, L >

template<layout_type L, class S>
auto	get_end (const S &shape, bool end_index) noexcept -> broadcast_iterator< S, L >

template<class S>
auto	get_stepper_begin (const S &shape) noexcept -> stepper

template<class S>
auto	get_stepper_end (const S &shape, layout_type l) noexcept -> stepper

template<class S>
auto	get_stepper_begin (const S &shape) const noexcept -> const_stepper

template<class S>
auto	get_stepper_end (const S &shape, layout_type l) const noexcept -> const_stepper

Additional Inherited Members
const inner_shape_type &	get_shape () const

Detailed Description

template<class D>
class xt::xiterable< D >

Base class for multidimensional iterable expressions.

The xiterable class defines the interface for multidimensional expressions that can be iterated.

Template Parameters

D	The derived type, i.e. the inheriting class for which xiterable provides the interface.

Definition at line 151 of file xiterable.hpp.

Member Typedef Documentation

◆ base_type

template<class D>

using xt::xiterable< D >::base_type = xconst_iterable<D>

Definition at line 157 of file xiterable.hpp.

◆ broadcast_iterator

template<class D>

template<class S, layout_type L>

using xt::xiterable< D >::broadcast_iterator = typename base_type::template broadcast_iterator<S, L>

Definition at line 176 of file xiterable.hpp.

◆ const_broadcast_iterator

template<class D>

template<class S, layout_type L>

using xt::xiterable< D >::const_broadcast_iterator = typename base_type::template const_broadcast_iterator<S, L>

Definition at line 178 of file xiterable.hpp.

◆ const_iterator

template<class D>

using xt::xiterable< D >::const_iterator = typename base_type::const_iterator

Definition at line 185 of file xiterable.hpp.

◆ const_layout_iterator

template<class D>

template<layout_type L>

using xt::xiterable< D >::const_layout_iterator = typename base_type::template const_layout_iterator<L>

Definition at line 169 of file xiterable.hpp.

◆ const_reverse_broadcast_iterator

template<class D>

template<class S, layout_type L>

using xt::xiterable< D >::const_reverse_broadcast_iterator = typename base_type::template const_reverse_broadcast_iterator<S, L>

Definition at line 182 of file xiterable.hpp.

◆ const_reverse_iterator

template<class D>

using xt::xiterable< D >::const_reverse_iterator = typename base_type::const_reverse_iterator

Definition at line 187 of file xiterable.hpp.

◆ const_reverse_layout_iterator

template<class D>

template<layout_type L>

using xt::xiterable< D >::const_reverse_layout_iterator = typename base_type::template const_reverse_layout_iterator<L>

Definition at line 173 of file xiterable.hpp.

◆ const_stepper

template<class D>

using xt::xiterable< D >::const_stepper = typename base_type::const_stepper

Definition at line 161 of file xiterable.hpp.

◆ derived_type

template<class D>

using xt::xiterable< D >::derived_type = D

Definition at line 155 of file xiterable.hpp.

◆ inner_shape_type

template<class D>

using xt::xiterable< D >::inner_shape_type = typename base_type::inner_shape_type

Definition at line 158 of file xiterable.hpp.

◆ iterator

template<class D>

using xt::xiterable< D >::iterator = typename base_type::iterator

Definition at line 184 of file xiterable.hpp.

◆ layout_iterator

template<class D>

template<layout_type L>

using xt::xiterable< D >::layout_iterator = typename base_type::template layout_iterator<L>

Definition at line 167 of file xiterable.hpp.

◆ linear_iterator

template<class D>

using xt::xiterable< D >::linear_iterator = typename base_type::linear_iterator

Definition at line 163 of file xiterable.hpp.

◆ reverse_broadcast_iterator

template<class D>

template<class S, layout_type L>

using xt::xiterable< D >::reverse_broadcast_iterator = typename base_type::template reverse_broadcast_iterator<S, L>

Definition at line 180 of file xiterable.hpp.

◆ reverse_iterator

template<class D>

using xt::xiterable< D >::reverse_iterator = typename base_type::reverse_iterator

Definition at line 186 of file xiterable.hpp.

◆ reverse_layout_iterator

template<class D>

template<layout_type L>

using xt::xiterable< D >::reverse_layout_iterator = typename base_type::template reverse_layout_iterator<L>

Definition at line 171 of file xiterable.hpp.

◆ reverse_linear_iterator

template<class D>

using xt::xiterable< D >::reverse_linear_iterator = typename base_type::reverse_linear_iterator

Definition at line 164 of file xiterable.hpp.

◆ stepper

template<class D>

using xt::xiterable< D >::stepper = typename base_type::stepper

Definition at line 160 of file xiterable.hpp.

Member Function Documentation

◆ begin() [1/2]

template<class D>

template<layout_type L>

auto xt::xiterable< D >::begin ( ) -> layout_iterator<L>

inlinenoexcept

Returns an iterator to the first element of the expression.

Template Parameters

L	order used for the traversal. Default value is `XTENSOR_DEFAULT_TRAVERSAL`.

Definition at line 757 of file xiterable.hpp.

◆ begin() [2/2]

template<class D>

template<layout_type L, class S>

auto xt::xiterable< D >::begin ( const S & shape ) -> broadcast_iterator<S, L>

inlinenoexcept

Returns an iterator to the first element of the expression.

The iteration is broadcasted to the specified shape.

Parameters

shape the shape used for broadcasting

Template Parameters

S	type of the `shape` parameter.
L	order used for the traversal. Default value is `XTENSOR_DEFAULT_TRAVERSAL`.

Definition at line 818 of file xiterable.hpp.

◆ end() [1/2]

template<class D>

template<layout_type L>

auto xt::xiterable< D >::end ( ) -> layout_iterator<L>

inlinenoexcept

Returns an iterator to the element following the last element of the expression.

Template Parameters

L	order used for the traversal. Default value is `XTENSOR_DEFAULT_TRAVERSAL`.

Definition at line 769 of file xiterable.hpp.

◆ end() [2/2]

template<class D>

template<layout_type L, class S>

auto xt::xiterable< D >::end ( const S & shape ) -> broadcast_iterator<S, L>

inlinenoexcept

Returns an iterator to the element following the last element of the expression.

The iteration is broadcasted to the specified shape.

Parameters

shape the shape used for broadcasting

Template Parameters

S	type of the `shape` parameter.
L	order used for the traversal. Default value is `XTENSOR_DEFAULT_TRAVERSAL`.

Definition at line 832 of file xiterable.hpp.

◆ get_begin() [1/2]

template<class D>

template<layout_type L>

auto xt::xiterable< D >::get_begin ( bool end_index ) -> layout_iterator<L>

inlinenoexcept

Definition at line 875 of file xiterable.hpp.

◆ get_begin() [2/2]

template<class D>

template<layout_type L, class S>

auto xt::xiterable< D >::get_begin	(	const S &	shape,
		bool	end_index ) -> broadcast_iterator<S, L>

inlinenoexcept

Definition at line 889 of file xiterable.hpp.

◆ get_end() [1/2]

template<class D>

template<layout_type L>

auto xt::xiterable< D >::get_end ( bool end_index ) -> layout_iterator<L>

inlinenoexcept

Definition at line 882 of file xiterable.hpp.

◆ get_end() [2/2]

template<class D>

template<layout_type L, class S>

auto xt::xiterable< D >::get_end	(	const S &	shape,
		bool	end_index ) -> broadcast_iterator<S, L>

inlinenoexcept

Definition at line 896 of file xiterable.hpp.

◆ get_stepper_begin() [1/2]

template<class D>

template<class S>

auto xt::xiterable< D >::get_stepper_begin ( const S & shape ) const -> const_stepper

inlinenoexcept

Definition at line 917 of file xiterable.hpp.

◆ get_stepper_begin() [2/2]

template<class D>

template<class S>

auto xt::xiterable< D >::get_stepper_begin ( const S & shape ) -> stepper

inlinenoexcept

Definition at line 903 of file xiterable.hpp.

◆ get_stepper_end() [1/2]

template<class D>

template<class S>

auto xt::xiterable< D >::get_stepper_end	(	const S &	shape,
		layout_type	l ) const -> const_stepper

inlinenoexcept

Definition at line 924 of file xiterable.hpp.

◆ get_stepper_end() [2/2]

template<class D>

template<class S>

auto xt::xiterable< D >::get_stepper_end	(	const S &	shape,
		layout_type	l ) -> stepper

inlinenoexcept

Definition at line 910 of file xiterable.hpp.

◆ rbegin() [1/2]

template<class D>

template<layout_type L>

auto xt::xiterable< D >::rbegin ( ) -> reverse_layout_iterator<L>

inlinenoexcept

Returns an iterator to the first element of the reversed expression.

Template Parameters

L	order used for the traversal. Default value is `XTENSOR_DEFAULT_TRAVERSAL`.

Definition at line 786 of file xiterable.hpp.

◆ rbegin() [2/2]

template<class D>

template<layout_type L, class S>

auto xt::xiterable< D >::rbegin ( const S & shape ) -> reverse_broadcast_iterator<S, L>

inlinenoexcept

Returns an iterator to the first element of the reversed expression.

The iteration is broadcasted to the specified shape.

Parameters

shape the shape used for broadcasting

Template Parameters

S	type of the `shape` parameter.
L	order used for the traversal. Default value is `XTENSOR_DEFAULT_TRAVERSAL`.

Definition at line 852 of file xiterable.hpp.

◆ rend() [1/2]

template<class D>

template<layout_type L>

auto xt::xiterable< D >::rend ( ) -> reverse_layout_iterator<L>

inlinenoexcept

Returns an iterator to the element following the last element of the reversed expression.

Template Parameters

L	order used for the traversal. Default value is `XTENSOR_DEFAULT_TRAVERSAL`.

Definition at line 798 of file xiterable.hpp.

◆ rend() [2/2]

template<class D>

template<layout_type L, class S>

auto xt::xiterable< D >::rend ( const S & shape ) -> reverse_broadcast_iterator<S, L>

inlinenoexcept

Returns an iterator to the element following the last element of the reversed expression.

The iteration is broadcasted to the specified shape.

Parameters

shape the shape used for broadcasting

Template Parameters

S	type of the `shape` parameter.
L	order used for the traversal. Default value is `XTENSOR_DEFAULT_TRAVERSAL`.

Definition at line 866 of file xiterable.hpp.

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

/home/runner/work/xtensor/xtensor/include/xtensor/core/xiterable.hpp

Public Types

Public Member Functions

Reverse broadcast iterators

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ base_type

◆ broadcast_iterator

◆ const_broadcast_iterator

◆ const_iterator

◆ const_layout_iterator

◆ const_reverse_broadcast_iterator

◆ const_reverse_iterator

◆ const_reverse_layout_iterator

◆ const_stepper

◆ derived_type

◆ inner_shape_type

◆ iterator

◆ layout_iterator

◆ linear_iterator

◆ reverse_broadcast_iterator

◆ reverse_iterator

◆ reverse_layout_iterator

◆ reverse_linear_iterator

◆ stepper

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ get_begin() [1/2]

◆ get_begin() [2/2]

◆ get_end() [1/2]

◆ get_end() [2/2]

◆ get_stepper_begin() [1/2]

◆ get_stepper_begin() [2/2]

◆ get_stepper_end() [1/2]

◆ get_stepper_end() [2/2]

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]