DDC 0.12.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
ddc::DiscreteVector< Tags > Class Template Reference

A DiscreteVector is a vector in the discrete dimension. More...

#include <discrete_vector.hpp>

Inheritance diagram for ddc::DiscreteVector< Tags >:
Inheritance graph
Collaboration diagram for ddc::DiscreteVector< Tags >:
Collaboration graph

Public Types

using value_type = DiscreteVectorElement
 

Public Member Functions

KOKKOS_DEFAULTED_FUNCTION constexpr DiscreteVector ()=default
 
KOKKOS_DEFAULTED_FUNCTION constexpr DiscreteVector (DiscreteVector const &)=default
 
KOKKOS_DEFAULTED_FUNCTION constexpr DiscreteVector (DiscreteVector &&)=default
 
template<concepts::discrete_vector... DVects>
KOKKOS_FUNCTION constexpr DiscreteVector (DVects const &... delems) noexcept
 
template<std::convertible_to< DiscreteVectorElement > IntegerType>
KOKKOS_FUNCTION constexpr DiscreteVector (std::array< IntegerType, sizeof...(Tags)> const &values) noexcept
 
template<std::convertible_to< DiscreteVectorElement >... Params>
requires ((!is_discrete_vector_v<Params> && ...) && sizeof...(Params) == sizeof...(Tags))
KOKKOS_FUNCTION constexpr DiscreteVector (Params const &... params) noexcept
 
KOKKOS_DEFAULTED_FUNCTION ~DiscreteVector ()=default
 
KOKKOS_DEFAULTED_FUNCTION constexpr DiscreteVector & operator= (DiscreteVector const &other)=default
 
KOKKOS_DEFAULTED_FUNCTION constexpr DiscreteVector & operator= (DiscreteVector &&other)=default
 
template<class... OTags>
KOKKOS_FUNCTION constexpr bool operator== (DiscreteVector< OTags... > const &rhs) const noexcept
 
template<class... OTags>
KOKKOS_FUNCTION constexpr bool operator!= (DiscreteVector< OTags... > const &rhs) const noexcept
 
template<class QueryTag >
KOKKOS_FUNCTION constexpr DiscreteVectorElement & get () noexcept
 
template<class QueryTag >
KOKKOS_FUNCTION constexpr DiscreteVectorElement const & get () const noexcept
 
template<class QueryTag >
KOKKOS_FUNCTION constexpr DiscreteVectorElement const & get_or (DiscreteVectorElement const &default_value) const &
 
KOKKOS_FUNCTION constexpr DiscreteVectorElement const & value () const noexcept
 
KOKKOS_FUNCTION constexpr DiscreteVector & operator++ ()
 
KOKKOS_FUNCTION constexpr DiscreteVector operator++ (int)
 
KOKKOS_FUNCTION constexpr DiscreteVector & operator-- ()
 
KOKKOS_FUNCTION constexpr DiscreteVector operator-- (int)
 
template<class... OTags>
KOKKOS_FUNCTION constexpr DiscreteVector & operator+= (DiscreteVector< OTags... > const &rhs)
 
template<std::integral IntegralType>
requires (sizeof...(Tags) == 1)
KOKKOS_FUNCTION constexpr DiscreteVector & operator+= (IntegralType const &rhs)
 
template<class... OTags>
KOKKOS_FUNCTION constexpr DiscreteVector & operator-= (DiscreteVector< OTags... > const &rhs)
 
template<std::integral IntegralType>
requires (sizeof...(Tags) == 1)
KOKKOS_FUNCTION constexpr DiscreteVector & operator-= (IntegralType const &rhs)
 
template<class... OTags>
KOKKOS_FUNCTION constexpr DiscreteVector & operator*= (DiscreteVector< OTags... > const &rhs)
 

Static Public Member Functions

static KOKKOS_FUNCTION constexpr std::size_t size () noexcept
 

Detailed Description

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

A DiscreteVector is a vector in the discrete dimension.

Each is tagged by its associated dimensions.

Definition at line 269 of file discrete_vector.hpp.

Member Typedef Documentation

◆ value_type

template<class... Tags>
using ddc::DiscreteVector< Tags >::value_type = DiscreteVectorElement

Definition at line 288 of file discrete_vector.hpp.

Constructor & Destructor Documentation

◆ DiscreteVector() [1/6]

template<class... Tags>
KOKKOS_DEFAULTED_FUNCTION constexpr ddc::DiscreteVector< Tags >::DiscreteVector ( )
constexprdefault

◆ DiscreteVector() [2/6]

template<class... Tags>
KOKKOS_DEFAULTED_FUNCTION constexpr ddc::DiscreteVector< Tags >::DiscreteVector ( DiscreteVector< Tags > const &  )
constexprdefault

◆ DiscreteVector() [3/6]

template<class... Tags>
KOKKOS_DEFAULTED_FUNCTION constexpr ddc::DiscreteVector< Tags >::DiscreteVector ( DiscreteVector< Tags > &&  )
constexprdefault

◆ DiscreteVector() [4/6]

template<class... Tags>
template<concepts::discrete_vector... DVects>
KOKKOS_FUNCTION constexpr ddc::DiscreteVector< Tags >::DiscreteVector ( DVects const &...  delems)
inlineexplicitconstexprnoexcept

Definition at line 303 of file discrete_vector.hpp.

◆ DiscreteVector() [5/6]

template<class... Tags>
template<std::convertible_to< DiscreteVectorElement > IntegerType>
KOKKOS_FUNCTION constexpr ddc::DiscreteVector< Tags >::DiscreteVector ( std::array< IntegerType, sizeof...(Tags)> const &  values)
inlineexplicitconstexprnoexcept

