DDC 0.0.0

a discrete domain computation library

Public Types | Public Member Functions | Friends | List of all members
ddc::UniformPointSampling< CDim >::Impl< MemorySpace > Class Template Reference

Public Types

using discrete_dimension_type = UniformPointSampling
 

Public Member Functions

 Impl ()=default
 
 Impl (Impl const &)=delete
 
template<class OriginMemorySpace >
 Impl (Impl< OriginMemorySpace > const &impl)
 
 Impl (Impl &&)=default
 
constexpr Impl (continuous_element_type origin, double step)
 Construct a Impl from a point and a spacing step. More...
 
constexpr Impl (continuous_element_type a, continuous_element_type b, std::size_t n)
 Construct a Impl from a segment $[a, b] \subset [a, +\infty[$ and a number of points n. More...
 
constexpr Impl (continuous_element_type a, continuous_element_type b, discrete_vector_type n)
 Construct a Impl from a segment $[a, b] \subset [a, +\infty[$ and a number of points n. More...
 
 ~Impl ()=default
 
constexpr continuous_element_type origin () const noexcept
 Lower bound index of the mesh. More...
 
constexpr discrete_element_type front () const noexcept
 Lower bound index of the mesh. More...
 
constexpr double step () const
 Spacing step of the mesh. More...
 
constexpr continuous_element_type coordinate (discrete_element_type const &icoord) const noexcept
 Convert a mesh index into a position in CDim More...
 

Friends

template<class OMemorySpace >
class Impl
 

Member Typedef Documentation

◆ discrete_dimension_type

template<class CDim >
template<class MemorySpace >
using ddc::UniformPointSampling< CDim >::Impl< MemorySpace >::discrete_dimension_type = UniformPointSampling

Constructor & Destructor Documentation

◆ Impl() [1/7]

template<class CDim >
template<class MemorySpace >
ddc::UniformPointSampling< CDim >::Impl< MemorySpace >::Impl ( )
default

◆ Impl() [2/7]

template<class CDim >
template<class MemorySpace >
ddc::UniformPointSampling< CDim >::Impl< MemorySpace >::Impl ( Impl< MemorySpace > const &  )
delete

◆ Impl() [3/7]

template<class CDim >
template<class MemorySpace >
template<class OriginMemorySpace >
ddc::UniformPointSampling< CDim >::Impl< MemorySpace >::Impl ( Impl< OriginMemorySpace > const &  impl)
inlineexplicit

◆ Impl() [4/7]

template<class CDim >
template<class MemorySpace >
ddc::UniformPointSampling< CDim >::Impl< MemorySpace >::Impl ( Impl< MemorySpace > &&  )
default

◆ Impl() [5/7]

template<class CDim >
template<class MemorySpace >
constexpr ddc::UniformPointSampling< CDim >::Impl< MemorySpace >::Impl ( continuous_element_type  origin,
double  step 
)
inlineconstexpr

Construct a Impl from a point and a spacing step.

Parameters
originthe real coordinate of mesh coordinate 0
stepthe real distance between two points of mesh distance 1

◆ Impl() [6/7]

template<class CDim >
template<class MemorySpace >
constexpr ddc::UniformPointSampling< CDim >::Impl< MemorySpace >::Impl ( continuous_element_type  a,
continuous_element_type  b,
std::size_t  n 
)
inlineconstexpr

Construct a Impl from a segment $[a, b] \subset [a, +\infty[$ and a number of points n.

Parameters
athe coordinate of a first real point (will have mesh coordinate 0)
bthe coordinate of the second real point (will have mesh coordinate n-1)
nthe number of points to map the segment $[a, b]$ including a & b
Deprecated:
use the version accepting a vector for n instead

◆ Impl() [7/7]

template<class CDim >
template<class MemorySpace >
constexpr ddc::UniformPointSampling< CDim >::Impl< MemorySpace >::Impl ( continuous_element_type  a,
continuous_element_type  b,
discrete_vector_type  n 
)
inlineconstexpr

Construct a Impl from a segment $[a, b] \subset [a, +\infty[$ and a number of points n.

Parameters
athe coordinate of a first real point (will have mesh coordinate 0)
bthe coordinate of the second real point (will have mesh coordinate n-1)
nthe number of points to map the segment $[a, b]$ including a & b

◆ ~Impl()

template<class CDim >
template<class MemorySpace >
ddc::UniformPointSampling< CDim >::Impl< MemorySpace >::~Impl ( )
default

Member Function Documentation

◆ origin()

template<class CDim >
template<class MemorySpace >
constexpr continuous_element_type ddc::UniformPointSampling< CDim >::Impl< MemorySpace >::origin ( ) const
inlineconstexprnoexcept

Lower bound index of the mesh.

◆ front()

template<class CDim >
template<class MemorySpace >
constexpr discrete_element_type ddc::UniformPointSampling< CDim >::Impl< MemorySpace >::front ( ) const
inlineconstexprnoexcept

Lower bound index of the mesh.

◆ step()

template<class CDim >
template<class MemorySpace >
constexpr double ddc::UniformPointSampling< CDim >::Impl< MemorySpace >::step ( ) const
inlineconstexpr

Spacing step of the mesh.

◆ coordinate()

template<class CDim >
template<class MemorySpace >
constexpr continuous_element_type ddc::UniformPointSampling< CDim >::Impl< MemorySpace >::coordinate ( discrete_element_type const &  icoord) const
inlineconstexprnoexcept

Convert a mesh index into a position in CDim

Friends And Related Function Documentation

◆ Impl

template<class CDim >
template<class MemorySpace >
template<class OMemorySpace >
friend class Impl
friend
The documentation for this class was generated from the following file: