ddc::DiscreteElement< Tags > Class Template Reference

A DiscreteElement identifies an element of the discrete dimension. More...

#include <discrete_element.hpp>

Collaboration diagram for ddc::DiscreteElement< Tags >:

Public Types
using	value_type = DiscreteElementType

Public Member Functions
KOKKOS_DEFAULTED_FUNCTION constexpr	DiscreteElement ()=default
KOKKOS_DEFAULTED_FUNCTION constexpr	DiscreteElement (DiscreteElement const &)=default
KOKKOS_DEFAULTED_FUNCTION constexpr	DiscreteElement (DiscreteElement &&)=default
template<concepts::discrete_element... DElems>
KOKKOS_FUNCTION constexpr	DiscreteElement (DElems const &... delems) noexcept
template<std::convertible_to< DiscreteElementType > IntegerType>
KOKKOS_FUNCTION constexpr	DiscreteElement (std::array< IntegerType, sizeof...(Tags)> const &values) noexcept
template<std::convertible_to< DiscreteElementType >... Params> requires ((!is_discrete_element_v<Params> && ...) && sizeof...(Params) == sizeof...(Tags))
KOKKOS_FUNCTION constexpr	DiscreteElement (Params const &... params) noexcept
KOKKOS_DEFAULTED_FUNCTION	~DiscreteElement ()=default
KOKKOS_DEFAULTED_FUNCTION DiscreteElement &	operator= (DiscreteElement const &other)=default
KOKKOS_DEFAULTED_FUNCTION DiscreteElement &	operator= (DiscreteElement &&other)=default
template<class QueryTag >
KOKKOS_FUNCTION constexpr value_type &	uid () noexcept
template<class QueryTag >
KOKKOS_FUNCTION constexpr value_type const &	uid () const noexcept
KOKKOS_FUNCTION constexpr value_type &	uid () noexcept
KOKKOS_FUNCTION constexpr value_type const &	uid () const noexcept
KOKKOS_FUNCTION constexpr DiscreteElement &	operator++ ()
KOKKOS_FUNCTION constexpr DiscreteElement	operator++ (int)
KOKKOS_FUNCTION constexpr DiscreteElement &	operator-- ()
KOKKOS_FUNCTION constexpr DiscreteElement	operator-- (int)
template<class... OTags>
KOKKOS_FUNCTION constexpr DiscreteElement &	operator+= (DiscreteVector< OTags... > const &rhs)
template<std::integral IntegralType> requires (sizeof...(Tags) == 1)
KOKKOS_FUNCTION constexpr DiscreteElement &	operator+= (IntegralType const &rhs)
template<class... OTags>
KOKKOS_FUNCTION constexpr DiscreteElement &	operator-= (DiscreteVector< OTags... > const &rhs)
template<std::integral IntegralType> requires (sizeof...(Tags) == 1)
KOKKOS_FUNCTION constexpr DiscreteElement &	operator-= (IntegralType const &rhs)

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

Detailed Description

template<class... Tags>
class ddc::DiscreteElement< Tags >

A DiscreteElement identifies an element of the discrete dimension.

Each one is tagged by its associated dimensions.

Definition at line 163 of file discrete_element.hpp.

Member Typedef Documentation

value_type

template<class... Tags>

using ddc::DiscreteElement< Tags >::value_type = DiscreteElementType

Definition at line 181 of file discrete_element.hpp.

Constructor & Destructor Documentation

DiscreteElement() [1/6]

template<class... Tags>

KOKKOS_DEFAULTED_FUNCTION constexpr ddc::DiscreteElement< Tags >::DiscreteElement ( )

constexprdefault

DiscreteElement() [2/6]

template<class... Tags>

KOKKOS_DEFAULTED_FUNCTION constexpr ddc::DiscreteElement< Tags >::DiscreteElement ( DiscreteElement< Tags > const &  )

constexprdefault

DiscreteElement() [3/6]

template<class... Tags>

KOKKOS_DEFAULTED_FUNCTION constexpr ddc::DiscreteElement< Tags >::DiscreteElement ( DiscreteElement< Tags > &&  )

constexprdefault

DiscreteElement() [4/6]

template<class... Tags>

template<concepts::discrete_element... DElems>

KOKKOS_FUNCTION constexpr ddc::DiscreteElement< Tags >::DiscreteElement ( DElems const &...  delems )

inlineexplicitconstexprnoexcept

Definition at line 196 of file discrete_element.hpp.

DiscreteElement() [5/6]

template<class... Tags>

template<std::convertible_to< DiscreteElementType > IntegerType>

KOKKOS_FUNCTION constexpr ddc::DiscreteElement< Tags >::DiscreteElement ( std::array< IntegerType, sizeof...(Tags)> const &  values )

