#include <discrete_domain.hpp>

Collaboration diagram for ddc::DiscreteDomain< DDims >:

Public Types
using	discrete_element_type = DiscreteElement< DDims... >

using	discrete_vector_type = DiscreteVector< DDims... >

Public Member Functions
KOKKOS_DEFAULTED_FUNCTION	DiscreteDomain ()=default

template<concepts::discrete_domain... DDoms>
KOKKOS_FUNCTION constexpr	DiscreteDomain (DDoms const &... domains)
	Construct a DiscreteDomain by copies and merge of domains.

KOKKOS_FUNCTION constexpr	DiscreteDomain (discrete_element_type const &element_begin, discrete_vector_type const &size)
	Construct a DiscreteDomain starting from element_begin with size points.

KOKKOS_DEFAULTED_FUNCTION	DiscreteDomain (DiscreteDomain const &x)=default

KOKKOS_DEFAULTED_FUNCTION	DiscreteDomain (DiscreteDomain &&x)=default

KOKKOS_DEFAULTED_FUNCTION	~DiscreteDomain ()=default

KOKKOS_DEFAULTED_FUNCTION DiscreteDomain &	operator= (DiscreteDomain const &x)=default

KOKKOS_DEFAULTED_FUNCTION DiscreteDomain &	operator= (DiscreteDomain &&x)=default

template<class... ODims>
KOKKOS_FUNCTION constexpr bool	operator== (DiscreteDomain< ODims... > const &other) const

template<class... ODims>
KOKKOS_FUNCTION constexpr bool	operator!= (DiscreteDomain< ODims... > const &other) const

KOKKOS_FUNCTION constexpr std::size_t	size () const

KOKKOS_FUNCTION constexpr discrete_vector_type	extents () const noexcept

template<class QueryDDim >
KOKKOS_FUNCTION constexpr DiscreteVector< QueryDDim >	extent () const noexcept

KOKKOS_FUNCTION constexpr discrete_element_type	front () const noexcept

KOKKOS_FUNCTION constexpr discrete_element_type	back () const noexcept

KOKKOS_FUNCTION constexpr DiscreteDomain	take_first (discrete_vector_type n) const

KOKKOS_FUNCTION constexpr DiscreteDomain	take_last (discrete_vector_type n) const

KOKKOS_FUNCTION constexpr DiscreteDomain	remove_first (discrete_vector_type n) const

KOKKOS_FUNCTION constexpr DiscreteDomain	remove_last (discrete_vector_type n) const

KOKKOS_FUNCTION constexpr DiscreteDomain	remove (discrete_vector_type n1, discrete_vector_type n2) const

KOKKOS_FUNCTION constexpr DiscreteElement< DDims... >	operator() (DiscreteVector< DDims... > const &dvect) const noexcept

template<class... ODDims>
KOKKOS_FUNCTION constexpr auto	restrict_with (DiscreteDomain< ODDims... > const &odomain) const

template<class... DElems>
KOKKOS_FUNCTION bool	contains (DElems const &... delems) const noexcept

template<class... DElems>
KOKKOS_FUNCTION DiscreteVector< DDims... >	distance_from_front (DElems const &... delems) const noexcept

KOKKOS_FUNCTION constexpr bool	empty () const noexcept

KOKKOS_FUNCTION constexpr	operator bool ()

KOKKOS_FUNCTION auto	begin () const

KOKKOS_FUNCTION auto	end () const

KOKKOS_FUNCTION auto	cbegin () const

KOKKOS_FUNCTION auto	cend () const

KOKKOS_FUNCTION constexpr decltype(auto)	operator[] (std::size_t n)

KOKKOS_FUNCTION constexpr decltype(auto)	operator[] (std::size_t n) const

Static Public Member Functions
static KOKKOS_FUNCTION constexpr std::size_t	rank ()

Friends
template<class... >
class	DiscreteDomain

Detailed Description

template<class... DDims>
class ddc::DiscreteDomain< DDims >

Definition at line 66 of file discrete_domain.hpp.

Member Typedef Documentation

◆ discrete_element_type

template<class... DDims>

using ddc::DiscreteDomain< DDims >::discrete_element_type = DiscreteElement<DDims...>

Definition at line 76 of file discrete_domain.hpp.

◆ discrete_vector_type

template<class... DDims>

using ddc::DiscreteDomain< DDims >::discrete_vector_type = DiscreteVector<DDims...>

Definition at line 78 of file discrete_domain.hpp.

Constructor & Destructor Documentation

◆ DiscreteDomain() [1/5]

template<class... DDims>

KOKKOS_DEFAULTED_FUNCTION ddc::DiscreteDomain< DDims >::DiscreteDomain ( )

default

◆ DiscreteDomain() [2/5]

template<class... DDims>

template<concepts::discrete_domain... DDoms>

