DDC 0.0.0

a discrete domain computation library

ddc::DiscreteDomain<> Class Reference

Public Types

using discrete_element_type = DiscreteElement<>
 
using mlength_type = DiscreteVector<>
 

Public Member Functions

KOKKOS_DEFAULTED_FUNCTION constexpr DiscreteDomain ()=default
 
template<class... ODDims>
KOKKOS_FUNCTION constexpr DiscreteDomain (DiscreteDomain< ODDims... > const &domain)
 
KOKKOS_FUNCTION constexpr DiscreteDomain (discrete_element_type const &element_begin, mlength_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 DiscreteDomainoperator= (DiscreteDomain const &x)=default
 
KOKKOS_DEFAULTED_FUNCTION DiscreteDomainoperator= (DiscreteDomain &&x)=default
 
KOKKOS_FUNCTION constexpr bool operator== (DiscreteDomain const &other) const
 
KOKKOS_FUNCTION constexpr bool operator!= (DiscreteDomain const &other) const
 
KOKKOS_FUNCTION constexpr std::size_t size () const
 
KOKKOS_FUNCTION constexpr mlength_type extents () 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 (mlength_type n) const
 
KOKKOS_FUNCTION constexpr DiscreteDomain take_last (mlength_type n) const
 
KOKKOS_FUNCTION constexpr DiscreteDomain remove_first (mlength_type n) const
 
KOKKOS_FUNCTION constexpr DiscreteDomain remove_last (mlength_type n) const
 
KOKKOS_FUNCTION constexpr DiscreteDomain remove (mlength_type n1, mlength_type n2) const
 
template<class... ODims>
KOKKOS_FUNCTION constexpr DiscreteDomain restrict (DiscreteDomain< ODims... > const &) const
 
KOKKOS_FUNCTION constexpr bool empty () const noexcept
 
KOKKOS_FUNCTION constexpr operator bool ()
 

Static Public Member Functions

static KOKKOS_FUNCTION constexpr std::size_t rank ()
 

Friends

template<class... >
class DiscreteDomain
 

Member Typedef Documentation

◆ discrete_element_type

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

◆ mlength_type

Constructor & Destructor Documentation

◆ DiscreteDomain() [1/5]

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

◆ DiscreteDomain() [2/5]

template<class... ODDims>
KOKKOS_FUNCTION constexpr ddc::DiscreteDomain<>::DiscreteDomain ( DiscreteDomain< ODDims... > const & domain)
inlineexplicitconstexpr

◆ DiscreteDomain() [3/5]

KOKKOS_FUNCTION constexpr ddc::DiscreteDomain<>::DiscreteDomain ( discrete_element_type const & element_begin,
mlength_type const & size )
inlineconstexpr

Construct a DiscreteDomain starting from element_begin with size points.

Parameters
element_beginthe lower bound in each direction
sizethe number of points in each direction

◆ DiscreteDomain() [4/5]

◆ DiscreteDomain() [5/5]

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

◆ ~DiscreteDomain()

Member Function Documentation

◆ rank()

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

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator!=()

◆ size()

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

◆ extents()

KOKKOS_FUNCTION constexpr mlength_type ddc::DiscreteDomain<>::extents ( ) const
inlineconstexprnoexcept

◆ front()

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

◆ back()

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

◆ take_first()

KOKKOS_FUNCTION constexpr DiscreteDomain ddc::DiscreteDomain<>::take_first ( mlength_type n) const
inlineconstexpr

◆ take_last()

KOKKOS_FUNCTION constexpr DiscreteDomain ddc::DiscreteDomain<>::take_last ( mlength_type n) const
inlineconstexpr

◆ remove_first()

KOKKOS_FUNCTION constexpr DiscreteDomain ddc::DiscreteDomain<>::remove_first ( mlength_type n) const
inlineconstexpr

◆ remove_last()

KOKKOS_FUNCTION constexpr DiscreteDomain ddc::DiscreteDomain<>::remove_last ( mlength_type n) const
inlineconstexpr

◆ remove()

◆ restrict()

template<class... ODims>
KOKKOS_FUNCTION constexpr DiscreteDomain ddc::DiscreteDomain<>::restrict ( DiscreteDomain< ODims... > const & ) const
inlineconstexpr

◆ empty()

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

◆ operator bool()

Friends And Related Symbol Documentation

◆ DiscreteDomain

template<class... >
friend class DiscreteDomain
friend

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