theplu::yat::regression::LinearInterpolation Class Reference

Linear interpolation. More...

#include <yat/regression/LinearInterpolation.h>

Inheritance diagram for theplu::yat::regression::LinearInterpolation:

theplu::yat::regression::GSLInterpolation

List of all members.

Public Member Functions

 LinearInterpolation (const utility::VectorBase &x, const utility::VectorBase &y)
 The default constructor.
 ~LinearInterpolation (void)
 The destructor.
double evaluate (double x)
 Calculate the interpolated value for x.
double evaluate_derivative (double x)
 Calculate the derivative of the interpolated function at x.
double evaluate_derivative2 (double x)
 Calculate the 2nd derivative of the interpolated function at x.
double evaluate_integral (double a, double b)
 Calculate the numerical integral of the interpolated function over the range $ [a,b] $.
double evaluation (void) const
 The result of the latest evaluaion function call is stored and can be retrieved with this function.
unsigned int min_size (void) const
 This function returns the minimum number of points required by the interpolation type.


Detailed Description

Linear interpolation.

See also:
Please refer to the base class documentation for genereal introduction to the GSL based interpolation methods.
Since:
New in yat 0.5

Member Function Documentation

double theplu::yat::regression::GSLInterpolation::evaluate ( double  x  )  [inherited]

Calculate the interpolated value for x.

Returns:
The interpolated value of $ y $ for a given point x.
Exceptions:
GSL_error if evaluation is requested outside the range defined by the interpolation algorithm.

double theplu::yat::regression::GSLInterpolation::evaluate_derivative ( double  x  )  [inherited]

Calculate the derivative of the interpolated function at x.

Returns:
The derivative.
Exceptions:
GSL_error if evaluation is requested outside the range defined by the interpolation algorithm.

double theplu::yat::regression::GSLInterpolation::evaluate_derivative2 ( double  x  )  [inherited]

Calculate the 2nd derivative of the interpolated function at x.

Returns:
The 2nd derivative.
Exceptions:
GSL_error if evaluation is requested outside the range defined by the interpolation algorithm.

double theplu::yat::regression::GSLInterpolation::evaluate_integral ( double  a,
double  b 
) [inherited]

Calculate the numerical integral of the interpolated function over the range $ [a,b] $.

Returns:
The integral.
Exceptions:
GSL_error if evaluation is requested outside the range defined by the interpolation algorithm.

double theplu::yat::regression::GSLInterpolation::evaluation ( void   )  const [inherited]

The result of the latest evaluaion function call is stored and can be retrieved with this function.

Returns:
The latest evaluated value.

unsigned int theplu::yat::regression::GSLInterpolation::min_size ( void   )  const [inherited]

This function returns the minimum number of points required by the interpolation type.

For example, Akima spline interpolation requires a minimum of 5 points.

Returns:
The minimum number of points required.


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

Generated on Tue Jan 18 02:21:18 2011 for yat by  doxygen 1.5.5