KOKKOS_FUNCTION constexpr ddc::DiscreteDomain< DDims >::DiscreteDomain ( DDoms const &... domains )

inlineexplicitconstexpr

Construct a DiscreteDomain by copies and merge of domains.

Definition at line 95 of file discrete_domain.hpp.

◆ DiscreteDomain() [3/5]

template<class... DDims>

KOKKOS_FUNCTION constexpr ddc::DiscreteDomain< DDims >::DiscreteDomain	(	discrete_element_type const &	element_begin,
		discrete_vector_type const &	size
	)

inlineconstexpr

Construct a DiscreteDomain starting from element_begin with size points.

Parameters

element_begin	the lower bound in each direction
size	the number of points in each direction

Definition at line 105 of file discrete_domain.hpp.

◆ DiscreteDomain() [4/5]

template<class... DDims>

KOKKOS_DEFAULTED_FUNCTION ddc::DiscreteDomain< DDims >::DiscreteDomain ( DiscreteDomain< DDims > const & x )

default

◆ DiscreteDomain() [5/5]

template<class... DDims>

KOKKOS_DEFAULTED_FUNCTION ddc::DiscreteDomain< DDims >::DiscreteDomain ( DiscreteDomain< DDims > && x )

default

◆ ~DiscreteDomain()

template<class... DDims>

KOKKOS_DEFAULTED_FUNCTION ddc::DiscreteDomain< DDims >::~DiscreteDomain ( )

default

Member Function Documentation

◆ rank()

template<class... DDims>

static KOKKOS_FUNCTION constexpr std::size_t ddc::DiscreteDomain< DDims >::rank ( )

inlinestaticconstexpr

Definition at line 86 of file discrete_domain.hpp.

◆ operator=() [1/2]

template<class... DDims>

KOKKOS_DEFAULTED_FUNCTION DiscreteDomain & ddc::DiscreteDomain< DDims >::operator= ( DiscreteDomain< DDims > const & x )

default

◆ operator=() [2/2]

template<class... DDims>

KOKKOS_DEFAULTED_FUNCTION DiscreteDomain & ddc::DiscreteDomain< DDims >::operator= ( DiscreteDomain< DDims > && x )

default

◆ operator==()

template<class... DDims>

template<class... ODims>

KOKKOS_FUNCTION constexpr bool ddc::DiscreteDomain< DDims >::operator== ( DiscreteDomain< ODims... > const & other ) const

inlineconstexpr

Definition at line 124 of file discrete_domain.hpp.

◆ operator!=()

template<class... DDims>

template<class... ODims>

KOKKOS_FUNCTION constexpr bool ddc::DiscreteDomain< DDims >::operator!= ( DiscreteDomain< ODims... > const & other ) const

inlineconstexpr

Definition at line 135 of file discrete_domain.hpp.

◆ size()

template<class... DDims>

KOKKOS_FUNCTION constexpr std::size_t ddc::DiscreteDomain< DDims >::size ( ) const

inlineconstexpr

Definition at line 141 of file discrete_domain.hpp.

◆ extents()

template<class... DDims>

KOKKOS_FUNCTION constexpr discrete_vector_type ddc::DiscreteDomain< DDims >::extents ( ) const

inlineconstexprnoexcept

Definition at line 146 of file discrete_domain.hpp.

◆ extent()

template<class... DDims>

template<class QueryDDim >

KOKKOS_FUNCTION constexpr DiscreteVector< QueryDDim > ddc::DiscreteDomain< DDims >::extent ( ) const

inlineconstexprnoexcept

Definition at line 152 of file discrete_domain.hpp.

◆ front()

template<class... DDims>

KOKKOS_FUNCTION constexpr discrete_element_type ddc::DiscreteDomain< DDims >::front ( ) const

inlineconstexprnoexcept

Definition at line 158 of file discrete_domain.hpp.

◆ back()

template<class... DDims>

KOKKOS_FUNCTION constexpr discrete_element_type ddc::DiscreteDomain< DDims >::back ( ) const

inlineconstexprnoexcept

Definition at line 163 of file discrete_domain.hpp.

◆ take_first()

template<class... DDims>

KOKKOS_FUNCTION constexpr DiscreteDomain ddc::DiscreteDomain< DDims >::take_first ( discrete_vector_type n ) const

inlineconstexpr

Definition at line 168 of file discrete_domain.hpp.

◆ take_last()

template<class... DDims>

KOKKOS_FUNCTION constexpr DiscreteDomain ddc::DiscreteDomain< DDims >::take_last ( discrete_vector_type n ) const

inlineconstexpr

Definition at line 173 of file discrete_domain.hpp.

◆ remove_first()

template<class... DDims>

KOKKOS_FUNCTION constexpr DiscreteDomain ddc::DiscreteDomain< DDims >::remove_first ( discrete_vector_type n ) const

inlineconstexpr

