DDC 0.5.0
Loading...
Searching...
No Matches
ddc::StridedDiscreteDomain< DDims > Class Template Reference

#include <strided_discrete_domain.hpp>

Collaboration diagram for ddc::StridedDiscreteDomain< DDims >:
Collaboration graph

Public Types

using discrete_element_type = DiscreteElement< DDims... >
 
using discrete_vector_type = DiscreteVector< DDims... >
 

Public Member Functions

KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain ()=default
 
template<class... DDoms, class = std::enable_if_t<(is_strided_discrete_domain_v<DDoms> && ...)>>
KOKKOS_FUNCTION constexpr StridedDiscreteDomain (DDoms const &... domains)
 Construct a StridedDiscreteDomain by copies and merge of domains.
 
KOKKOS_FUNCTION constexpr StridedDiscreteDomain (discrete_element_type const &element_begin, discrete_vector_type const &extents, discrete_vector_type const &strides)
 Construct a StridedDiscreteDomain starting from element_begin with size points.
 
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain (StridedDiscreteDomain const &x)=default
 
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain (StridedDiscreteDomain &&x)=default
 
KOKKOS_DEFAULTED_FUNCTION ~StridedDiscreteDomain ()=default
 
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomainoperator= (StridedDiscreteDomain const &x)=default
 
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomainoperator= (StridedDiscreteDomain &&x)=default
 
template<class... ODims>
KOKKOS_FUNCTION constexpr bool operator== (StridedDiscreteDomain< ODims... > const &other) const
 
template<class... ODims>
KOKKOS_FUNCTION constexpr bool operator!= (StridedDiscreteDomain< ODims... > const &other) const
 
KOKKOS_FUNCTION constexpr std::size_t size () const
 
KOKKOS_FUNCTION constexpr discrete_vector_type extents () const noexcept
 
KOKKOS_FUNCTION constexpr discrete_vector_type strides () const noexcept
 
template<class QueryDDim >
KOKKOS_FUNCTION constexpr DiscreteVector< QueryDDimextent () const noexcept
 
KOKKOS_FUNCTION constexpr discrete_element_type front () const noexcept
 
KOKKOS_FUNCTION constexpr discrete_element_type back () const noexcept
 
KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_first (discrete_vector_type n) const
 
KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_last (discrete_vector_type n) const
 
KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_first (discrete_vector_type n) const
 
KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_last (discrete_vector_type n) const
 
KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove (discrete_vector_type n1, discrete_vector_type n2) const
 
KOKKOS_FUNCTION constexpr DiscreteElement< DDims... > operator() (DiscreteVector< DDims... > const &dvect) const noexcept
 
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 ()
 
template<std::size_t N = sizeof...(DDims), class DDim0 = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
KOKKOS_FUNCTION auto begin () const
 
template<std::size_t N = sizeof...(DDims), class DDim0 = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
KOKKOS_FUNCTION auto end () const
 
template<std::size_t N = sizeof...(DDims), class DDim0 = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
KOKKOS_FUNCTION auto cbegin () const
 
template<std::size_t N = sizeof...(DDims), class DDim0 = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
KOKKOS_FUNCTION auto cend () const
 
