Base class for multidimensional iterable constant expressions. More...

#include <xiterable.hpp>

Inheritance diagram for xt::xconst_iterable< D >:

Public Types
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
Constant iterators
template<layout_type L = ::xt::layout_type::row_major>
const_layout_iterator< L >	begin () const noexcept
	Returns a constant iterator to the first element of the expression.
template<layout_type L = ::xt::layout_type::row_major>
const_layout_iterator< L >	end () const noexcept
	Returns a constant iterator to the element following the last element of the expression.
template<layout_type L = ::xt::layout_type::row_major>
const_layout_iterator< L >	cbegin () const noexcept
	Returns a constant iterator to the first element of the expression.
template<layout_type L = ::xt::layout_type::row_major>
const_layout_iterator< L >	cend () const noexcept
	Returns a constant iterator to the element following the last element of the expression.
Constant reverse iterators
template<layout_type L = ::xt::layout_type::row_major>
const_reverse_layout_iterator< L >	rbegin () const noexcept
	Returns a constant iterator to the first element of the reversed expression.
template<layout_type L = ::xt::layout_type::row_major>
const_reverse_layout_iterator< L >	rend () const noexcept
	Returns a constant iterator to the element following the last element of the reversed expression.
template<layout_type L = ::xt::layout_type::row_major>
const_reverse_layout_iterator< L >	crbegin () const noexcept
	Returns a constant iterator to the first element of the reversed expression.
template<layout_type L = ::xt::layout_type::row_major>
const_reverse_layout_iterator< L >	crend () const noexcept
	Returns a constant iterator to the element following the last element of the reversed expression.
Constant broadcast iterators
template<layout_type L = ::xt::layout_type::row_major, class S>
const_broadcast_iterator< S, L >	begin (const S &shape) const noexcept
	Returns a constant iterator to the first element of the expression.
template<layout_type L = ::xt::layout_type::row_major, class S>
const_broadcast_iterator< S, L >	end (const S &shape) const noexcept
	Returns a constant iterator to the element following the last element of the expression.
template<layout_type L = ::xt::layout_type::row_major, class S>
const_broadcast_iterator< S, L >	cbegin (const S &shape) const noexcept
	Returns a constant iterator to the first element of the expression.
template<layout_type L = ::xt::layout_type::row_major, class S>
const_broadcast_iterator< S, L >	cend (const S &shape) const noexcept
	Returns a constant iterator to the element following the last element of the expression.

Constant reverse broadcast iterators
template<layout_type L = ::xt::layout_type::row_major, class S>
const_reverse_broadcast_iterator< S, L >	rbegin (const S &shape) const noexcept
	Returns a constant iterator to the first element of the reversed expression.
template<layout_type L = ::xt::layout_type::row_major, class S>
const_reverse_broadcast_iterator< S, L >	rend (const S &shape) const noexcept
	Returns a constant iterator to the element following the last element of the reversed expression.
template<layout_type L = ::xt::layout_type::row_major, class S>
const_reverse_broadcast_iterator< S, L >	crbegin (const S &shape) const noexcept
	Returns a constant iterator to the first element of the reversed expression.
template<layout_type L = ::xt::layout_type::row_major, class S>
const_reverse_broadcast_iterator< S, L >	crend (const S &shape) const noexcept
	Returns a constant iterator to the element following the last element of the reversed expression.
const inner_shape_type &	get_shape () const

Detailed Description

template<class D>
class xt::xconst_iterable< D >

Base class for multidimensional iterable constant expressions.

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

Template Parameters

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

Definition at line 36 of file xiterable.hpp.

Member Typedef Documentation

◆ broadcast_iterator

template<class D>

template<class S, layout_type L>

using xt::xconst_iterable< D >::broadcast_iterator = xiterator<stepper, S, L>

Definition at line 63 of file xiterable.hpp.

◆ const_broadcast_iterator

template<class D>

template<class S, layout_type L>

using xt::xconst_iterable< D >::const_broadcast_iterator = xiterator<const_stepper, S, L>