Definition at line 178 of file discrete_domain.hpp.

◆ remove_last()

template<class... DDims>

KOKKOS_FUNCTION constexpr DiscreteDomain ddc::DiscreteDomain< DDims >::remove_last ( discrete_vector_type n ) const

inlineconstexpr

Definition at line 183 of file discrete_domain.hpp.

◆ remove()

template<class... DDims>

KOKKOS_FUNCTION constexpr DiscreteDomain ddc::DiscreteDomain< DDims >::remove	(	discrete_vector_type	n1,
		discrete_vector_type	n2
	)		const

inlineconstexpr

Definition at line 188 of file discrete_domain.hpp.

◆ operator()()

template<class... DDims>

KOKKOS_FUNCTION constexpr DiscreteElement< DDims... > ddc::DiscreteDomain< DDims >::operator() ( DiscreteVector< DDims... > const & dvect ) const

inlineconstexprnoexcept

Definition at line 195 of file discrete_domain.hpp.

◆ restrict_with()

template<class... DDims>

template<class... ODDims>

KOKKOS_FUNCTION constexpr auto ddc::DiscreteDomain< DDims >::restrict_with ( DiscreteDomain< ODDims... > const & odomain ) const

inlineconstexpr

Definition at line 202 of file discrete_domain.hpp.

◆ contains()

template<class... DDims>

template<class... DElems>

KOKKOS_FUNCTION bool ddc::DiscreteDomain< DDims >::contains ( DElems const &... delems ) const

inlinenoexcept

Definition at line 223 of file discrete_domain.hpp.

◆ distance_from_front()

template<class... DDims>

template<class... DElems>

KOKKOS_FUNCTION DiscreteVector< DDims... > ddc::DiscreteDomain< DDims >::distance_from_front ( DElems const &... delems ) const

inlinenoexcept

Definition at line 240 of file discrete_domain.hpp.

◆ empty()

template<class... DDims>

KOKKOS_FUNCTION constexpr bool ddc::DiscreteDomain< DDims >::empty ( ) const

inlineconstexprnoexcept

Definition at line 252 of file discrete_domain.hpp.

◆ operator bool()

template<class... DDims>

KOKKOS_FUNCTION constexpr ddc::DiscreteDomain< DDims >::operator bool ( )

inlineexplicitconstexpr

Definition at line 257 of file discrete_domain.hpp.

◆ begin()

template<class... DDims>

KOKKOS_FUNCTION auto ddc::DiscreteDomain< DDims >::begin ( ) const

inline

Definition at line 262 of file discrete_domain.hpp.

◆ end()

template<class... DDims>

KOKKOS_FUNCTION auto ddc::DiscreteDomain< DDims >::end ( ) const

inline

Definition at line 268 of file discrete_domain.hpp.

◆ cbegin()

template<class... DDims>

KOKKOS_FUNCTION auto ddc::DiscreteDomain< DDims >::cbegin ( ) const

inline

Definition at line 274 of file discrete_domain.hpp.

◆ cend()

template<class... DDims>

KOKKOS_FUNCTION auto ddc::DiscreteDomain< DDims >::cend ( ) const

inline

Definition at line 280 of file discrete_domain.hpp.

◆ operator[]() [1/2]

template<class... DDims>

KOKKOS_FUNCTION constexpr decltype(auto) ddc::DiscreteDomain< DDims >::operator[] ( std::size_t n )

inlineconstexpr

Definition at line 286 of file discrete_domain.hpp.

◆ operator[]() [2/2]

template<class... DDims>

KOKKOS_FUNCTION constexpr decltype(auto) ddc::DiscreteDomain< DDims >::operator[] ( std::size_t n ) const

inlineconstexpr

Definition at line 292 of file discrete_domain.hpp.

Friends And Related Symbol Documentation

◆ DiscreteDomain

template<class... DDims>

template<class... >

friend class DiscreteDomain

friend

Definition at line 69 of file discrete_domain.hpp.

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

discrete_domain.hpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ discrete_element_type

◆ discrete_vector_type

Constructor & Destructor Documentation

◆ DiscreteDomain() [1/5]

◆ DiscreteDomain() [2/5]

◆ DiscreteDomain() [3/5]

◆ DiscreteDomain() [4/5]

◆ DiscreteDomain() [5/5]

◆ ~DiscreteDomain()

Member Function Documentation

◆ rank()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator!=()

◆ size()

◆ extents()

◆ extent()

◆ front()

◆ back()

◆ take_first()

◆ take_last()

◆ remove_first()

◆ remove_last()

◆ remove()

◆ operator()()

◆ restrict_with()

◆ contains()

◆ distance_from_front()

◆ empty()

◆ operator bool()

◆ begin()

◆ end()

◆ cbegin()

◆ cend()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

Friends And Related Symbol Documentation

◆ DiscreteDomain