template<std::size_t N = sizeof...(DDims), class = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
KOKKOS_FUNCTION constexpr decltype(autooperator[] (std::size_t n)
 
template<std::size_t N = sizeof...(DDims), class = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
KOKKOS_FUNCTION constexpr decltype(autooperator[] (std::size_t n) const
 

Static Public Member Functions

static KOKKOS_FUNCTION constexpr std::size_t rank ()
 

Friends

template<class... >
class StridedDiscreteDomain
 

Detailed Description

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

Definition at line 69 of file strided_discrete_domain.hpp.

Member Typedef Documentation

◆ discrete_element_type

template<class... DDims>
using ddc::StridedDiscreteDomain< DDims >::discrete_element_type = DiscreteElement<DDims...>

Definition at line 75 of file strided_discrete_domain.hpp.

◆ discrete_vector_type

template<class... DDims>
using ddc::StridedDiscreteDomain< DDims >::discrete_vector_type = DiscreteVector<DDims...>

Definition at line 77 of file strided_discrete_domain.hpp.

Constructor & Destructor Documentation

◆ StridedDiscreteDomain() [1/5]

template<class... DDims>
KOKKOS_DEFAULTED_FUNCTION ddc::StridedDiscreteDomain< DDims >::StridedDiscreteDomain ( )
default

◆ StridedDiscreteDomain() [2/5]

template<class... DDims>
template<class... DDoms, class = std::enable_if_t<(is_strided_discrete_domain_v<DDoms> && ...)>>
KOKKOS_FUNCTION constexpr ddc::StridedDiscreteDomain< DDims >::StridedDiscreteDomain ( DDoms const &...  domains)
inlineexplicitconstexpr

Construct a StridedDiscreteDomain by copies and merge of domains.

Definition at line 98 of file strided_discrete_domain.hpp.

◆ StridedDiscreteDomain() [3/5]

template<class... DDims>
KOKKOS_FUNCTION constexpr ddc::StridedDiscreteDomain< DDims >::StridedDiscreteDomain ( discrete_element_type const element_begin,
discrete_vector_type const extents,
discrete_vector_type const strides 
)
inlineconstexpr

Construct a StridedDiscreteDomain starting from element_begin with size points.

Parameters
element_beginthe lower bound in each direction
extentsthe number of points in each direction
stridesthe step between two elements

Definition at line 110 of file strided_discrete_domain.hpp.

◆ StridedDiscreteDomain() [4/5]

template<class... DDims>
KOKKOS_DEFAULTED_FUNCTION ddc::StridedDiscreteDomain< DDims >::StridedDiscreteDomain ( StridedDiscreteDomain< DDims > const x)
default

◆ StridedDiscreteDomain() [5/5]

template<class... DDims>
KOKKOS_DEFAULTED_FUNCTION ddc::StridedDiscreteDomain< DDims >::StridedDiscreteDomain ( StridedDiscreteDomain< DDims > &&  x)
default

◆ ~StridedDiscreteDomain()

Member Function Documentation

◆ rank()

template<class... DDims>
static KOKKOS_FUNCTION constexpr std::size_t ddc::StridedDiscreteDomain< DDims >::rank ( )
inlinestaticconstexpr

Definition at line 87 of file strided_discrete_domain.hpp.

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

template<class... DDims>
template<class... ODims>
KOKKOS_FUNCTION constexpr bool ddc::StridedDiscreteDomain< DDims >::operator== ( StridedDiscreteDomain< ODims... > const other) const
inlineconstexpr

Definition at line 132 of file strided_discrete_domain.hpp.

◆ operator!=()

template<class... DDims>
template<class... ODims>
KOKKOS_FUNCTION constexpr bool ddc::StridedDiscreteDomain< DDims >::operator!= ( StridedDiscreteDomain< ODims... > const other) const
inlineconstexpr

Definition at line 144 of file strided_discrete_domain.hpp.

◆ size()

template<class... DDims>
KOKKOS_FUNCTION constexpr std::size_t ddc::StridedDiscreteDomain< DDims >::size ( ) const
inlineconstexpr

Definition at line 150 of file strided_discrete_domain.hpp.

◆ extents()

template<class... DDims>
KOKKOS_FUNCTION constexpr discrete_vector_type ddc::StridedDiscreteDomain< DDims >::extents ( ) const
inlineconstexprnoexcept

Definition at line 155 of file strided_discrete_domain.hpp.

◆ strides()

template<class... DDims>
KOKKOS_FUNCTION constexpr discrete_vector_type ddc::StridedDiscreteDomain< DDims >::strides ( ) const
inlineconstexprnoexcept

Definition at line 160 of file strided_discrete_domain.hpp.

◆ extent()

template<class... DDims>
template<class QueryDDim >
KOKKOS_FUNCTION constexpr DiscreteVector< QueryDDim > ddc::StridedDiscreteDomain< DDims >::extent ( ) const
inlineconstexprnoexcept

Definition at line 166 of file strided_discrete_domain.hpp.

◆ front()

template<class... DDims>
KOKKOS_FUNCTION constexpr discrete_element_type ddc::StridedDiscreteDomain< DDims >::front ( ) const
inlineconstexprnoexcept

Definition at line 171 of file strided_discrete_domain.hpp.

◆ back()

template<class... DDims>
KOKKOS_FUNCTION constexpr discrete_element_type ddc::StridedDiscreteDomain< DDims >::back ( ) const
inlineconstexprnoexcept

Definition at line 176 of file strided_discrete_domain.hpp.

◆ take_first()

template<class... DDims>
KOKKOS_FUNCTION constexpr StridedDiscreteDomain ddc::StridedDiscreteDomain< DDims >::take_first ( discrete_vector_type  n) const
inlineconstexpr

Definition at line 183 of file strided_discrete_domain.hpp.

◆ take_last()

template<class... DDims>
KOKKOS_FUNCTION constexpr StridedDiscreteDomain ddc::StridedDiscreteDomain< DDims >::take_last ( discrete_vector_type  n) const
inlineconstexpr

Definition at line 188 of file strided_discrete_domain.hpp.

◆ remove_first()

template<class... DDims>
KOKKOS_FUNCTION constexpr StridedDiscreteDomain ddc::StridedDiscreteDomain< DDims >::remove_first ( discrete_vector_type  n) const
inlineconstexpr

Definition at line 193 of file strided_discrete_domain.hpp.

◆ remove_last()

template<class... DDims>
KOKKOS_FUNCTION constexpr StridedDiscreteDomain ddc::StridedDiscreteDomain< DDims >::remove_last ( discrete_vector_type  n) const
inlineconstexpr

Definition at line 198 of file strided_discrete_domain.hpp.

◆ remove()

template<class... DDims>
KOKKOS_FUNCTION constexpr StridedDiscreteDomain ddc::StridedDiscreteDomain< DDims >::remove ( discrete_vector_type  n1,
discrete_vector_type  n2 
) const
inlineconstexpr

Definition at line 203 of file strided_discrete_domain.hpp.

◆ operator()()

template<class... DDims>
KOKKOS_FUNCTION constexpr DiscreteElement< DDims... > ddc::StridedDiscreteDomain< DDims >::operator() ( DiscreteVector< DDims... > const dvect) const
inlineconstexprnoexcept

Definition at line 210 of file strided_discrete_domain.hpp.

◆ contains()

template<class... DDims>
template<class... DElems>
KOKKOS_FUNCTION bool ddc::StridedDiscreteDomain< DDims >::contains ( DElems const &...  delems) const
inlinenoexcept

Definition at line 217 of file strided_discrete_domain.hpp.

◆ distance_from_front()

template<class... DDims>
template<class... DElems>
KOKKOS_FUNCTION DiscreteVector< DDims... > ddc::StridedDiscreteDomain< DDims >::distance_from_front ( DElems const &...  delems) const
inlinenoexcept

Definition at line 242 of file strided_discrete_domain.hpp.

◆ empty()

template<class... DDims>
KOKKOS_FUNCTION constexpr bool ddc::StridedDiscreteDomain< DDims >::empty ( ) const
inlineconstexprnoexcept

Definition at line 256 of file strided_discrete_domain.hpp.

◆ operator bool()

template<class... DDims>
KOKKOS_FUNCTION constexpr ddc::StridedDiscreteDomain< DDims >::operator bool ( )
inlineexplicitconstexpr

Definition at line 261 of file strided_discrete_domain.hpp.

◆ begin()

template<class... DDims>
template<std::size_t N = sizeof...(DDims), class DDim0 = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
KOKKOS_FUNCTION auto ddc::StridedDiscreteDomain< DDims >::begin ( ) const
inline

Definition at line 269 of file strided_discrete_domain.hpp.

◆ end()

template<class... DDims>
template<std::size_t N = sizeof...(DDims), class DDim0 = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
KOKKOS_FUNCTION auto ddc::StridedDiscreteDomain< DDims >::end ( ) const
inline

Definition at line 277 of file strided_discrete_domain.hpp.

◆ cbegin()

template<class... DDims>
template<std::size_t N = sizeof...(DDims), class DDim0 = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
KOKKOS_FUNCTION auto ddc::StridedDiscreteDomain< DDims >::cbegin ( ) const
inline

Definition at line 286 of file strided_discrete_domain.hpp.

◆ cend()

template<class... DDims>
template<std::size_t N = sizeof...(DDims), class DDim0 = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
KOKKOS_FUNCTION auto ddc::StridedDiscreteDomain< DDims >::cend ( ) const
inline

Definition at line 294 of file strided_discrete_domain.hpp.

◆ operator[]() [1/2]

template<class... DDims>
template<std::size_t N = sizeof...(DDims), class = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
KOKKOS_FUNCTION constexpr decltype(auto) ddc::StridedDiscreteDomain< DDims >::operator[] ( std::size_t  n)
inlineconstexpr

Definition at line 303 of file strided_discrete_domain.hpp.

◆ operator[]() [2/2]

template<class... DDims>
template<std::size_t N = sizeof...(DDims), class = std::enable_if_t<N == 1, std::tuple_element_t<0, std::tuple<DDims...>>>>
KOKKOS_FUNCTION constexpr decltype(auto) ddc::StridedDiscreteDomain< DDims >::operator[] ( std::size_t  n) const
inlineconstexpr

Definition at line 311 of file strided_discrete_domain.hpp.

Friends And Related Symbol Documentation

◆ StridedDiscreteDomain

template<class... DDims>
template<class... >
friend class StridedDiscreteDomain
friend

Definition at line 72 of file strided_discrete_domain.hpp.


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