DDC 0.1.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
ddc::DiscreteDomain<> Class Reference

#include <discrete_domain.hpp>

Collaboration diagram for ddc::DiscreteDomain<>:
Collaboration graph

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 DiscreteDomain & operator= (DiscreteDomain const &x)=default
 
KOKKOS_DEFAULTED_FUNCTION DiscreteDomain & operator= (DiscreteDomain &&x)=default
 
KOKKOS_FUNCTION constexpr bool operator== (DiscreteDomain const &other) const
 
KOKKOS_FUNCTION constexpr bool operator!= (DiscreteDomain const &other) const
 
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 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 mlength_type extents () noexcept
 
static KOKKOS_FUNCTION constexpr discrete_element_type front () noexcept
 
static KOKKOS_FUNCTION constexpr discrete_element_type back () noexcept
 
static KOKKOS_FUNCTION constexpr bool empty () noexcept
 

Friends

template<class... >
class DiscreteDomain
 

Detailed Description

Definition at line 248 of file discrete_domain.hpp.

Member Typedef Documentation

◆ discrete_element_type

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

Definition at line 254 of file discrete_domain.hpp.

◆ mlength_type

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

Definition at line 256 of file discrete_domain.hpp.

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

Definition at line 267 of file discrete_domain.hpp.

◆ 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

Definition at line 276 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 258 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 &  other) const
inlineconstexpr

Definition at line 292 of file discrete_domain.hpp.

◆ operator!=()

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

Definition at line 299 of file discrete_domain.hpp.

◆ size()

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

Definition at line 305 of file discrete_domain.hpp.

◆ extents()

static KOKKOS_FUNCTION constexpr mlength_type ddc::DiscreteDomain<>::extents ( )
inlinestaticconstexprnoexcept

Definition at line 310 of file discrete_domain.hpp.

◆ front()

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

Definition at line 315 of file discrete_domain.hpp.

◆ back()

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

Definition at line 320 of file discrete_domain.hpp.

◆ take_first()

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

Definition at line 325 of file discrete_domain.hpp.

◆ take_last()

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

Definition at line 330 of file discrete_domain.hpp.

◆ remove_first()

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

Definition at line 335 of file discrete_domain.hpp.

◆ remove_last()

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

Definition at line 340 of file discrete_domain.hpp.

◆ remove()

KOKKOS_FUNCTION constexpr DiscreteDomain ddc::DiscreteDomain<>::remove ( mlength_type  n1,
mlength_type  n2 
) const
inlineconstexpr

Definition at line 345 of file discrete_domain.hpp.

◆ restrict()

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

Definition at line 353 of file discrete_domain.hpp.

◆ empty()

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

Definition at line 358 of file discrete_domain.hpp.

◆ operator bool()

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

Definition at line 363 of file discrete_domain.hpp.

Friends And Related Symbol Documentation

◆ DiscreteDomain

template<class... >
friend class DiscreteDomain
friend

Definition at line 251 of file discrete_domain.hpp.

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