Definition at line 65 of file xiterable.hpp.

◆ const_iterator

template<class D>

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

Definition at line 72 of file xiterable.hpp.

◆ const_layout_iterator

template<class D>

template<layout_type L>

using xt::xconst_iterable< D >::const_layout_iterator = xiterator<const_stepper, inner_shape_type*, L>

Definition at line 51 of file xiterable.hpp.

◆ const_linear_iterator

template<class D>

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

Definition at line 58 of file xiterable.hpp.

◆ const_reverse_broadcast_iterator

template<class D>

template<class S, layout_type L>

using xt::xconst_iterable< D >::const_reverse_broadcast_iterator = std::reverse_iterator<const_broadcast_iterator<S, L>>

Definition at line 69 of file xiterable.hpp.

◆ const_reverse_iterator

template<class D>

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

Definition at line 74 of file xiterable.hpp.

◆ const_reverse_layout_iterator

template<class D>

template<layout_type L>

using xt::xconst_iterable< D >::const_reverse_layout_iterator = std::reverse_iterator<const_layout_iterator<L>>

Definition at line 55 of file xiterable.hpp.

◆ const_reverse_linear_iterator

template<class D>

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

Definition at line 60 of file xiterable.hpp.

◆ const_stepper

template<class D>

using xt::xconst_iterable< D >::const_stepper = typename iterable_types::const_stepper

Definition at line 46 of file xiterable.hpp.

◆ derived_type

template<class D>

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

Definition at line 40 of file xiterable.hpp.

◆ inner_shape_type

template<class D>

using xt::xconst_iterable< D >::inner_shape_type = typename iterable_types::inner_shape_type

Definition at line 43 of file xiterable.hpp.

◆ iterable_types

template<class D>

using xt::xconst_iterable< D >::iterable_types = xiterable_inner_types<D>

Definition at line 42 of file xiterable.hpp.

◆ iterator

template<class D>

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

Definition at line 71 of file xiterable.hpp.

◆ layout_iterator

template<class D>

template<layout_type L>

using xt::xconst_iterable< D >::layout_iterator = xiterator<stepper, inner_shape_type*, L>

Definition at line 49 of file xiterable.hpp.

◆ linear_iterator

template<class D>

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

Definition at line 57 of file xiterable.hpp.

◆ reverse_broadcast_iterator

template<class D>

template<class S, layout_type L>

using xt::xconst_iterable< D >::reverse_broadcast_iterator = std::reverse_iterator<broadcast_iterator<S, L>>

Definition at line 67 of file xiterable.hpp.

◆ reverse_iterator

template<class D>

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

Definition at line 73 of file xiterable.hpp.

◆ reverse_layout_iterator

template<class D>

template<layout_type L>

using xt::xconst_iterable< D >::reverse_layout_iterator = std::reverse_iterator<layout_iterator<L>>

Definition at line 53 of file xiterable.hpp.

◆ reverse_linear_iterator

template<class D>

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

Definition at line 59 of file xiterable.hpp.

◆ stepper

template<class D>

using xt::xconst_iterable< D >::stepper = typename iterable_types::stepper

Definition at line 45 of file xiterable.hpp.

Member Function Documentation

◆ begin() [1/2]

template<class D>

template<layout_type L>

auto xt::xconst_iterable< D >::begin ( ) const -> const_layout_iterator< L >

inlinenoexcept

Returns a constant 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 448 of file xiterable.hpp.

◆ begin() [2/2]

template<class D>

template<layout_type L, class S>

auto xt::xconst_iterable< D >::begin ( const S & shape ) const

inlinenoexcept

Returns a constant 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 555 of file xiterable.hpp.

◆ cbegin() [1/2]

template<class D>

template<layout_type L>

auto xt::xconst_iterable< D >::cbegin ( ) const -> const_layout_iterator< L >

inlinenoexcept

Returns a constant 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 471 of file xiterable.hpp.

◆ cbegin() [2/2]

template<class D>

