A layout mapping where the rightmost extent has stride 1. More...

#include <dune/common/std/layout_right.hh>

Public Types
using	extents_type = Extents

using	size_type = typename extents_type::size_type

using	rank_type = typename extents_type::rank_type

using	index_type = typename extents_type::index_type

using	layout_type = layout_right

Public Member Functions
constexpr	mapping () noexcept=default
	The default construction is possible for default constructible extents.

constexpr	mapping (const mapping &) noexcept=default
	Copy constructor for the mapping.

constexpr	mapping (const extents_type &e) noexcept
	Construct the mapping with from given extents.

template<class OtherExtents , std::enable_if_t< std::is_constructible_v< extents_type, OtherExtents >, int > = 0>
constexpr	mapping (const mapping< OtherExtents > &m) noexcept
	Construct the mapping from another mapping with a different extents type.

template<class OtherExtents , class E = extents_type, std::enable_if_t<(E::rank()<=1), int > = 0, std::enable_if_t< std::is_constructible_v< extents_type, OtherExtents >, int > = 0>
constexpr	mapping (const layout_left::mapping< OtherExtents > &m) noexcept
	Construct the mapping from a layout_left.

template<class OtherExtents , std::enable_if_t< std::is_constructible_v< extents_type, OtherExtents >, int > = 0>
constexpr	mapping (const layout_stride::mapping< OtherExtents > &m)
	Construct the mapping from a layout_stride.

constexpr mapping &	operator= (const mapping &) noexcept=default
	Copy-assignment for the mapping.

constexpr const extents_type &	extents () const noexcept

constexpr index_type	required_span_size () const noexcept

template<class... Indices, std::enable_if_t<(sizeof...(Indices)==extents_type::rank()), int > = 0, std::enable_if_t<(std::is_convertible_v< Indices, index_type > &&...), int > = 0, std::enable_if_t<(std::is_nothrow_constructible_v< Indices, index_type > &&...), int > = 0>
constexpr index_type	operator() (Indices... ii) const noexcept
	Compute the offset i3 + E(3)(i2 + E(2)(i1 + E(1)*i0))

constexpr index_type	operator() () const noexcept
	The default offset for rank-0 tensors is 0.

template<class E = extents_type, std::enable_if_t<(E::rank() > 0), int > = 0>
constexpr index_type	stride (rank_type i) const noexcept
	The stride is the product of the extents `E(n)E(n-1)...*E(i+1)`

Static Public Member Functions
static constexpr bool	is_always_unique () noexcept

static constexpr bool	is_always_exhaustive () noexcept

static constexpr bool	is_always_strided () noexcept

static constexpr bool	is_unique () noexcept

static constexpr bool	is_exhaustive () noexcept

static constexpr bool	is_strided () noexcept

Friends
template<class >
class	mapping

template<class OtherExtents >
constexpr bool	operator== (const mapping &a, const mapping< OtherExtents > &b) noexcept

Detailed Description

template<class Extents>
class Dune::Std::layout_right::mapping< Extents >

A layout mapping where the rightmost extent has stride 1.

Member Typedef Documentation

◆ extents_type

template<class Extents >

using Dune::Std::layout_right::mapping< Extents >::extents_type = Extents

◆ index_type

template<class Extents >

using Dune::Std::layout_right::mapping< Extents >::index_type = typename extents_type::index_type

◆ layout_type

template<class Extents >

using Dune::Std::layout_right::mapping< Extents >::layout_type = layout_right

◆ rank_type

template<class Extents >

using Dune::Std::layout_right::mapping< Extents >::rank_type = typename extents_type::rank_type

◆ size_type

template<class Extents >

using Dune::Std::layout_right::mapping< Extents >::size_type = typename extents_type::size_type

Constructor & Destructor Documentation

◆ mapping() [1/6]

template<class Extents >

constexpr Dune::Std::layout_right::mapping< Extents >::mapping ( )

constexprdefaultnoexcept

The default construction is possible for default constructible extents.

◆ mapping() [2/6]

template<class Extents >

constexpr Dune::Std::layout_right::mapping< Extents >::mapping ( const mapping< Extents > & )

constexprdefaultnoexcept

Copy constructor for the mapping.

◆ mapping() [3/6]

template<class Extents >

constexpr Dune::Std::layout_right::mapping< Extents >::mapping ( const extents_type & e )

inlineconstexprnoexcept

Construct the mapping with from given extents.

◆ mapping() [4/6]

template<class Extents >

template<class OtherExtents , std::enable_if_t< std::is_constructible_v< extents_type, OtherExtents >, int > = 0>

constexpr Dune::Std::layout_right::mapping< Extents >::mapping ( const mapping< OtherExtents > & m )

inlineconstexprnoexcept