Definition at line 309 of file discrete_vector.hpp.

◆ DiscreteVector() [6/6]

template<class... Tags>
template<std::convertible_to< DiscreteVectorElement >... Params>
requires ((!is_discrete_vector_v<Params> && ...) && sizeof...(Params) == sizeof...(Tags))
KOKKOS_FUNCTION constexpr ddc::DiscreteVector< Tags >::DiscreteVector ( Params const &...  params)
inlineexplicitconstexprnoexcept

Definition at line 319 of file discrete_vector.hpp.

◆ ~DiscreteVector()

template<class... Tags>
KOKKOS_DEFAULTED_FUNCTION ddc::DiscreteVector< Tags >::~DiscreteVector ( )
default

Member Function Documentation

◆ size()

template<class... Tags>
static KOKKOS_FUNCTION constexpr std::size_t ddc::DiscreteVector< Tags >::size ( )
inlinestaticconstexprnoexcept

Definition at line 290 of file discrete_vector.hpp.

◆ operator=() [1/2]

template<class... Tags>
KOKKOS_DEFAULTED_FUNCTION constexpr DiscreteVector & ddc::DiscreteVector< Tags >::operator= ( DiscreteVector< Tags > const &  other)
constexprdefault

◆ operator=() [2/2]

template<class... Tags>
KOKKOS_DEFAULTED_FUNCTION constexpr DiscreteVector & ddc::DiscreteVector< Tags >::operator= ( DiscreteVector< Tags > &&  other)
constexprdefault

◆ operator==()

template<class... Tags>
template<class... OTags>
KOKKOS_FUNCTION constexpr bool ddc::DiscreteVector< Tags >::operator== ( DiscreteVector< OTags... > const &  rhs) const
inlineconstexprnoexcept

Definition at line 333 of file discrete_vector.hpp.

◆ operator!=()

template<class... Tags>
template<class... OTags>
KOKKOS_FUNCTION constexpr bool ddc::DiscreteVector< Tags >::operator!= ( DiscreteVector< OTags... > const &  rhs) const
inlineconstexprnoexcept

Definition at line 341 of file discrete_vector.hpp.

◆ get() [1/2]

template<class... Tags>
template<class QueryTag >
KOKKOS_FUNCTION constexpr DiscreteVectorElement & ddc::DiscreteVector< Tags >::get ( )
inlineconstexprnoexcept

Definition at line 348 of file discrete_vector.hpp.

◆ get() [2/2]

template<class... Tags>
template<class QueryTag >
KOKKOS_FUNCTION constexpr DiscreteVectorElement const & ddc::DiscreteVector< Tags >::get ( ) const
inlineconstexprnoexcept

Definition at line 355 of file discrete_vector.hpp.

◆ get_or()

template<class... Tags>
template<class QueryTag >
KOKKOS_FUNCTION constexpr DiscreteVectorElement const & ddc::DiscreteVector< Tags >::get_or ( DiscreteVectorElement const &  default_value) const &
inlineconstexpr

Definition at line 362 of file discrete_vector.hpp.

◆ value()

template<class... Tags>
KOKKOS_FUNCTION constexpr DiscreteVectorElement const & ddc::DiscreteVector< Tags >::value ( ) const
inlineconstexprnoexcept

Definition at line 374 of file discrete_vector.hpp.

◆ operator++() [1/2]

template<class... Tags>
KOKKOS_FUNCTION constexpr DiscreteVector & ddc::DiscreteVector< Tags >::operator++ ( )
inlineconstexpr

Definition at line 380 of file discrete_vector.hpp.

◆ operator++() [2/2]

template<class... Tags>
KOKKOS_FUNCTION constexpr DiscreteVector ddc::DiscreteVector< Tags >::operator++ ( int  )
inlineconstexpr

Definition at line 387 of file discrete_vector.hpp.

◆ operator--() [1/2]

template<class... Tags>
KOKKOS_FUNCTION constexpr DiscreteVector & ddc::DiscreteVector< Tags >::operator-- ( )
inlineconstexpr

Definition at line 395 of file discrete_vector.hpp.

◆ operator--() [2/2]

template<class... Tags>
KOKKOS_FUNCTION constexpr DiscreteVector ddc::DiscreteVector< Tags >::operator-- ( int  )
inlineconstexpr

Definition at line 402 of file discrete_vector.hpp.

◆ operator+=() [1/2]

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

Definition at line 411 of file discrete_vector.hpp.

◆ operator+=() [2/2]

template<class... Tags>
template<std::integral IntegralType>
requires (sizeof...(Tags) == 1)
KOKKOS_FUNCTION constexpr DiscreteVector & ddc::DiscreteVector< Tags >::operator+= ( IntegralType const &  rhs)
inlineconstexpr

Definition at line 419 of file discrete_vector.hpp.

◆ operator-=() [1/2]

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

Definition at line 427 of file discrete_vector.hpp.

◆ operator-=() [2/2]

template<class... Tags>
template<std::integral IntegralType>
requires (sizeof...(Tags) == 1)
KOKKOS_FUNCTION constexpr DiscreteVector & ddc::DiscreteVector< Tags >::operator-= ( IntegralType const &  rhs)
inlineconstexpr

Definition at line 435 of file discrete_vector.hpp.

◆ operator*=()

template<class... Tags>
template<class... OTags>
KOKKOS_FUNCTION constexpr DiscreteVector & ddc::DiscreteVector< Tags >::operator*= ( DiscreteVector< OTags... > const &  rhs)
inlineconstexpr

Definition at line 443 of file discrete_vector.hpp.

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