AbstractSpline Class Reference

Base class for the linear and cubic interpolation spline classes. More...

#include <AbstractSpline.h>

Inheritance diagram for AbstractSpline:

Collaboration diagram for AbstractSpline:

Classes
class	Accelerator
	Accelerator caching last interval indices. More...

Public Member Functions
	AbstractSpline ()=default
	Default constructor.
virtual	~AbstractSpline ()=default
	Polymorphic destructor.
virtual void	init (const std::vector< double > &x, const std::vector< double > &y)
	Initialize from tabulated data (natural spline).
virtual double	eval (double x, Accelerator &accel) const =0
	Evaluate the spline at x using an accelerator.
virtual double	evalIntegral (double xa, double xb, Accelerator &accel) const =0
	Evaluate the integral of the spline at x.

Protected Member Functions
size_t	findInterval (double x, size_t &intervalCache) const
	Return the interval index for the given x-coordinate, using the supplied cached value if possible.

Protected Attributes
std::vector< double >	x_ {}
std::vector< double >	y_ {}

Detailed Description

Base class for the linear and cubic interpolation spline classes.

Definition at line 25 of file AbstractSpline.h.

Constructor & Destructor Documentation

AbstractSpline()

AbstractSpline::AbstractSpline ( )

default

Default constructor.

~AbstractSpline()

virtual AbstractSpline::~AbstractSpline ( )

virtualdefault

Polymorphic destructor.

Member Function Documentation

eval()

virtual double AbstractSpline::eval ( double  x, Accelerator &  accel  ) const

pure virtual

Evaluate the spline at x using an accelerator.

Parameters

x	Input: x-coordinate.
accel	Input/Output: cached interval index.

Returns

Output: interpolated value.

Implemented in CubicSpline, and LinearSpline.

Referenced by gsl_spline_eval().

evalIntegral()

virtual double AbstractSpline::evalIntegral ( double  xa, double  xb, Accelerator &  accel  ) const

pure virtual

Evaluate the integral of the spline at x.

Parameters

xa	Input: x-coordinate lower bound.
xb	Input: x-coordinate upper bound.
accel	Input/output: accelerator for interval caching.

Returns

Output: interpolated integral value (with linear extrapolation).

Implemented in CubicSpline, and LinearSpline.

Referenced by gsl_spline_eval_integ().

findInterval()

size_t AbstractSpline::findInterval ( double  x, size_t &  intervalCache  ) const

protected

Return the interval index for the given x-coordinate, using the supplied cached value if possible.

Parameters

x	Input: x-coordinate.
intervalCache	Input/output: The cached interval index.

Returns

Output: The index of the interval containing x.

Definition at line 39 of file AbstractSpline.cpp.

References x_.

Referenced by CubicSpline::eval(), LinearSpline::eval(), CubicSpline::evalIntegral(), and LinearSpline::evalIntegral().

init()

void AbstractSpline::init ( const std::vector< double > &  x, const std::vector< double > &  y  )

virtual

Initialize from tabulated data (natural spline).

Parameters

x	Input: strictly increasing x-coordinates.
y	Input: y-values corresponding to x.

Reimplemented in CubicSpline, and LinearSpline.

Definition at line 22 of file AbstractSpline.cpp.

References x_, and y_.

Referenced by gsl_spline_init(), CubicSpline::init(), and LinearSpline::init().

Member Data Documentation

x_

std::vector<double> AbstractSpline::x_ {}

protected

Definition at line 73 of file AbstractSpline.h.

Referenced by CubicSpline::computeCoefficients(), LinearSpline::computeCoefficients(), CubicSpline::computeIntegrals(), LinearSpline::computeIntegrals(), CubicSpline::eval(), LinearSpline::eval(), CubicSpline::evalIntegral(), LinearSpline::evalIntegral(), CubicSpline::extrapolateLeft(), CubicSpline::extrapolateRight(), findInterval(), init(), and LinearSpline::integral().

y_

std::vector<double> AbstractSpline::y_ {}

protected

Definition at line 74 of file AbstractSpline.h.

Referenced by CubicSpline::computeCoefficients(), LinearSpline::computeCoefficients(), CubicSpline::eval(), CubicSpline::evalIntegral(), LinearSpline::evalIntegral(), CubicSpline::extrapolateLeft(), CubicSpline::extrapolateRight(), init(), and CubicSpline::integral().

---

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

• AbstractSpline.h
• AbstractSpline.cpp