xt::xarray_adaptor< EC, L, SC, Tag > Class Template Reference

Dense multidimensional container adaptor with tensor semantic. More...

#include <xarray.hpp>

Inheritance diagram for xt::xarray_adaptor< EC, L, SC, Tag >:

Public Types
using	container_closure_type = EC
using	self_type = xarray_adaptor<EC, L, SC, Tag>
using	base_type = xstrided_container<self_type>
using	semantic_base = xcontainer_semantic<self_type>
using	extension_base = extension::xarray_adaptor_base_t<EC, L, SC, Tag>
using	storage_type = typename base_type::storage_type
using	allocator_type = typename base_type::allocator_type
using	shape_type = typename base_type::shape_type
using	strides_type = typename base_type::strides_type
using	backstrides_type = typename base_type::backstrides_type
using	temporary_type = typename semantic_base::temporary_type
using	expression_tag = Tag
Public Types inherited from xt::xstrided_container< xarray_adaptor< EC, L, SC, Tag > >
using	base_type
using	storage_type
using	value_type
using	reference
using	const_reference
using	pointer
using	const_pointer
using	size_type
using	shape_type
using	strides_type
using	inner_shape_type
using	inner_strides_type
using	inner_backstrides_type
Public Types inherited from xt::xcontainer< xarray_adaptor< EC, L, SC, Tag > >
using	derived_type
using	inner_types
using	storage_type
using	allocator_type
using	value_type
using	reference
using	const_reference
using	pointer
using	const_pointer
using	size_type
using	difference_type
using	simd_value_type
using	bool_load_type
using	shape_type
using	strides_type
using	backstrides_type
using	inner_shape_type
using	inner_strides_type
using	inner_backstrides_type
using	iterable_base
using	stepper
using	const_stepper
using	accessible_base
using	data_alignment
using	simd_type
using	linear_iterator
using	const_linear_iterator
using	reverse_linear_iterator
using	const_reverse_linear_iterator
using	simd_return_type
using	container_iterator
using	const_container_iterator
Public Types inherited from xt::xcontiguous_iterable< xarray_adaptor< EC, L, SC, Tag > >
using	derived_type
using	inner_types
using	iterable_base
using	stepper
using	const_stepper
using	layout_iterator
using	const_layout_iterator
using	reverse_layout_iterator
using	const_reverse_layout_iterator
using	broadcast_iterator
using	const_broadcast_iterator
using	reverse_broadcast_iterator
using	const_reverse_broadcast_iterator
using	linear_traits
using	linear_iterator
using	const_linear_iterator
using	reverse_linear_iterator
using	const_reverse_linear_iterator
using	select_iterator_impl
using	select_iterator
using	select_const_iterator
using	select_reverse_iterator
using	select_const_reverse_iterator
using	iterator
using	const_iterator
using	reverse_iterator
using	const_reverse_iterator
Public Types inherited from xt::xcontainer_semantic< xarray_adaptor< EC, L, SC, Tag > >
using	base_type
using	derived_type
using	temporary_type
Public Types inherited from xt::xsemantic_base< xarray_adaptor< EC, L, SC, Tag > >
using	base_type
using	derived_type
using	temporary_type

Public Member Functions
	xarray_adaptor (const xarray_adaptor &)=default
	xarray_adaptor (xarray_adaptor &&)=default
template<class E>
xarray_adaptor &	operator= (const xexpression< E > &e)
Constructors
	xarray_adaptor (storage_type &&storage)
	Constructs an xarray_adaptor of the given stl-like container.
	xarray_adaptor (const storage_type &storage)
	Constructs an xarray_adaptor of the given stl-like container.
template<class D>
	xarray_adaptor (D &&storage, const shape_type &shape, layout_type l=L)
	Constructs an xarray_adaptor of the given stl-like container, with the specified shape and layout_type.
template<class D>
	xarray_adaptor (D &&storage, const shape_type &shape, const strides_type &strides)
	Constructs an xarray_adaptor of the given stl-like container, with the specified shape and strides.
xarray_adaptor &	operator= (const xarray_adaptor &)
xarray_adaptor &	operator= (xarray_adaptor &&)
xarray_adaptor &	operator= (temporary_type &&)
void	resize (S &&shape, bool force=false)
	Resizes the container.
auto &	reshape (S &&shape, layout_type layout=base_type::static_layout) &
	Reshapes the container and keeps old elements.
layout_type	layout () const noexcept
	Return the layout_type of the container.
bool	is_contiguous () const noexcept
Public Member Functions inherited from xt::xcontainer< xarray_adaptor< EC, L, SC, Tag > >
reference	at (Args... args)
	Returns a reference to the element at the specified position in the expression, after dimension and bounds checking.
disable_integral_t< S, reference >	operator[] (const S &index)
	Returns a reference to the element at the specified position in the expression.
reference	operator[] (std::initializer_list< I > index)
reference	operator[] (size_type i)
reference	back ()
	Returns a reference to the last element of the expression.
reference	front ()
	Returns a reference to the first element of the expression.
reference	periodic (Args... args)
	Returns a reference to the element at the specified position in the expression, after applying periodicity to the indices (negative and 'overflowing' indices are changed).
size_type	size () const noexcept
	Returns the number of element in the container.
constexpr size_type	dimension () const noexcept
	Returns the number of dimensions of the container.
constexpr const inner_shape_type &	shape () const noexcept
	Returns the shape of the container.
constexpr const inner_strides_type &	strides () const noexcept
	Returns the strides of the container.
constexpr const inner_backstrides_type &	backstrides () const noexcept
	Returns the backstrides of the container.
void	fill (const T &value)
	Fills the container with the given value.
reference	operator() (Args... args)
	Returns a reference to the element at the specified position in the container.
reference	unchecked (Args... args)
	Returns a reference to the element at the specified position in the container.
reference	element (It first, It last)
	Returns a reference to the element at the specified position in the container.
storage_type &	storage () noexcept
	Returns a reference to the buffer containing the elements of the container.
pointer	data () noexcept
	Returns a pointer to the underlying array serving as element storage.
const size_type	data_offset () const noexcept
	Returns the offset to the first element in the container.
bool	broadcast_shape (S &shape, bool reuse_cache=false) const
	Broadcast the shape of the container to the specified parameter.
bool	has_linear_assign (const S &strides) const noexcept
	Checks whether the xcontainer can be linearly assigned to an expression with the specified strides.
stepper	stepper_begin (const S &shape) noexcept
stepper	stepper_end (const S &shape, layout_type l) noexcept
reference	data_element (size_type i)
reference	flat (size_type i)
	Returns a reference to the element at the specified position in the container storage (as if it was one dimensional).
void	store_simd (size_type i, const simd &e)
container_simd_return_type_t< storage_type, value_type, requested_type >	load_simd (size_type i) const
linear_iterator	linear_begin () noexcept
linear_iterator	linear_end () noexcept
const_linear_iterator	linear_cbegin () const noexcept
const_linear_iterator	linear_cend () const noexcept
reverse_linear_iterator	linear_rbegin () noexcept
reverse_linear_iterator	linear_rend () noexcept
const_reverse_linear_iterator	linear_crbegin () const noexcept
const_reverse_linear_iterator	linear_crend () const noexcept
Public Member Functions inherited from xt::xcontiguous_iterable< xarray_adaptor< EC, L, SC, Tag > >
select_iterator< L >	begin () noexcept
	Returns an iterator to the first element of the expression.
select_iterator< L >	end () noexcept
	Returns an iterator to the element following the last element of the expression.
select_const_iterator< L >	cbegin () const noexcept
	Returns a constant iterator to the first element of the expression.
select_const_iterator< L >	cend () const noexcept
	Returns a constant iterator to the element following the last element of the expression.
select_reverse_iterator< L >	rbegin () noexcept
	Returns an iterator to the first element of the reversed expression.
select_reverse_iterator< L >	rend () noexcept
	Returns an iterator to the element following the last element of the reversed expression.
select_const_reverse_iterator< L >	crbegin () const noexcept
	Returns a constant iterator to the first element of the reversed expression.
select_const_reverse_iterator< L >	crend () const noexcept
	Returns a constant iterator to the element following the last element of the reversed expression.
Public Member Functions inherited from xt::xcontainer_semantic< xarray_adaptor< EC, L, SC, Tag > >
derived_type &	assign_temporary (temporary_type &&)
	Assigns the temporary tmp to *this.
derived_type &	assign_xexpression (const xexpression< E > &e)
derived_type &	computed_assign (const xexpression< E > &e)
derived_type &	scalar_computed_assign (const E &e, F &&f)
Public Member Functions inherited from xt::xsemantic_base< xarray_adaptor< EC, L, SC, Tag > >
disable_xexpression< E, derived_type & >	operator+= (const E &)
	Adds the scalar e to *this.
disable_xexpression< E, derived_type & >	operator-= (const E &)
	Subtracts the scalar e from *this.
disable_xexpression< E, derived_type & >	operator*= (const E &)
	Multiplies *this with the scalar e.
disable_xexpression< E, derived_type & >	operator/= (const E &)
	Divides *this by the scalar e.
disable_xexpression< E, derived_type & >	operator%= (const E &)
	Computes the remainder of *this after division by the scalar e.
disable_xexpression< E, derived_type & >	operator&= (const E &)
	Computes the bitwise and of *this and the scalar e and assigns it to *this.
disable_xexpression< E, derived_type & >	operator|= (const E &)
	Computes the bitwise or of *this and the scalar e and assigns it to *this.
disable_xexpression< E, derived_type & >	operator^= (const E &)
	Computes the bitwise xor of *this and the scalar e and assigns it to *this.
derived_type &	assign (const xexpression< E > &)
	Assigns the xexpression e to *this.
derived_type &	plus_assign (const xexpression< E > &)
	Adds the xexpression e to *this.
derived_type &	minus_assign (const xexpression< E > &)
	Subtracts the xexpression e to *this.
derived_type &	multiplies_assign (const xexpression< E > &)
	Multiplies *this with the xexpression e.
derived_type &	divides_assign (const xexpression< E > &)
	Divides *this by the xexpression e.
derived_type &	modulus_assign (const xexpression< E > &)
	Computes the remainder of *this after division by the xexpression e.
derived_type &	bit_and_assign (const xexpression< E > &)
	Computes the bitwise and of e to *this.
derived_type &	bit_or_assign (const xexpression< E > &)
	Computes the bitwise or of e to *this.
derived_type &	bit_xor_assign (const xexpression< E > &)
	Computes the bitwise xor of e to *this.

Static Public Attributes
static constexpr std::size_t	rank = SIZE_MAX
Static Public Attributes inherited from xt::xcontainer< xarray_adaptor< EC, L, SC, Tag > >
static constexpr layout_type	static_layout
static constexpr bool	contiguous_layout
Static Public Attributes inherited from xt::xcontiguous_iterable< xarray_adaptor< EC, L, SC, Tag > >
static constexpr layout_type	static_layout

Friends
class	xcontainer< xarray_adaptor< EC, L, SC, Tag > >

Extended copy semantic
template<class P, class S>
void	reset_buffer (P &&pointer, S &&size)
template<class E>
auto	operator= (const xexpression< E > &e) -> self_type &
	The extended assignment operator.

Additional Inherited Members
Protected Member Functions inherited from xt::xstrided_container< xarray_adaptor< EC, L, SC, Tag > >
xstrided_container &	operator= (const xstrided_container &)=default
inner_shape_type &	shape_impl () noexcept
inner_strides_type &	strides_impl () noexcept
inner_backstrides_type &	backstrides_impl () noexcept
void	reshape_impl (S &&shape, std::true_type, layout_type layout=base_type::static_layout)
layout_type &	mutable_layout () noexcept
Protected Member Functions inherited from xt::xcontainer< xarray_adaptor< EC, L, SC, Tag > >
xcontainer &	operator= (const xcontainer &)=default
container_iterator	data_xbegin () noexcept
container_iterator	data_xend (layout_type l, size_type offset) noexcept
derived_type &	derived_cast () &noexcept
Protected Member Functions inherited from xt::xcontainer_semantic< xarray_adaptor< EC, L, SC, Tag > >
xcontainer_semantic &	operator= (const xcontainer_semantic &)=default
Protected Member Functions inherited from xt::xsemantic_base< xarray_adaptor< EC, L, SC, Tag > >
xsemantic_base &	operator= (const xsemantic_base &)=default

Detailed Description

template<class EC, layout_type L, class SC, class Tag>
class xt::xarray_adaptor< EC, L, SC, Tag >

Dense multidimensional container adaptor with tensor semantic.

The xarray_adaptor class implements a dense multidimensional container adaptor with tensor semantic. It is used to provide a multidimensional container semantic and a tensor semantic to stl-like containers.

Template Parameters

EC	The closure for the container type to adapt.
L	The layout_type of the adaptor.
SC	The type of the containers holding the shape and the strides.
Tag	The expression tag.

See also

xstrided_container, xcontainer

Definition at line 213 of file xarray.hpp.

Member Typedef Documentation

allocator_type

template<class EC, layout_type L, class SC, class Tag>

using xt::xarray_adaptor< EC, L, SC, Tag >::allocator_type = typename base_type::allocator_type

Definition at line 226 of file xarray.hpp.

backstrides_type

template<class EC, layout_type L, class SC, class Tag>

using xt::xarray_adaptor< EC, L, SC, Tag >::backstrides_type = typename base_type::backstrides_type

Definition at line 229 of file xarray.hpp.

base_type

template<class EC, layout_type L, class SC, class Tag>

using xt::xarray_adaptor< EC, L, SC, Tag >::base_type = xstrided_container<self_type>

Definition at line 222 of file xarray.hpp.

container_closure_type

template<class EC, layout_type L, class SC, class Tag>

using xt::xarray_adaptor< EC, L, SC, Tag >::container_closure_type = EC

Definition at line 219 of file xarray.hpp.

expression_tag

template<class EC, layout_type L, class SC, class Tag>

using xt::xarray_adaptor< EC, L, SC, Tag >::expression_tag = Tag

Definition at line 231 of file xarray.hpp.

extension_base

template<class EC, layout_type L, class SC, class Tag>

using xt::xarray_adaptor< EC, L, SC, Tag >::extension_base = extension::xarray_adaptor_base_t<EC, L, SC, Tag>

Definition at line 224 of file xarray.hpp.

self_type

template<class EC, layout_type L, class SC, class Tag>

using xt::xarray_adaptor< EC, L, SC, Tag >::self_type = xarray_adaptor<EC, L, SC, Tag>

Definition at line 221 of file xarray.hpp.

semantic_base

template<class EC, layout_type L, class SC, class Tag>

using xt::xarray_adaptor< EC, L, SC, Tag >::semantic_base = xcontainer_semantic<self_type>

Definition at line 223 of file xarray.hpp.

shape_type

template<class EC, layout_type L, class SC, class Tag>

using xt::xarray_adaptor< EC, L, SC, Tag >::shape_type = typename base_type::shape_type

Definition at line 227 of file xarray.hpp.

storage_type

template<class EC, layout_type L, class SC, class Tag>

using xt::xarray_adaptor< EC, L, SC, Tag >::storage_type = typename base_type::storage_type

Definition at line 225 of file xarray.hpp.

strides_type

template<class EC, layout_type L, class SC, class Tag>

using xt::xarray_adaptor< EC, L, SC, Tag >::strides_type = typename base_type::strides_type

Definition at line 228 of file xarray.hpp.

temporary_type

template<class EC, layout_type L, class SC, class Tag>

using xt::xarray_adaptor< EC, L, SC, Tag >::temporary_type = typename semantic_base::temporary_type

Definition at line 230 of file xarray.hpp.

Constructor & Destructor Documentation

xarray_adaptor() [1/4]

template<class EC, layout_type L, class SC, class Tag>

xt::xarray_adaptor< EC, L, SC, Tag >::xarray_adaptor ( storage_type && storage )

inline

Constructs an xarray_adaptor of the given stl-like container.

Parameters

storage

the container to adapt

Definition at line 549 of file xarray.hpp.

xarray_adaptor() [2/4]

template<class EC, layout_type L, class SC, class Tag>

xt::xarray_adaptor< EC, L, SC, Tag >::xarray_adaptor ( const storage_type & storage )

inline

Constructs an xarray_adaptor of the given stl-like container.

Parameters

storage

the container to adapt

Definition at line 560 of file xarray.hpp.

xarray_adaptor() [3/4]

template<class EC, layout_type L, class SC, class Tag>

template<class D>

xt::xarray_adaptor< EC, L, SC, Tag >::xarray_adaptor ( D && storage, const shape_type & shape, layout_type l = L )

inline

Constructs an xarray_adaptor of the given stl-like container, with the specified shape and layout_type.

Parameters

storage	the container to adapt
shape	the shape of the xarray_adaptor
l	the layout_type of the xarray_adaptor

Definition at line 575 of file xarray.hpp.

xarray_adaptor() [4/4]

template<class EC, layout_type L, class SC, class Tag>

template<class D>

xt::xarray_adaptor< EC, L, SC, Tag >::xarray_adaptor ( D && storage, const shape_type & shape, const strides_type & strides )

inline

Constructs an xarray_adaptor of the given stl-like container, with the specified shape and strides.

Parameters

storage	the container to adapt
shape	the shape of the xarray_adaptor
strides	the strides of the xarray_adaptor

Definition at line 591 of file xarray.hpp.

Member Function Documentation

operator=() [1/4]

template<class EC, layout_type L, class SC, class Tag>

auto xt::xarray_adaptor< EC, L, SC, Tag >::operator= ( const xarray_adaptor< EC, L, SC, Tag > & rhs )

inline

Definition at line 605 of file xarray.hpp.

operator=() [2/4]

template<class EC, layout_type L, class SC, class Tag>

template<class E>

auto xt::xarray_adaptor< EC, L, SC, Tag >::operator= ( const xexpression< E > & e ) -> self_type &

inline

The extended assignment operator.

Definition at line 639 of file xarray.hpp.

operator=() [3/4]

template<class EC, layout_type L, class SC, class Tag>

auto xt::xarray_adaptor< EC, L, SC, Tag >::operator= ( temporary_type && rhs )

inline

Definition at line 621 of file xarray.hpp.

operator=() [4/4]

template<class EC, layout_type L, class SC, class Tag>

auto xt::xarray_adaptor< EC, L, SC, Tag >::operator= ( xarray_adaptor< EC, L, SC, Tag > && rhs )

inline

Definition at line 613 of file xarray.hpp.

reset_buffer()

template<class EC, layout_type L, class SC, class Tag>

template<class P, class S>

void xt::xarray_adaptor< EC, L, SC, Tag >::reset_buffer ( P && pointer, S && size )

inline

Definition at line 660 of file xarray.hpp.

Friends And Related Symbol Documentation

xcontainer< xarray_adaptor< EC, L, SC, Tag > >

template<class EC, layout_type L, class SC, class Tag>

friend class xcontainer< xarray_adaptor< EC, L, SC, Tag > >

friend

Definition at line 263 of file xarray.hpp.

Member Data Documentation

rank

template<class EC, layout_type L, class SC, class Tag>

std::size_t xt::xarray_adaptor< EC, L, SC, Tag >::rank = SIZE_MAX

staticconstexpr

Definition at line 232 of file xarray.hpp.

---

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

• /home/runner/work/xtensor/xtensor/include/xtensor/containers/xarray.hpp