Loading...
Searching...
No Matches
xt::xfixed_container< ET, S, L, SH, Tag > Class Template Reference
Dense multidimensional container with tensor semantic and fixed dimension. More...
#include <xfixed.hpp>
Inheritance diagram for xt::xfixed_container< ET, S, L, SH, Tag >:
Public Member Functions | |
| xfixed_container (const xfixed_container &)=default | |
| xfixed_container & | operator= (const xfixed_container &)=default |
| xfixed_container (xfixed_container &&)=default | |
| xfixed_container & | operator= (xfixed_container &&)=default |
| template<class E> | |
| xfixed_container & | operator= (const xexpression< E > &e) |
Constructors | |
| xfixed_container (const value_type &v) | |
| xfixed_container (const inner_shape_type &shape, layout_type l=L) | |
| Create an uninitialized xfixed_container. | |
| xfixed_container (const inner_shape_type &shape, value_type v, layout_type l=L) | |
| Create an xfixed_container, and initialize with the value of v. | |
| template<class IX = std::integral_constant<std::size_t, N>> requires (IX::value != 0) | |
| xfixed_container (nested_initializer_list_t< value_type, N > t) | |
| Allocates an xfixed_container with shape S with values from a C array. | |
| template<class ST> | |
| xfixed_container< ET, S, L, SH, Tag > | from_shape (ST &&shape) |
| Public Member Functions inherited from xt::xcontainer< xfixed_container< ET, S, L, SH, 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< xfixed_container< ET, S, L, SH, 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< xfixed_container< ET, S, L, SH, 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< xfixed_container< ET, S, L, SH, 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 Member Functions | |
| template<class ST = std::array<std::size_t, N>> | |
| static xfixed_container | from_shape (ST &&) |
Static Public Attributes | |
| static constexpr std::size_t | N = std::tuple_size<shape_type>::value |
| static constexpr std::size_t | rank = N |
| Static Public Attributes inherited from xt::xcontainer< xfixed_container< ET, S, L, SH, Tag > > | |
| static constexpr layout_type | static_layout |
| static constexpr bool | contiguous_layout |
| Static Public Attributes inherited from xt::xcontiguous_iterable< xfixed_container< ET, S, L, SH, Tag > > | |
| static constexpr layout_type | static_layout |
Friends | |
| class | xcontainer< xfixed_container< ET, S, L, SH, Tag > > |
Extended copy semantic | |
| template<class E> | |
| xfixed_container (const xexpression< E > &e) | |
| The extended copy constructor. | |
| template<class ST = std::array<std::size_t, N>> | |
| void | resize (ST &&shape, bool force=false) const |
| Note that the xfixed_container cannot be resized. | |
| template<class ST = shape_type> | |
| void | resize (ST &&shape, layout_type l) const |
| Note that the xfixed_container cannot be resized. | |
| template<class ST = shape_type> | |
| void | resize (ST &&shape, const strides_type &strides) const |
| Note that the xfixed_container cannot be resized. | |
| template<class ST = std::array<std::size_t, N>> | |
| const auto & | reshape (ST &&shape, layout_type layout=L) const |
| Note that the xfixed_container cannot be reshaped to a shape different from S. | |
| template<class ST> | |
| bool | broadcast_shape (ST &s, bool reuse_cache=false) const |
| constexpr layout_type | layout () const noexcept |
| bool | is_contiguous () const noexcept |
| template<class E> | |
| auto | operator= (const xexpression< E > &e) -> self_type & |
| The extended assignment operator. | |
Additional Inherited Members | |
| Protected Member Functions inherited from xt::xcontainer< xfixed_container< ET, S, L, SH, 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< xfixed_container< ET, S, L, SH, Tag > > | |
| xcontainer_semantic & | operator= (const xcontainer_semantic &)=default |
| Protected Member Functions inherited from xt::xsemantic_base< xfixed_container< ET, S, L, SH, Tag > > | |
| xsemantic_base & | operator= (const xsemantic_base &)=default |
Detailed Description
template<class ET, class S, layout_type L, bool SH, class Tag>
class xt::xfixed_container< ET, S, L, SH, Tag >
class xt::xfixed_container< ET, S, L, SH, Tag >
Dense multidimensional container with tensor semantic and fixed dimension.
The xfixed_container class implements a dense multidimensional container with tensor semantic and fixed dimension
- Template Parameters
-
ET The type of the elements. S The xshape template paramter of the container. L The layout_type of the tensor. SH Wether the tensor can be used as a shared expression. Tag The expression tag.
- See also
- xtensor_fixed
Definition at line 290 of file xfixed.hpp.
Member Typedef Documentation
◆ backstrides_type
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::backstrides_type = typename base_type::backstrides_type |
Definition at line 308 of file xfixed.hpp.
◆ base_type
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::base_type = xcontainer<self_type> |
Definition at line 296 of file xfixed.hpp.
◆ const_pointer
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::const_pointer = typename base_type::const_pointer |
Definition at line 304 of file xfixed.hpp.
◆ const_reference
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::const_reference = typename base_type::const_reference |
Definition at line 302 of file xfixed.hpp.
◆ expression_tag
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::expression_tag = Tag |
Definition at line 312 of file xfixed.hpp.
◆ inner_backstrides_type
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::inner_backstrides_type = typename base_type::inner_backstrides_type |
Definition at line 309 of file xfixed.hpp.
◆ inner_shape_type
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::inner_shape_type = typename base_type::inner_shape_type |
Definition at line 306 of file xfixed.hpp.
◆ inner_strides_type
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::inner_strides_type = typename base_type::inner_strides_type |
Definition at line 310 of file xfixed.hpp.
◆ pointer
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::pointer = typename base_type::pointer |
Definition at line 303 of file xfixed.hpp.
◆ reference
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::reference = typename base_type::reference |
Definition at line 301 of file xfixed.hpp.
◆ self_type
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::self_type = xfixed_container<ET, S, L, SH, Tag> |
Definition at line 295 of file xfixed.hpp.
◆ semantic_base
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::semantic_base = xcontainer_semantic<self_type> |
Definition at line 297 of file xfixed.hpp.
◆ shape_type
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::shape_type = typename base_type::shape_type |
Definition at line 305 of file xfixed.hpp.
◆ storage_type
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::storage_type = typename base_type::storage_type |
Definition at line 299 of file xfixed.hpp.
◆ strides_type
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::strides_type = typename base_type::strides_type |
Definition at line 307 of file xfixed.hpp.
◆ temporary_type
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::temporary_type = typename semantic_base::temporary_type |
Definition at line 311 of file xfixed.hpp.
◆ value_type
template<class ET, class S, layout_type L, bool SH, class Tag>
| using xt::xfixed_container< ET, S, L, SH, Tag >::value_type = typename base_type::value_type |
Definition at line 300 of file xfixed.hpp.
Constructor & Destructor Documentation
◆ xfixed_container() [1/5]
template<class ET, class S, layout_type L, bool SH, class Tag>
|
inline |
Definition at line 527 of file xfixed.hpp.
◆ xfixed_container() [2/5]
template<class ET, class S, layout_type L, bool SH, class Tag>
|
inlineexplicit |
Create an uninitialized xfixed_container.
Note this function is only provided for homogeneity, and the shape & layout argument is disregarded (the template shape is always used).
- Parameters
-
shape the shape of the xfixed_container (unused!) l the layout_type of the xfixed_container (unused!)
Definition at line 518 of file xfixed.hpp.
◆ xfixed_container() [3/5]
template<class ET, class S, layout_type L, bool SH, class Tag>
|
inlineexplicit |
Create an xfixed_container, and initialize with the value of v.
Note, the shape argument to this function is only provided for homogeneity, and the shape argument is disregarded (the template shape is always used).
- Parameters
-
shape the shape of the xfixed_container (unused!) v the fill value l the layout_type of the xfixed_container (unused!)
Definition at line 546 of file xfixed.hpp.
◆ xfixed_container() [4/5]
template<class ET, class S, layout_type L, bool SH, class Tag>
requires (IX::value != 0)
requires (IX::value != 0)
template<class IX>
requires (IX::value != 0)
requires (IX::value != 0)
|
inline |
Allocates an xfixed_container with shape S with values from a C array.
The type returned by get_init_type_t is raw C array value_type[X][Y][Z] for xt::xshape<X, Y, Z>. C arrays can be initialized with the initializer list syntax, but the size is checked at compile time to prevent errors. Note: for clang < 3.8 this is an initializer_list and the size is not checked at compile-or runtime.
Definition at line 607 of file xfixed.hpp.
◆ xfixed_container() [5/5]
template<class ET, class S, layout_type L, bool SH, class Tag>
template<class E>
|
inline |
The extended copy constructor.
Definition at line 629 of file xfixed.hpp.
Member Function Documentation
◆ broadcast_shape()
template<class ET, class S, layout_type L, bool SH, class Tag>
template<class ST>
|
inline |
Definition at line 706 of file xfixed.hpp.
◆ from_shape()
template<class ET, class S, layout_type L, bool SH, class Tag>
template<class ST>
|
inline |
Definition at line 590 of file xfixed.hpp.
◆ is_contiguous()
template<class ET, class S, layout_type L, bool SH, class Tag>
|
inlinenoexcept |
Definition at line 718 of file xfixed.hpp.
◆ layout()
template<class ET, class S, layout_type L, bool SH, class Tag>
|
constexprnoexcept |
Definition at line 712 of file xfixed.hpp.
◆ operator=()
template<class ET, class S, layout_type L, bool SH, class Tag>
template<class E>
|
inline |
The extended assignment operator.
Definition at line 639 of file xfixed.hpp.
◆ reshape()
template<class ET, class S, layout_type L, bool SH, class Tag>
template<class ST>
|
inline |
Note that the xfixed_container cannot be reshaped to a shape different from S.
Definition at line 694 of file xfixed.hpp.
◆ resize() [1/3]
template<class ET, class S, layout_type L, bool SH, class Tag>
template<class ST>
|
inline |
Note that the xfixed_container cannot be resized.
Attempting to resize with a different size throws an assert in debug mode.
Definition at line 652 of file xfixed.hpp.
◆ resize() [2/3]
template<class ET, class S, layout_type L, bool SH, class Tag>
template<class ST>
|
inline |
Note that the xfixed_container cannot be resized.
Attempting to resize with a different size throws an assert in debug mode.
Definition at line 679 of file xfixed.hpp.
◆ resize() [3/3]
template<class ET, class S, layout_type L, bool SH, class Tag>
template<class ST>
|
inline |
Note that the xfixed_container cannot be resized.
Attempting to resize with a different size throws an assert in debug mode.
Definition at line 664 of file xfixed.hpp.
Friends And Related Symbol Documentation
◆ xcontainer< xfixed_container< ET, S, L, SH, Tag > >
template<class ET, class S, layout_type L, bool SH, class Tag>
|
friend |
Definition at line 373 of file xfixed.hpp.
Member Data Documentation
◆ N
template<class ET, class S, layout_type L, bool SH, class Tag>
|
staticconstexpr |
Definition at line 314 of file xfixed.hpp.
◆ rank
template<class ET, class S, layout_type L, bool SH, class Tag>
|
staticconstexpr |
Definition at line 315 of file xfixed.hpp.
The documentation for this class was generated from the following file:
- /home/runner/work/xtensor/xtensor/include/xtensor/containers/xfixed.hpp
