#include <discrete_domain.hpp>

Collaboration diagram for ddc::DiscreteDomain<>:

Public Types
using	discrete_element_type = DiscreteElement<>

using	discrete_vector_type = DiscreteVector<>

Public Member Functions
KOKKOS_DEFAULTED_FUNCTION constexpr	DiscreteDomain ()=default

template<class... DDoms> requires (is_discrete_domain_v<DDoms> && ...)
KOKKOS_FUNCTION constexpr	DiscreteDomain (DDoms const &...)
	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

KOKKOS_FUNCTION constexpr bool	operator== (DiscreteDomain const &) const

KOKKOS_FUNCTION constexpr bool	operator!= (DiscreteDomain const &other) const

KOKKOS_FUNCTION constexpr DiscreteDomain	take_first (discrete_vector_type) const

KOKKOS_FUNCTION constexpr DiscreteDomain	take_last (discrete_vector_type) const

KOKKOS_FUNCTION constexpr DiscreteDomain	remove_first (discrete_vector_type) const

KOKKOS_FUNCTION constexpr DiscreteDomain	remove_last (discrete_vector_type) const

KOKKOS_FUNCTION constexpr DiscreteDomain	remove (discrete_vector_type, discrete_vector_type) const

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

template<concepts::discrete_dimension... ODDims>
KOKKOS_FUNCTION constexpr DiscreteDomain	restrict_with (DiscreteDomain< ODDims... > const &) const

KOKKOS_FUNCTION constexpr	operator bool ()

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

static KOKKOS_FUNCTION constexpr std::size_t	size ()

static KOKKOS_FUNCTION constexpr discrete_vector_type	extents () noexcept

static KOKKOS_FUNCTION constexpr discrete_element_type	front () noexcept

static KOKKOS_FUNCTION constexpr discrete_element_type	back () noexcept

static KOKKOS_FUNCTION bool	contains () noexcept

static KOKKOS_FUNCTION bool	contains (DiscreteElement<>) noexcept

static KOKKOS_FUNCTION DiscreteVector	distance_from_front () noexcept

static KOKKOS_FUNCTION DiscreteVector	distance_from_front (DiscreteElement<>) noexcept

static KOKKOS_FUNCTION constexpr bool	empty () noexcept

Friends
template<concepts::discrete_dimension... >
class	DiscreteDomain

Detailed Description

Definition at line 302 of file discrete_domain.hpp.

Member Typedef Documentation

◆ discrete_element_type

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

Definition at line 308 of file discrete_domain.hpp.

◆ discrete_vector_type

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

Definition at line 310 of file discrete_domain.hpp.

Constructor & Destructor Documentation

◆ DiscreteDomain() [1/5]

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

constexprdefault

◆ DiscreteDomain() [2/5]

template<class... DDoms>
requires (is_discrete_domain_v<DDoms> && ...)

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

inlineexplicitconstexpr

Construct a DiscreteDomain by copies and merge of domains.

Definition at line 321 of file discrete_domain.hpp.

◆ DiscreteDomain() [3/5]

KOKKOS_FUNCTION constexpr ddc::DiscreteDomain<>::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 330 of file discrete_domain.hpp.

◆ DiscreteDomain() [4/5]

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

default

◆ DiscreteDomain() [5/5]

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

default

◆ ~DiscreteDomain()

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

default

Member Function Documentation

◆ rank()

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

inlinestaticconstexpr

Definition at line 312 of file discrete_domain.hpp.

◆ operator=() [1/2]

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

default

◆ operator=() [2/2]

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

default

◆ operator==()

KOKKOS_FUNCTION constexpr bool ddc::DiscreteDomain<>::operator== ( DiscreteDomain<> const & ) const

inlineconstexpr

Definition at line 347 of file discrete_domain.hpp.

◆ operator!=()

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

inlineconstexpr

Definition at line 354 of file discrete_domain.hpp.

◆ size()

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

inlinestaticconstexpr

Definition at line 360 of file discrete_domain.hpp.

◆ extents()

static KOKKOS_FUNCTION constexpr discrete_vector_type ddc::DiscreteDomain<>::extents ( )

inlinestaticconstexprnoexcept

Definition at line 365 of file discrete_domain.hpp.

◆ front()

static KOKKOS_FUNCTION constexpr discrete_element_type ddc::DiscreteDomain<>::front ( )

inlinestaticconstexprnoexcept

Definition at line 370 of file discrete_domain.hpp.

◆ back()

static KOKKOS_FUNCTION constexpr discrete_element_type ddc::DiscreteDomain<>::back ( )

inlinestaticconstexprnoexcept

Definition at line 375 of file discrete_domain.hpp.

◆ take_first()

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

inlineconstexpr

Definition at line 380 of file discrete_domain.hpp.

◆ take_last()

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

inlineconstexpr

Definition at line 385 of file discrete_domain.hpp.

◆ remove_first()

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

inlineconstexpr

Definition at line 390 of file discrete_domain.hpp.

◆ remove_last()

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

inlineconstexpr

Definition at line 395 of file discrete_domain.hpp.

◆ remove()

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

inlineconstexpr

Definition at line 400 of file discrete_domain.hpp.

◆ operator()()

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

inlineconstexprnoexcept

Definition at line 407 of file discrete_domain.hpp.

◆ restrict_with()

template<concepts::discrete_dimension... ODDims>

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

inlineconstexpr

Definition at line 414 of file discrete_domain.hpp.

◆ contains() [1/2]

static KOKKOS_FUNCTION bool ddc::DiscreteDomain<>::contains ( )

inlinestaticnoexcept

Definition at line 420 of file discrete_domain.hpp.

◆ contains() [2/2]

static KOKKOS_FUNCTION bool ddc::DiscreteDomain<>::contains ( DiscreteElement<> )

inlinestaticnoexcept

Definition at line 425 of file discrete_domain.hpp.

◆ distance_from_front() [1/2]

static KOKKOS_FUNCTION DiscreteVector ddc::DiscreteDomain<>::distance_from_front ( )

inlinestaticnoexcept

Definition at line 430 of file discrete_domain.hpp.

◆ distance_from_front() [2/2]

static KOKKOS_FUNCTION DiscreteVector ddc::DiscreteDomain<>::distance_from_front ( DiscreteElement<> )

inlinestaticnoexcept

Definition at line 435 of file discrete_domain.hpp.

◆ empty()

static KOKKOS_FUNCTION constexpr bool ddc::DiscreteDomain<>::empty ( )

inlinestaticconstexprnoexcept

Definition at line 440 of file discrete_domain.hpp.

◆ operator bool()

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

inlineexplicitconstexpr

Definition at line 445 of file discrete_domain.hpp.

Friends And Related Symbol Documentation

◆ DiscreteDomain

template<concepts::discrete_dimension... >

friend class DiscreteDomain

friend

Definition at line 305 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()

◆ front()

◆ back()

◆ take_first()

◆ take_last()

◆ remove_first()

◆ remove_last()

◆ remove()

◆ operator()()

◆ restrict_with()

◆ contains() [1/2]

◆ contains() [2/2]

◆ distance_from_front() [1/2]

◆ distance_from_front() [2/2]

◆ empty()

◆ operator bool()

Friends And Related Symbol Documentation

◆ DiscreteDomain