inlineexplicitconstexprnoexcept

Definition at line 202 of file discrete_element.hpp.

DiscreteElement() [6/6]

template<class... Tags>

template<std::convertible_to< DiscreteElementType >... Params>
requires ((!is_discrete_element_v<Params> && ...) && sizeof...(Params) == sizeof...(Tags))

KOKKOS_FUNCTION constexpr ddc::DiscreteElement< Tags >::DiscreteElement ( Params const &...  params )

inlineexplicitconstexprnoexcept

Definition at line 211 of file discrete_element.hpp.

~DiscreteElement()

template<class... Tags>

KOKKOS_DEFAULTED_FUNCTION ddc::DiscreteElement< Tags >::~DiscreteElement ( )

default

Member Function Documentation

size()

template<class... Tags>

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

inlinestaticconstexprnoexcept

Definition at line 183 of file discrete_element.hpp.

operator=() [1/2]

template<class... Tags>

KOKKOS_DEFAULTED_FUNCTION DiscreteElement & ddc::DiscreteElement< Tags >::operator= ( DiscreteElement< Tags > const &  other )

default

operator=() [2/2]

template<class... Tags>

KOKKOS_DEFAULTED_FUNCTION DiscreteElement & ddc::DiscreteElement< Tags >::operator= ( DiscreteElement< Tags > &&  other )

default

uid() [1/4]

template<class... Tags>

template<class QueryTag >

KOKKOS_FUNCTION constexpr value_type & ddc::DiscreteElement< Tags >::uid ( )

inlineconstexprnoexcept

Definition at line 224 of file discrete_element.hpp.

uid() [2/4]

template<class... Tags>

template<class QueryTag >

KOKKOS_FUNCTION constexpr value_type const & ddc::DiscreteElement< Tags >::uid ( ) const

inlineconstexprnoexcept

Definition at line 231 of file discrete_element.hpp.

uid() [3/4]

template<class... Tags>

KOKKOS_FUNCTION constexpr value_type & ddc::DiscreteElement< Tags >::uid ( )

inlineconstexprnoexcept

Definition at line 237 of file discrete_element.hpp.

uid() [4/4]

template<class... Tags>

KOKKOS_FUNCTION constexpr value_type const & ddc::DiscreteElement< Tags >::uid ( ) const

inlineconstexprnoexcept

Definition at line 243 of file discrete_element.hpp.

operator++() [1/2]

template<class... Tags>

KOKKOS_FUNCTION constexpr DiscreteElement & ddc::DiscreteElement< Tags >::operator++ ( )

inlineconstexpr

Definition at line 249 of file discrete_element.hpp.

operator++() [2/2]

template<class... Tags>

KOKKOS_FUNCTION constexpr DiscreteElement ddc::DiscreteElement< Tags >::operator++ ( int  )

inlineconstexpr

Definition at line 256 of file discrete_element.hpp.

operator--() [1/2]

template<class... Tags>

KOKKOS_FUNCTION constexpr DiscreteElement & ddc::DiscreteElement< Tags >::operator-- ( )

inlineconstexpr

Definition at line 264 of file discrete_element.hpp.

operator--() [2/2]

template<class... Tags>

KOKKOS_FUNCTION constexpr DiscreteElement ddc::DiscreteElement< Tags >::operator-- ( int  )

inlineconstexpr

Definition at line 271 of file discrete_element.hpp.

operator+=() [1/2]

template<class... Tags>

template<class... OTags>

KOKKOS_FUNCTION constexpr DiscreteElement & ddc::DiscreteElement< Tags >::operator+= ( DiscreteVector< OTags... > const &  rhs )

inlineconstexpr

Definition at line 280 of file discrete_element.hpp.

operator+=() [2/2]

template<class... Tags>

template<std::integral IntegralType>
requires (sizeof...(Tags) == 1)

KOKKOS_FUNCTION constexpr DiscreteElement & ddc::DiscreteElement< Tags >::operator+= ( IntegralType const &  rhs )

inlineconstexpr

Definition at line 288 of file discrete_element.hpp.

operator-=() [1/2]

template<class... Tags>

template<class... OTags>

KOKKOS_FUNCTION constexpr DiscreteElement & ddc::DiscreteElement< Tags >::operator-= ( DiscreteVector< OTags... > const &  rhs )

inlineconstexpr

Definition at line 296 of file discrete_element.hpp.

operator-=() [2/2]

template<class... Tags>

template<std::integral IntegralType>
requires (sizeof...(Tags) == 1)

KOKKOS_FUNCTION constexpr DiscreteElement & ddc::DiscreteElement< Tags >::operator-= ( IntegralType const &  rhs )

inlineconstexpr

Definition at line 304 of file discrete_element.hpp.

---

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

• discrete_element.hpp