xiterable

Defined in xtensor/xiterable.hpp

template <class D>
class xt::xconst_iterable

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.

Subclassed by xt::xiterable< D >

Constant iterators

template <layout_type L>
auto begin() const

Returns a constant iterator to the first element of the expression.

Template Parameters
  • L: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <layout_type L>
auto end() const

Returns a constant iterator to the element following the last element of the expression.

Template Parameters
  • L: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <layout_type L>
auto cbegin() const

Returns a constant iterator to the first element of the expression.

Template Parameters
  • L: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <layout_type L>
auto cend() const

Returns a constant iterator to the element following the last element of the expression.

Template Parameters
  • L: layout used for the traversal. Default value is DEFAULT_LAYOUT.

Constant reverse iterators

template <layout_type L>
auto rbegin() const

Returns a constant iterator to the first element of the reversed expression.

Template Parameters
  • L: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <layout_type L>
auto rend() const

Returns a constant iterator to the element following the last element of the reversed expression.

Template Parameters
  • L: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <layout_type L>
auto crbegin() const

Returns a constant iterator to the first element of the reversed expression.

Template Parameters
  • L: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <layout_type L>
auto crend() const

Returns a constant iterator to the element following the last element of the reversed expression.

Template Parameters
  • L: layout used for the traversal. Default value is DEFAULT_LAYOUT.

Constant broadcast iterators

template <class S, layout_type L>
auto begin(const S &shape) const

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: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <class S, layout_type L>
auto end(const S &shape) const

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: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <class S, layout_type L>
auto cbegin(const S &shape) const

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: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <class S, layout_type L>
auto cend(const S &shape) const

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: layout used for the traversal. Default value is DEFAULT_LAYOUT.

Unnamed Group

template <class S, layout_type L>
auto rbegin(const S &shape) const

Constant reverse broadcast iterators.

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: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <class S, layout_type L>
auto rend(const S &shape) const

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: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <class S, layout_type L>
auto crbegin(const S &shape) const

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: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <class S, layout_type L>
auto crend(const S &shape) const

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: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <class D>
class xt::xiterable

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.

Inherits from xt::xconst_iterable< D >

Subclassed by xt::xcontainer< D >

Iterators

template <layout_type L>
auto begin()

Returns an iterator to the first element of the expression.

Template Parameters
  • L: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <layout_type L>
auto end()

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

Template Parameters
  • L: layout used for the traversal. Default value is DEFAULT_LAYOUT.

Broadcast iterators

template <class S, layout_type L>
auto begin(const S &shape)

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: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <class S, layout_type L>
auto end(const S &shape)

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: layout used for the traversal. Default value is DEFAULT_LAYOUT.

Reverse iterators

template <layout_type L>
auto rbegin()

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

Template Parameters
  • L: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <layout_type L>
auto rend()

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

Template Parameters
  • L: layout used for the traversal. Default value is DEFAULT_LAYOUT.

Reverse broadcast iterators

template <class S, layout_type L>
auto rbegin(const S &shape)

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: layout used for the traversal. Default value is DEFAULT_LAYOUT.

template <class S, layout_type L>
auto rend(const S &shape)

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: layout used for the traversal. Default value is DEFAULT_LAYOUT.