Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Public Attributes | List of all members
Mezzanine::CubicSplineElement< X, Y > Class Template Reference

Meta data nodes required to generate a cubic spline. More...

#include <cubicspline.h>

Public Member Functions

 CubicSplineElement (X _x)
 Simple constructor. More...
 
 CubicSplineElement (X _x, Y _a, Y _b, Y _c, Y _d)
 Complete meta-data constructor _x Time series location _a Meta-data corresponding to "a" on wikipedia description of a cubic splines _b Meta-data corresponding to "b" on wikipedia description of a cubic splines _c Meta-data corresponding to "c" on wikipedia description of a cubic splines _d Meta-data corresponding to "d" on wikipedia description of a cubic splines.
 
eval (const X &xx) const
 The actual interpolation of the meta-data into a result. More...
 
Boole operator< (const CubicSplineElement &e) const
 Sort Meta-data elements by time series locations in other Meta-Data. More...
 
Boole operator< (const X &xx) const
 Sort Meta-data elements by time series locations. More...
 

Public Attributes

a
 Meta-data corresponding to "a" on wikipedia description of a cubic splines.
 
b
 Meta-data corresponding to "b" on wikipedia description of a cubic splines.
 
c
 Meta-data corresponding to "c" on wikipedia description of a cubic splines.
 
d
 Meta-data corresponding to "d" on wikipedia description of a cubic splines.
 
x
 Time series meta-data.
 

Detailed Description

template<typename X, typename Y>
class Mezzanine::CubicSplineElement< X, Y >

Meta data nodes required to generate a cubic spline.

Definition at line 56 of file cubicspline.h.

Constructor & Destructor Documentation

template<typename X , typename Y >
Mezzanine::CubicSplineElement< X, Y >::CubicSplineElement ( _x)
inline

Simple constructor.

Parameters
_x

Definition at line 74 of file cubicspline.h.

Member Function Documentation

template<typename X , typename Y >
Y Mezzanine::CubicSplineElement< X, Y >::eval ( const X &  xx) const
inline

The actual interpolation of the meta-data into a result.

Parameters
xxLocation in the time series toget the corresponding Data series location on a cubic curve.

Definition at line 88 of file cubicspline.h.

template<typename X , typename Y >
Boole Mezzanine::CubicSplineElement< X, Y >::operator< ( const CubicSplineElement< X, Y > &  e) const
inline

Sort Meta-data elements by time series locations in other Meta-Data.

Parameters
eThe CubicSplineElement to compare this one too.

Definition at line 96 of file cubicspline.h.

template<typename X , typename Y >
Boole Mezzanine::CubicSplineElement< X, Y >::operator< ( const X &  xx) const
inline

Sort Meta-data elements by time series locations.

Parameters
xxThe CubicSplineElement to compare this one too.

Definition at line 101 of file cubicspline.h.


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