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

#include <strided_discrete_domain.hpp>

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

Public Types

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

Public Member Functions

KOKKOS_DEFAULTED_FUNCTION constexpr StridedDiscreteDomain ()=default
 
template<concepts::discrete_dimension... ODDims>
KOKKOS_FUNCTION constexpr StridedDiscreteDomain (StridedDiscreteDomain< ODDims... > const &)
 
KOKKOS_FUNCTION constexpr StridedDiscreteDomain (discrete_element_type const &element_begin, discrete_vector_type const &size, 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 StridedDiscreteDomain & operator= (StridedDiscreteDomain const &x)=default
 
KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain & operator= (StridedDiscreteDomain &&x)=default
 
KOKKOS_FUNCTION constexpr bool operator== (StridedDiscreteDomain const &) const
 
KOKKOS_FUNCTION constexpr bool operator!= (StridedDiscreteDomain const &other) const
 
KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_first (discrete_vector_type) const
 
KOKKOS_FUNCTION constexpr StridedDiscreteDomain take_last (discrete_vector_type) const
 
KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_first (discrete_vector_type) const
 
KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove_last (discrete_vector_type) const
 
KOKKOS_FUNCTION constexpr StridedDiscreteDomain remove (discrete_vector_type, discrete_vector_type) const
 
KOKKOS_FUNCTION constexpr DiscreteElement operator() (DiscreteVector<> const &) const noexcept
 
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_vector_type strides () 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 StridedDiscreteDomain
 

Detailed Description

Definition at line 319 of file strided_discrete_domain.hpp.

Member Typedef Documentation

◆ discrete_element_type

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

Definition at line 325 of file strided_discrete_domain.hpp.

◆ discrete_vector_type

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

Definition at line 327 of file strided_discrete_domain.hpp.

Constructor & Destructor Documentation

◆ StridedDiscreteDomain() [1/5]

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

◆ StridedDiscreteDomain() [2/5]

template<concepts::discrete_dimension... ODDims>
KOKKOS_FUNCTION constexpr ddc::StridedDiscreteDomain<>::StridedDiscreteDomain ( StridedDiscreteDomain< ODDims... > const &  )
inlineexplicitconstexpr

Definition at line 338 of file strided_discrete_domain.hpp.

◆ StridedDiscreteDomain() [3/5]

KOKKOS_FUNCTION constexpr ddc::StridedDiscreteDomain<>::StridedDiscreteDomain ( discrete_element_type const &  element_begin,
discrete_vector_type const &  size,
discrete_vector_type const &  strides 
)
inlineconstexpr

Construct a StridedDiscreteDomain starting from element_begin with size points.

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

Definition at line 348 of file strided_discrete_domain.hpp.

◆ StridedDiscreteDomain() [4/5]

KOKKOS_DEFAULTED_FUNCTION ddc::StridedDiscreteDomain<>::StridedDiscreteDomain ( StridedDiscreteDomain<> const &  x)
default

◆ StridedDiscreteDomain() [5/5]

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

◆ ~StridedDiscreteDomain()

KOKKOS_DEFAULTED_FUNCTION ddc::StridedDiscreteDomain<>::~StridedDiscreteDomain ( )
default

Member Function Documentation

◆ rank()

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

Definition at line 329 of file strided_discrete_domain.hpp.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

KOKKOS_DEFAULTED_FUNCTION StridedDiscreteDomain & ddc::StridedDiscreteDomain<>::operator= ( StridedDiscreteDomain<> &&  x)
default

◆ operator==()

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

Definition at line 367 of file strided_discrete_domain.hpp.

◆ operator!=()

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

Definition at line 374 of file strided_discrete_domain.hpp.

◆ size()

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

Definition at line 380 of file strided_discrete_domain.hpp.

◆ extents()

static KOKKOS_FUNCTION constexpr discrete_vector_type ddc::StridedDiscreteDomain<>::extents ( )
inlinestaticconstexprnoexcept

Definition at line 385 of file strided_discrete_domain.hpp.

◆ strides()

static KOKKOS_FUNCTION constexpr discrete_vector_type ddc::StridedDiscreteDomain<>::strides ( )
inlinestaticconstexprnoexcept

Definition at line 390 of file strided_discrete_domain.hpp.

◆ front()

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

Definition at line 395 of file strided_discrete_domain.hpp.

◆ back()

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

Definition at line 400 of file strided_discrete_domain.hpp.

◆ take_first()

KOKKOS_FUNCTION constexpr StridedDiscreteDomain ddc::StridedDiscreteDomain<>::take_first ( discrete_vector_type  ) const
inlineconstexpr

Definition at line 405 of file strided_discrete_domain.hpp.

◆ take_last()

KOKKOS_FUNCTION constexpr StridedDiscreteDomain ddc::StridedDiscreteDomain<>::take_last ( discrete_vector_type  ) const
inlineconstexpr

Definition at line 410 of file strided_discrete_domain.hpp.

◆ remove_first()

KOKKOS_FUNCTION constexpr StridedDiscreteDomain ddc::StridedDiscreteDomain<>::remove_first ( discrete_vector_type  ) const
inlineconstexpr

Definition at line 415 of file strided_discrete_domain.hpp.

◆ remove_last()

KOKKOS_FUNCTION constexpr StridedDiscreteDomain ddc::StridedDiscreteDomain<>::remove_last ( discrete_vector_type  ) const
inlineconstexpr

Definition at line 420 of file strided_discrete_domain.hpp.

◆ remove()

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

Definition at line 425 of file strided_discrete_domain.hpp.

◆ operator()()

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

Definition at line 432 of file strided_discrete_domain.hpp.

◆ contains() [1/2]

static KOKKOS_FUNCTION bool ddc::StridedDiscreteDomain<>::contains ( )
inlinestaticnoexcept

Definition at line 438 of file strided_discrete_domain.hpp.

◆ contains() [2/2]

static KOKKOS_FUNCTION bool ddc::StridedDiscreteDomain<>::contains ( DiscreteElement<>  )
inlinestaticnoexcept

Definition at line 443 of file strided_discrete_domain.hpp.

◆ distance_from_front() [1/2]

static KOKKOS_FUNCTION DiscreteVector ddc::StridedDiscreteDomain<>::distance_from_front ( )
inlinestaticnoexcept

Definition at line 448 of file strided_discrete_domain.hpp.

◆ distance_from_front() [2/2]

static KOKKOS_FUNCTION DiscreteVector ddc::StridedDiscreteDomain<>::distance_from_front ( DiscreteElement<>  )
inlinestaticnoexcept

Definition at line 453 of file strided_discrete_domain.hpp.

◆ empty()

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

Definition at line 458 of file strided_discrete_domain.hpp.

◆ operator bool()

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

Definition at line 463 of file strided_discrete_domain.hpp.

Friends And Related Symbol Documentation

◆ StridedDiscreteDomain

template<concepts::discrete_dimension... >
friend class StridedDiscreteDomain
friend

Definition at line 322 of file strided_discrete_domain.hpp.

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