Construct the mapping from another mapping with a different extents type.

◆ mapping() [5/6]

template<class Extents >

template<class OtherExtents , class E = extents_type, std::enable_if_t<(E::rank()<=1), int > = 0, std::enable_if_t< std::is_constructible_v< extents_type, OtherExtents >, int > = 0>

constexpr Dune::Std::layout_right::mapping< Extents >::mapping ( const layout_left::mapping< OtherExtents > & m )

inlineconstexprnoexcept

Construct the mapping from a layout_left.

◆ mapping() [6/6]

template<class Extents >

template<class OtherExtents , std::enable_if_t< std::is_constructible_v< extents_type, OtherExtents >, int > = 0>

constexpr Dune::Std::layout_right::mapping< Extents >::mapping ( const layout_stride::mapping< OtherExtents > & m )

inlineconstexpr

Construct the mapping from a layout_stride.

Member Function Documentation

◆ extents()

template<class Extents >

constexpr const extents_type & Dune::Std::layout_right::mapping< Extents >::extents ( ) const

inlineconstexprnoexcept

◆ is_always_exhaustive()

template<class Extents >

static constexpr bool Dune::Std::layout_right::mapping< Extents >::is_always_exhaustive ( )

inlinestaticconstexprnoexcept

◆ is_always_strided()

template<class Extents >

static constexpr bool Dune::Std::layout_right::mapping< Extents >::is_always_strided ( )

inlinestaticconstexprnoexcept

◆ is_always_unique()

template<class Extents >

static constexpr bool Dune::Std::layout_right::mapping< Extents >::is_always_unique ( )

inlinestaticconstexprnoexcept

◆ is_exhaustive()

template<class Extents >

static constexpr bool Dune::Std::layout_right::mapping< Extents >::is_exhaustive ( )

inlinestaticconstexprnoexcept

◆ is_strided()

template<class Extents >

static constexpr bool Dune::Std::layout_right::mapping< Extents >::is_strided ( )

inlinestaticconstexprnoexcept

◆ is_unique()

template<class Extents >

static constexpr bool Dune::Std::layout_right::mapping< Extents >::is_unique ( )

inlinestaticconstexprnoexcept

◆ operator()() [1/2]

template<class Extents >

constexpr index_type Dune::Std::layout_right::mapping< Extents >::operator() ( ) const

inlineconstexprnoexcept

The default offset for rank-0 tensors is 0.

◆ operator()() [2/2]

template<class Extents >

template<class... Indices, std::enable_if_t<(sizeof...(Indices)==extents_type::rank()), int > = 0, std::enable_if_t<(std::is_convertible_v< Indices, index_type > &&...), int > = 0, std::enable_if_t<(std::is_nothrow_constructible_v< Indices, index_type > &&...), int > = 0>

constexpr index_type Dune::Std::layout_right::mapping< Extents >::operator() ( Indices... ii ) const

inlineconstexprnoexcept

Compute the offset i3 + E(3)*(i2 + E(2)*(i1 + E(1)*i0))

◆ operator=()

template<class Extents >

constexpr mapping & Dune::Std::layout_right::mapping< Extents >::operator= ( const mapping< Extents > & )

constexprdefaultnoexcept

Copy-assignment for the mapping.

◆ required_span_size()

template<class Extents >

constexpr index_type Dune::Std::layout_right::mapping< Extents >::required_span_size ( ) const

inlineconstexprnoexcept

◆ stride()

template<class Extents >

template<class E = extents_type, std::enable_if_t<(E::rank() > 0), int > = 0>

constexpr index_type Dune::Std::layout_right::mapping< Extents >::stride ( rank_type i ) const

inlineconstexprnoexcept

The stride is the product of the extents E(n)*E(n-1)*...*E(i+1)

Friends And Related Symbol Documentation

◆ mapping

template<class Extents >

template<class >

friend class mapping

friend

◆ operator==

template<class Extents >

template<class OtherExtents >

constexpr bool operator==	(	const mapping< Extents > &	a,
		const mapping< OtherExtents > &	b
	)

friend

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

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ extents_type

◆ index_type

◆ layout_type

◆ rank_type

◆ size_type

Constructor & Destructor Documentation

◆ mapping() [1/6]

◆ mapping() [2/6]

◆ mapping() [3/6]

◆ mapping() [4/6]

◆ mapping() [5/6]

◆ mapping() [6/6]

Member Function Documentation

◆ extents()

◆ is_always_exhaustive()

◆ is_always_strided()

◆ is_always_unique()

◆ is_exhaustive()

◆ is_strided()

◆ is_unique()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator=()

◆ required_span_size()

◆ stride()

Friends And Related Symbol Documentation

◆ mapping

◆ operator==