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

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

#include <polynomial.hpp>

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

Public Types

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

Public Member Functions

void apply (ecl::QuinticPolynomial &polynomial) const
 Apply the blueprint to configure an existing object. More...
 
ecl::QuinticPolynomial instantiate ()
 Instantiate a copy of the object that is blueprinted. More...
 
 QuinticInterpolation (const double x_i, const double y_i, const double ydot_i, const double yddot_i, const double x_f, const double y_f, const double ydot_f, const double yddot_f)
 Constructor that properly configures/initialises the blueprint. More...
 
virtual ~QuinticInterpolation ()
 
- Public Member Functions inherited from ecl::BluePrint< QuinticInterpolation >
 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 yddot_final
 
double yddot_initial
 
double ydot_final
 
double ydot_initial
 

Detailed Description

Blueprint for interpolating a quintic polynomial between end point conditions.

Blueprint for interpolating a quintic 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_i) = y'_i
y''(x_i) = y''_i
y(x_f) = y_f
y'(x_f) = y'_f
y''(x_f) = y''_f
See also
Polynomial.

Definition at line 772 of file polynomial.hpp.

Member Typedef Documentation

◆ base_type

Abstract representation of the class to be instantiated/configured.

Definition at line 779 of file polynomial.hpp.

Constructor & Destructor Documentation

◆ QuinticInterpolation()

ecl::blueprints::QuinticInterpolation::QuinticInterpolation ( const double  x_i,
const double  y_i,
const double  ydot_i,
const double  yddot_i,
const double  x_f,
const double  y_f,
const double  ydot_f,
const double  yddot_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.
yddot_i: initial polynomial curvature.
x_f: final domain value.
y_f: final polynomial value.
ydot_f: final polynomial slope.
yddot_f: final polynomial curvature.

Definition at line 794 of file polynomial.hpp.

◆ ~QuinticInterpolation()

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

Definition at line 806 of file polynomial.hpp.

Member Function Documentation

◆ apply()

void ecl::blueprints::QuinticInterpolation::apply ( ecl::QuinticPolynomial 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 155 of file polynomial_blueprints.cpp.

◆ instantiate()

ecl::QuinticPolynomial ecl::blueprints::QuinticInterpolation::instantiate ( )

Instantiate a copy of the object that is blueprinted.

Instantiates a new cubic generated from the input boundary conditions.

Returns
QuinticPolynomial : a copy of the generated cubic.

Definition at line 149 of file polynomial_blueprints.cpp.

Member Data Documentation

◆ x_final

double ecl::blueprints::QuinticInterpolation::x_final
private

Definition at line 827 of file polynomial.hpp.

◆ x_initial

double ecl::blueprints::QuinticInterpolation::x_initial
private

Definition at line 826 of file polynomial.hpp.

◆ y_final

double ecl::blueprints::QuinticInterpolation::y_final
private

Definition at line 827 of file polynomial.hpp.

◆ y_initial

double ecl::blueprints::QuinticInterpolation::y_initial
private

Definition at line 826 of file polynomial.hpp.

◆ yddot_final

double ecl::blueprints::QuinticInterpolation::yddot_final
private

Definition at line 827 of file polynomial.hpp.

◆ yddot_initial

double ecl::blueprints::QuinticInterpolation::yddot_initial
private

Definition at line 826 of file polynomial.hpp.

◆ ydot_final

double ecl::blueprints::QuinticInterpolation::ydot_final
private

Definition at line 827 of file polynomial.hpp.

◆ ydot_initial

double ecl::blueprints::QuinticInterpolation::ydot_initial
private

Definition at line 826 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