Public Types | Public Member Functions | Private Attributes | List of all members
ecl::blueprints::CubicDerivativeInterpolation Class Reference

Blueprint for interpolating a cubic polynomial between end point conditions. More...

#include <polynomial.hpp>

Inheritance diagram for ecl::blueprints::CubicDerivativeInterpolation:
Inheritance graph
[legend]

Public Types

typedef ecl::CubicPolynomial base_type
 Abstract representation of the class to be instantiated/configured. More...
 

Public Member Functions

void apply (ecl::CubicPolynomial &polynomial) const
 Apply the blueprint to configure an existing object. More...
 
 CubicDerivativeInterpolation (const double x_i, const double y_i, const double ydot_i, const double x_f, const double y_f, const double ydot_f)
 Constructor that properly configures/initialises the blueprint. More...
 
ecl::CubicPolynomial instantiate ()
 Instantiate a copy of the object that is blueprinted. More...
 
virtual ~CubicDerivativeInterpolation ()
 
- Public Member Functions inherited from ecl::BluePrint< CubicDerivativeInterpolation >
 BluePrint ()
 
void implementApply (BaseType &object) const
 
BaseType implementInstantiate ()
 
virtual ~BluePrint ()
 

Private Attributes

double x_final
 
double x_initial
 
double y_final
 
double y_initial
 
double ydot_final
 
double ydot_initial
 

Detailed Description

Blueprint for interpolating a cubic polynomial between end point conditions.

Blueprint for interpolating a cubic polynomial between two end point conditions. That is, the resulting polynomial y(x) should satisfy the following conditions:

y(x_i) = y_i
y(x_f) = y_f
y'(x_i) = y'_i
y'(x_f) = y'_f
See also
Polynomial.

Definition at line 628 of file polynomial.hpp.

Member Typedef Documentation

◆ base_type

Abstract representation of the class to be instantiated/configured.

Definition at line 635 of file polynomial.hpp.

Constructor & Destructor Documentation

◆ CubicDerivativeInterpolation()

ecl::blueprints::CubicDerivativeInterpolation::CubicDerivativeInterpolation ( const double  x_i,
const double  y_i,
const double  ydot_i,
const double  x_f,
const double  y_f,
const double  ydot_f 
)
inline

Constructor that properly configures/initialises the blueprint.

Constructor that accepts the boundary constraints used to generate the cubic.

Parameters
x_i: initial domain value.
y_i: initial polynomial value.
ydot_i: initial polynomial slope.
x_f: final domain value.
y_f: final polynomial value.
ydot_f: final polynomial slope.

Definition at line 648 of file polynomial.hpp.

◆ ~CubicDerivativeInterpolation()

virtual ecl::blueprints::CubicDerivativeInterpolation::~CubicDerivativeInterpolation ( )
inlinevirtual

Definition at line 658 of file polynomial.hpp.

Member Function Documentation

◆ apply()

void ecl::blueprints::CubicDerivativeInterpolation::apply ( ecl::CubicPolynomial polynomial) const

Apply the blueprint to configure an existing object.

Apply the boundary conditions to generate coefficients for the given polynomial.

Parameters
polynomial: the polynomial to configure from the supplied boundary conditions.

Definition at line 93 of file polynomial_blueprints.cpp.

◆ instantiate()

ecl::CubicPolynomial ecl::blueprints::CubicDerivativeInterpolation::instantiate ( )

Instantiate a copy of the object that is blueprinted.

Instantiates a new cubic generated from the input boundary conditions.

Returns
CubicPolynomial : a copy of the generated cubic.

Definition at line 87 of file polynomial_blueprints.cpp.

Member Data Documentation

◆ x_final

double ecl::blueprints::CubicDerivativeInterpolation::x_final
private

Definition at line 678 of file polynomial.hpp.

◆ x_initial

double ecl::blueprints::CubicDerivativeInterpolation::x_initial
private

Definition at line 677 of file polynomial.hpp.

◆ y_final

double ecl::blueprints::CubicDerivativeInterpolation::y_final
private

Definition at line 678 of file polynomial.hpp.

◆ y_initial

double ecl::blueprints::CubicDerivativeInterpolation::y_initial
private

Definition at line 677 of file polynomial.hpp.

◆ ydot_final

double ecl::blueprints::CubicDerivativeInterpolation::ydot_final
private

Definition at line 678 of file polynomial.hpp.

◆ ydot_initial

double ecl::blueprints::CubicDerivativeInterpolation::ydot_initial
private

Definition at line 677 of file polynomial.hpp.


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


ecl_geometry
Author(s): Daniel Stonier
autogenerated on Sun Aug 2 2020 03:12:16