Template wrapper for a generic spline function. More...
#include <spline_function.hpp>
Public Member Functions | |
| double | dderivative (const double &x) const ecl_assert_throw_decl(StandardException) |
| Access the value of the spline function's 2nd derivative at the specified value. | |
| double | derivative (const double &x) const ecl_assert_throw_decl(StandardException) |
| Access the value of the spline function's derivative at the specified value. | |
| double | operator() (const double &x) const ecl_assert_throw_decl(StandardException) |
| Access the value of the spline function at the specified value. | |
| SplineFunction (const double &time_begin, const double &time_end, const Function &f) | |
| Constructor, copies across an already existing spline function type and wraps it. | |
| virtual | ~SplineFunction () |
Private Attributes | |
| Function | function |
Detailed Description
template<typename Function>
class ecl::SplineFunction< Function >
Template wrapper for a generic spline function.
Template wrapper for a generic spline function. Didn't want to inherit an interface for all the underlying functions (polynomials, tension functions, splines etc) so this is an indirect way of getting the polymorphism to work. It is not usually used directly, but rather internally in the trajectory classes.
- Template Parameters:
-
Function : the internally wrapped function.
Definition at line 88 of file spline_function.hpp.
Constructor & Destructor Documentation
| ecl::SplineFunction< Function >::SplineFunction | ( | const double & | time_begin, |
| const double & | time_end, | ||
| const Function & | f | ||
| ) | [inline] |
Constructor, copies across an already existing spline function type and wraps it.
Copies an existing spline function into this wrapper along with domain boundaries.
- Parameters:
-
time_begin : beginning of the domain the spline function is valid on. time_end : end of the domain the spline function is valid on. f : the spline function to wrap.
Definition at line 99 of file spline_function.hpp.
| virtual ecl::SplineFunction< Function >::~SplineFunction | ( | ) | [inline, virtual] |
Definition at line 102 of file spline_function.hpp.
Member Function Documentation
| double ecl::SplineFunction< Function >::dderivative | ( | const double & | x | ) | const [inline, virtual] |
Access the value of the spline function's 2nd derivative at the specified value.
- Parameters:
-
x : the point at which you wish to calculate the value for.
- Returns:
- double : the value of the 2nd derivative at x.
- Exceptions:
-
: StandardException : throws if input x value is outside the domain [debug mode only].
Implements ecl::GenericSplineFunction.
Definition at line 132 of file spline_function.hpp.
| double ecl::SplineFunction< Function >::derivative | ( | const double & | x | ) | const [inline, virtual] |
Access the value of the spline function's derivative at the specified value.
- Parameters:
-
x : the point at which you wish to calculate the value for.
- Returns:
- double : the value of the derivative at x.
- Exceptions:
-
: StandardException : throws if input x value is outside the domain [debug mode only].
Implements ecl::GenericSplineFunction.
Definition at line 121 of file spline_function.hpp.
| double ecl::SplineFunction< Function >::operator() | ( | const double & | x | ) | const [inline, virtual] |
Access the value of the spline function at the specified value.
- Parameters:
-
x : the point at which you wish to calculate the value for.
- Returns:
- double : the value of the function at x.
- Exceptions:
-
: StandardException : throws if input x value is outside the domain [debug mode only].
Implements ecl::GenericSplineFunction.
Definition at line 110 of file spline_function.hpp.
Member Data Documentation
Function ecl::SplineFunction< Function >::function [private] |
Definition at line 138 of file spline_function.hpp.
The documentation for this class was generated from the following file: