Public Types | Public Member Functions

OpenTissue::interpolation::BaseInterpolator< child_type_, real_type_ > Class Template Reference

#include <interpolation_base_interpolator.h>

List of all members.

Public Types

typedef child_type_ child_type
typedef real_type_ real_type

Public Member Functions

void set_tableau (real_type *x, real_type *y, int cnt)
real_type get_value (real_type const &x)
real_type get_error_estimate ()

Detailed Description

template<typename child_type_, typename real_type_>
class OpenTissue::interpolation::BaseInterpolator< child_type_, real_type_ >

Interpolator Base Class. All interpolation and extrapolation algorithms must be derived from this base class.

This inteface defines the basic methods which all (1-dimensional) interpolation and extrapolation algorithms must support.


Member Typedef Documentation

template<typename child_type_, typename real_type_>
typedef child_type_ OpenTissue::interpolation::BaseInterpolator< child_type_, real_type_ >::child_type
template<typename child_type_, typename real_type_>
typedef real_type_ OpenTissue::interpolation::BaseInterpolator< child_type_, real_type_ >::real_type

Member Function Documentation

template<typename child_type_, typename real_type_>
real_type OpenTissue::interpolation::BaseInterpolator< child_type_, real_type_ >::get_error_estimate (  )  [inline]

Error Estimate Method. This method should return the error estimate of the last interpolated value computation, which have taken place.

Returns:
The value of the error estimate.
template<typename child_type_, typename real_type_>
real_type OpenTissue::interpolation::BaseInterpolator< child_type_, real_type_ >::get_value ( real_type const &  x  )  [inline]

Get Interpolation Value. This method should compute the interpolated or extrapolated value at the specified point.

Parameters:
x The point at which the interpolated or extrapolated value should be found at.
Returns:
The interpolated (or extrapolated) value at the point x.
template<typename child_type_, typename real_type_>
void OpenTissue::interpolation::BaseInterpolator< child_type_, real_type_ >::set_tableau ( real_type x,
real_type y,
int  cnt 
) [inline]

Set Tableau Method. This method should be used to initialize the tableau that should be used to compute the interpolated (or extrapolated) value.

We have

y0 = f(x0),y1 = f(x1),...yn = f(xn),

Parameters:
x The array of parameter values.
y The array of corresponding function values. Must have same length as the x-array.
cnt The number of value pairs.

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