Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
numeric::interpolation::spline::SimpleInterpolator Class Reference

#include <SimpleInterpolator.hh>

Inheritance diagram for numeric::interpolation::spline::SimpleInterpolator:
Inheritance graph
[legend]

Public Member Functions

 SimpleInterpolator (utility::vector1< Real > const &x, utility::vector1< Real > const &y, Real lbdy, Real ubdy)
 
 SimpleInterpolator ()
 
InterpolatorOP clone () const override
 
void interpolate (Real x, Real &y, Real &dy) const override
 
utility::json_spirit::Value serialize () const override
 serialize the Interpolator to a json_spirit object More...
 
void deserialize (utility::json_spirit::mObject data) override
 deserialize a json_spirit object to a Interpolator More...
 
bool operator== (Interpolator const &other) const override
 
bool same_type_as_me (Interpolator const &other) const override
 
utility::vector1< Real > const & x () const
 accessor for the x-values defining the interpolation knots More...
 
utility::vector1< Real > const & y () const
 accessor for the y-values specified for each knot More...
 
utility::vector1< Real > const & ddy () const
 accessors for the second derivative values specified for each knot More...
 
- Public Member Functions inherited from numeric::interpolation::spline::Interpolator
 ~Interpolator () override
 Automatically generated virtual destructor for class deriving directly from VirtualBase. More...
 
 Interpolator ()
 
void set_lb_function (numeric::Real const &lb, numeric::Real const &slope, numeric::Real const &intercept)
 set a linear function describing the behavior of the interpolator after a given lower bound. This lower bound can be distinct from the lb of the spline More...
 
void set_ub_function (numeric::Real const &ub, numeric::Real const &slope, numeric::Real const &intercept)
 set a linear function describing the behavior of the interpolator after a given upper bound. This upper bound can be distinct from the ub of the spline More...
 
bool has_lb_function () const
 return true if the interpolator has a defined lower bound function More...
 
bool has_ub_function () const
 return false if the interpolator has a defined upper bound function More...
 
numeric::Real get_lb_function_cutoff () const
 get the lower bound cutoff More...
 
numeric::Real get_ub_function_cutoff () const
 get the upper bound cutoff More...
 
void compute_lb_function_solution (numeric::Real x, numeric::Real &y) const
 compute the y value of the lower bound function given an x value More...
 
void compute_ub_function_solution (numeric::Real x, numeric::Real &y) const
 compute the y value of the lower bound function given an x value More...
 
- Public Member Functions inherited from utility::VirtualBase
 VirtualBase ()=default
 Default constructor. More...
 
virtual ~VirtualBase ()=default
 The virtual destructor is one of the main reasons for the VirtualBase class. More...
 
 VirtualBase (VirtualBase const &)=default
 
 VirtualBase (VirtualBase &&)=default
 
VirtualBaseoperator= (VirtualBase const &)=default
 
VirtualBaseoperator= (VirtualBase &&)=default
 

Private Attributes

utility::vector1< Realx_
 
utility::vector1< Realy_
 
utility::vector1< Realddy_
 

Constructor & Destructor Documentation

numeric::interpolation::spline::SimpleInterpolator::SimpleInterpolator ( utility::vector1< Real > const &  x,
utility::vector1< Real > const &  y,
Real  lbdy,
Real  ubdy 
)
numeric::interpolation::spline::SimpleInterpolator::SimpleInterpolator ( )

Member Function Documentation

InterpolatorOP numeric::interpolation::spline::SimpleInterpolator::clone ( ) const
overridevirtual
utility::vector1< Real > const& numeric::interpolation::spline::SimpleInterpolator::ddy ( ) const
inline

accessors for the second derivative values specified for each knot

References ddy_.

void numeric::interpolation::spline::SimpleInterpolator::deserialize ( utility::json_spirit::mObject  data)
overridevirtual

deserialize a json_spirit object to a Interpolator

Reimplemented from numeric::interpolation::spline::Interpolator.

References ddy_, numeric::interpolation::spline::Interpolator::deserialize(), x_, and y_.

void numeric::interpolation::spline::SimpleInterpolator::interpolate ( Real  x,
Real y,
Real dy 
) const
overridevirtual
bool numeric::interpolation::spline::SimpleInterpolator::operator== ( Interpolator const &  other) const
overridevirtual

Reimplemented from numeric::interpolation::spline::Interpolator.

References ddy_, x_, and y_.

bool numeric::interpolation::spline::SimpleInterpolator::same_type_as_me ( Interpolator const &  other) const
overridevirtual
utility::json_spirit::Value numeric::interpolation::spline::SimpleInterpolator::serialize ( ) const
overridevirtual
utility::vector1< Real > const& numeric::interpolation::spline::SimpleInterpolator::x ( ) const
inline

accessor for the x-values defining the interpolation knots

References x_.

utility::vector1< Real > const& numeric::interpolation::spline::SimpleInterpolator::y ( ) const
inline

accessor for the y-values specified for each knot

References y_.

Member Data Documentation

utility::vector1<Real> numeric::interpolation::spline::SimpleInterpolator::ddy_
private
utility::vector1<Real> numeric::interpolation::spline::SimpleInterpolator::x_
private
utility::vector1<Real> numeric::interpolation::spline::SimpleInterpolator::y_
private

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