template<layout_type L, class S>

auto xt::xconst_iterable< D >::cbegin ( const S & shape ) const

inlinenoexcept

Returns a constant 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 583 of file xiterable.hpp.

◆ cend() [1/2]

template<class D>

template<layout_type L>

auto xt::xconst_iterable< D >::cend ( ) const -> const_layout_iterator< L >

inlinenoexcept

Returns a constant 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 483 of file xiterable.hpp.

◆ cend() [2/2]

template<class D>

template<layout_type L, class S>

auto xt::xconst_iterable< D >::cend ( const S & shape ) const

inlinenoexcept

Returns a constant 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 597 of file xiterable.hpp.

◆ crbegin() [1/2]

template<class D>

template<layout_type L>

auto xt::xconst_iterable< D >::crbegin ( ) const -> const_reverse_layout_iterator< L >

inlinenoexcept

Returns a constant 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 523 of file xiterable.hpp.

◆ crbegin() [2/2]

template<class D>

template<layout_type L, class S>

auto xt::xconst_iterable< D >::crbegin ( const S & shape ) const

inlinenoexcept

Returns a constant 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 647 of file xiterable.hpp.

◆ crend() [1/2]

template<class D>

template<layout_type L>

auto xt::xconst_iterable< D >::crend ( ) const -> const_reverse_layout_iterator< L >

inlinenoexcept

Returns a constant 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 535 of file xiterable.hpp.

◆ crend() [2/2]

template<class D>

template<layout_type L, class S>

auto xt::xconst_iterable< D >::crend ( const S & shape ) const

inlinenoexcept

Returns a constant 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 662 of file xiterable.hpp.

◆ end() [1/2]

template<class D>

template<layout_type L>

auto xt::xconst_iterable< D >::end ( ) const -> const_layout_iterator< L >

inlinenoexcept

Returns a constant 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 460 of file xiterable.hpp.

◆ end() [2/2]

template<class D>

template<layout_type L, class S>

auto xt::xconst_iterable< D >::end ( const S & shape ) const

inlinenoexcept

Returns a constant 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 569 of file xiterable.hpp.

◆ get_shape()

template<class D>

auto xt::xconst_iterable< D >::get_shape ( ) const

inlineprotected

Definition at line 716 of file xiterable.hpp.

◆ rbegin() [1/2]

template<class D>

template<layout_type L>

auto xt::xconst_iterable< D >::rbegin ( ) const -> const_reverse_layout_iterator< L >

inlinenoexcept

Returns a constant 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 500 of file xiterable.hpp.

◆ rbegin() [2/2]

template<class D>

template<layout_type L, class S>

auto xt::xconst_iterable< D >::rbegin ( const S & shape ) const

inlinenoexcept

Returns a constant 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 617 of file xiterable.hpp.

◆ rend() [1/2]

template<class D>

template<layout_type L>

auto xt::xconst_iterable< D >::rend ( ) const -> const_reverse_layout_iterator< L >

inlinenoexcept

Returns a constant 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 512 of file xiterable.hpp.

◆ rend() [2/2]

template<class D>

template<layout_type L, class S>

auto xt::xconst_iterable< D >::rend ( const S & shape ) const

inlinenoexcept

Returns a constant 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 632 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

Constant reverse broadcast iterators

Detailed Description

Member Typedef Documentation

◆ broadcast_iterator

◆ const_broadcast_iterator

◆ const_iterator

◆ const_layout_iterator

◆ const_linear_iterator

◆ const_reverse_broadcast_iterator

◆ const_reverse_iterator

◆ const_reverse_layout_iterator

◆ const_reverse_linear_iterator

◆ const_stepper

◆ derived_type

◆ inner_shape_type

◆ iterable_types

◆ 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]

◆ cbegin() [1/2]

◆ cbegin() [2/2]

◆ cend() [1/2]

◆ cend() [2/2]

◆ crbegin() [1/2]

◆ crbegin() [2/2]

◆ crend() [1/2]

◆ crend() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ get_shape()

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]