Jet  v1.3.3
Public Member Functions | List of all members
jet::LinearArraySampler< T, R, 1 > Class Template Referencefinal

1-D linear array sampler class. More...

#include <jet/array_samplers1.h>

Public Member Functions

 LinearArraySampler (const ConstArrayAccessor1< T > &accessor, R gridSpacing, R gridOrigin)
 Constructs a sampler using array accessor, spacing between the elements, and the position of the first array element. More...
 
 LinearArraySampler (const LinearArraySampler &other)
 Copy constructor. More...
 
operator() (R pt) const
 Returns sampled value at point pt. More...
 
void getCoordinatesAndWeights (R x, size_t *i0, size_t *i1, T *weight0, T *weight1) const
 Returns the indices of points and their sampling weight for given point. More...
 
std::function< T(R)> functor () const
 Returns a funtion object that wraps this instance. More...
 

Detailed Description

template<typename T, typename R>
class jet::LinearArraySampler< T, R, 1 >

1-D linear array sampler class.

This class provides linear sampling interface for a given 1-D array.

Template Parameters
T- The value type to sample.
R- The real number type.

Constructor & Destructor Documentation

◆ LinearArraySampler() [1/2]

template<typename T , typename R >
jet::LinearArraySampler< T, R, 1 >::LinearArraySampler ( const ConstArrayAccessor1< T > &  accessor,
gridSpacing,
gridOrigin 
)
explicit

Constructs a sampler using array accessor, spacing between the elements, and the position of the first array element.

Parameters
[in]accessorThe array accessor.
[in]gridSpacingThe grid spacing.
[in]gridOriginThe grid origin.

◆ LinearArraySampler() [2/2]

template<typename T , typename R >
jet::LinearArraySampler< T, R, 1 >::LinearArraySampler ( const LinearArraySampler< T, R, 1 > &  other)

Copy constructor.

Member Function Documentation

◆ functor()

template<typename T , typename R >
std::function<T(R)> jet::LinearArraySampler< T, R, 1 >::functor ( ) const

Returns a funtion object that wraps this instance.

◆ getCoordinatesAndWeights()

template<typename T , typename R >
void jet::LinearArraySampler< T, R, 1 >::getCoordinatesAndWeights ( x,
size_t *  i0,
size_t *  i1,
T *  weight0,
T *  weight1 
) const

Returns the indices of points and their sampling weight for given point.

◆ operator()()

template<typename T , typename R >
T jet::LinearArraySampler< T, R, 1 >::operator() ( pt) const

Returns sampled value at point pt.


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