Blueprint for generating a cubic spline satisfying C2 constraints. More...
#include <cubic_spline.hpp>
Public Types | |
| typedef ecl::CubicSpline | base_type |
| Abstract representation of the class to be instantiated/configured. | |
Public Member Functions | |
| void | apply (ecl::CubicSpline &spline) const |
| Apply the blueprint to configure an existing object. | |
| C2CubicSpline () | |
| Default constructor. | |
Public Attributes | |
| C2CubicSpline(const ecl::Array < double > &x_set, const ecl::Array< double > &y_set) ecl_assert_throw_decl(ecl ecl::CubicSpline | instantiate () |
| Constructor that properly configures/initialises the blueprint. | |
| virtual C2CubicSpline(const ecl::Array< double > &x_set, const ecl::Array< double > &y_set, const double ydot_0, const double ydot_f) ecl_assert_throw_decl(ecl | ~C2CubicSpline () |
| Constructor that properly configures/initialises the blueprint. | |
Private Attributes | |
| ecl::Array< double > | x_data |
| ecl::Array< double > | y_data |
| ecl::Array< double > | yddot_data |
Detailed Description
Blueprint for generating a cubic spline satisfying C2 constraints.
Blueprint for generating a cubic spline on a set of data given the constraint of continuity of y, y' and y''.
- See also:
- CubicSpline.
Definition at line 276 of file cubic_spline.hpp.
Member Typedef Documentation
Abstract representation of the class to be instantiated/configured.
Definition at line 281 of file cubic_spline.hpp.
Constructor & Destructor Documentation
| ecl::blueprints::C2CubicSpline::C2CubicSpline | ( | ) | [inline] |
Default constructor.
Default constructor (only utilised by the blueprint compile time assert).
Definition at line 287 of file cubic_spline.hpp.
Member Function Documentation
| void ecl::blueprints::C2CubicSpline::apply | ( | ecl::CubicSpline & | spline | ) | const |
Apply the blueprint to configure an existing object.
Apply the data set to generate the configuration required for the cubic spline.
- Parameters:
-
spline : the spline to configure from the supplied data set.
Definition at line 117 of file cubic_spline_blueprints.cpp.
Member Data Documentation
Constructor that properly configures/initialises the blueprint.
The constructor uses the input data sets to generate second derivatives at each via point so that a cubic spline will guarantee continuity. This is a special case that does not use boundary derivative values to establish the result. Rather it automatically sets the boundary second derivatives to zero. This is more commonly known as the natural cubic spline.
- Parameters:
-
x_set : set of data on the domain axis. y_set : set of values on the range axis.
- Exceptions:
-
: StandardException : throws if it failed to construct [debug mode only]. Instantiate a copy of the object that is blueprinted.
Instantiates a new cubic spline generated from the supplied data set.
- Returns:
- CubicSpline : a copy of the generated cubic spline.
Definition at line 327 of file cubic_spline.hpp.
ecl::Array<double> ecl::blueprints::C2CubicSpline::x_data [private] |
Definition at line 339 of file cubic_spline.hpp.
ecl::Array<double> ecl::blueprints::C2CubicSpline::y_data [private] |
Definition at line 340 of file cubic_spline.hpp.
ecl::Array<double> ecl::blueprints::C2CubicSpline::yddot_data [private] |
Definition at line 341 of file cubic_spline.hpp.
virtual C2CubicSpline (const ecl::Array<double>& x_set, const ecl::Array<double>& y_set, const double ydot_0, const double ydot_f) ecl_assert_throw_decl(ecl ecl::blueprints::C2CubicSpline::~C2CubicSpline() [inline] |
Constructor that properly configures/initialises the blueprint.
The constructor uses the input data sets to generate second derivatives at each via point so that a cubic spline will guarantee continuity.
- Parameters:
-
x_set : set of data on the domain axis. y_set : set of values on the range axis. ydot_0 : initial derivative value (boundary constraint). ydot_f : final derivative value (boundary constraint).
- Exceptions:
-
: StandardException : throws if it failed to construct [debug mode only].
Definition at line 304 of file cubic_spline.hpp.
The documentation for this class was generated from the following files: