Public Types | Public Member Functions | Static Public Attributes | List of all members
intrp::LinearSpanInterpolator Class Reference

Performs a linear interpolation; this class can be chosen via the options factory mechanism as a possible SpanInterpolator More...

#include <LinearSpanInterpolator.hpp>

Public Types

using options = tmpl::list<>
 
- Public Types inherited from intrp::SpanInterpolator
using creatable_classes = tmpl::list< LinearSpanInterpolator, CubicSpanInterpolator, BarycentricRationalSpanInterpolator >
 

Public Member Functions

 LinearSpanInterpolator (const LinearSpanInterpolator &) noexcept=default
 
LinearSpanInterpolatoroperator= (const LinearSpanInterpolator &) noexcept=default
 
 LinearSpanInterpolator (LinearSpanInterpolator &&) noexcept=default
 
LinearSpanInterpolatoroperator= (LinearSpanInterpolator &&) noexcept=default
 
 WRAPPED_PUPable_decl_template (LinearSpanInterpolator)
 
 LinearSpanInterpolator (CkMigrateMessage *) noexcept
 
void pup (PUP::er &) noexcept override
 
std::unique_ptr< SpanInterpolatorget_clone () const noexcept override
 Produce a std::unique_ptr that points to a copy of *this`.
 
double interpolate (const gsl::span< const double > &source_points, const gsl::span< const double > &values, double target_point) const noexcept override
 Perform the interpolation of function represented by values at source_points to the requested target_point, returning the interpolation result.
 
std::complex< double > interpolate (const gsl::span< const double > &source_points, const gsl::span< const std::complex< double >> &values, double target_point) const noexcept
 
size_t required_number_of_points_before_and_after () const noexcept override
 The number of domain points that should be both before and after the requested target point for best interpolation. For instance, for a linear interpolator, this function would return 1 to request that the target is between the two domain points passed to source_points.
 
- Public Member Functions inherited from intrp::SpanInterpolator
 WRAPPED_PUPable_abstract (SpanInterpolator)
 
std::complex< double > interpolate (const gsl::span< const double > &source_points, const gsl::span< const std::complex< double >> &values, double target_point) const noexcept
 Perform the interpolation of function represented by complex values at source_points to the requested target_point, returning the (complex) interpolation result.
 

Static Public Attributes

static constexpr Options::String help = {"Linear interpolator."}
 

Detailed Description

Performs a linear interpolation; this class can be chosen via the options factory mechanism as a possible SpanInterpolator


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