Public Member Functions | Static Public Member Functions | List of all members
ecl::BluePrintFactory< LinearFunction > Class Reference

Blueprint factory for linear functions. More...

#include <polynomial.hpp>

Public Member Functions

virtual ~BluePrintFactory ()
 

Static Public Member Functions

static LinearInterpolation Interpolation (const double x_i, const double y_i, const double x_f, const double y_f)
 Blueprint for an interpolating a linear function connecting two points. More...
 
static LinearPointSlopeForm PointSlopeForm (const double x_f, const double y_f, const double slope)
 Blueprint for an generating a linear function from slope/point form. More...
 

Detailed Description

Blueprint factory for linear functions.

Generates various blueprints that instantiate or configure linear functions with commonly used configurations. This class is inherited by the LinearFunction class, consequently it is simpler to access these blueprints via the inheritance mechanisms than to use this class directly. For example,

LinearFunction function = LinearFunction::Interpolation(0.0,0.0,1.0,2.0);
See also
LinearFunction.

Definition at line 853 of file polynomial.hpp.

Constructor & Destructor Documentation

◆ ~BluePrintFactory()

virtual ecl::BluePrintFactory< LinearFunction >::~BluePrintFactory ( )
inlinevirtual

Definition at line 877 of file polynomial.hpp.

Member Function Documentation

◆ Interpolation()

LinearInterpolation ecl::BluePrintFactory< LinearFunction >::Interpolation ( const double  x_i,
const double  y_i,
const double  x_f,
const double  y_f 
)
static

Blueprint for an interpolating a linear function connecting two points.

Parameters
x_i: initial domain value.
y_i: initial polynomial value.
x_f: final domain value.
y_f: final polynomial value.
Returns
LinearInterpolation : the resulting blueprint.
See also
ecl::blueprints::LinearInterpolation

Definition at line 205 of file polynomial_blueprints.cpp.

◆ PointSlopeForm()

LinearPointSlopeForm ecl::BluePrintFactory< LinearFunction >::PointSlopeForm ( const double  x_f,
const double  y_f,
const double  slope 
)
static

Blueprint for an generating a linear function from slope/point form.

Parameters
x_f: final domain value.
y_f: final polynomial value.
slope: slope of the linear function
Returns
LinearPointSlopeForm : the resulting blueprint.

Definition at line 209 of file polynomial_blueprints.cpp.


The documentation for this class was generated from the following files:
ecl::LinearFunction
Polynomial< 1 > LinearFunction
Mathematical term for 1st order polynomials.
Definition: polynomial.hpp:393


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