Public Types | Public Member Functions | Private Attributes
ecl::blueprints::LinearPointSlopeForm Class Reference

Blueprint for generating a linear function from slope and point pair. More...

#include <polynomial.hpp>

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

List of all members.

Public Types

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

Public Member Functions

void apply (ecl::LinearFunction &function) const
 Apply the blueprint to configure an existing object.
ecl::LinearFunction instantiate ()
 Instantiate a copy of the object that is blueprinted.
 LinearPointSlopeForm (const double x_f, const double y_f, const double s)
 Constructor that properly configures/initialises the blueprint.
virtual ~LinearPointSlopeForm ()

Private Attributes

double slope
double x_final
double y_final

Detailed Description

Blueprint for generating a linear function from slope and point pair.

That is, the resulting linear function y(x) should satisfy the following conditions:

   (y(x_f)-y(x))  = slope*(x_f-x)
   y(x_f)  = y_f
See also:
ecl::LinearFunction.

Definition at line 554 of file polynomial.hpp.


Member Typedef Documentation

Abstract representation of the class to be instantiated/configured.

Definition at line 559 of file polynomial.hpp.


Constructor & Destructor Documentation

ecl::blueprints::LinearPointSlopeForm::LinearPointSlopeForm ( const double  x_f,
const double  y_f,
const double  s 
) [inline]

Constructor that properly configures/initialises the blueprint.

Constructor that accepts the boundary constraints used to generate the linear function.

Parameters:
x_f: final domain value.
y_f: final polynomial value.
s: slope

Definition at line 569 of file polynomial.hpp.

Definition at line 575 of file polynomial.hpp.


Member Function Documentation

Apply the blueprint to configure an existing object.

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

Parameters:
function: the linear function to configure from the input conditions.

Definition at line 62 of file polynomial_blueprints.cpp.

Instantiate a copy of the object that is blueprinted.

Instantiates a new linear function generated from the input conditions.

Returns:
LinearFunction : a copy of the generated function.

Definition at line 56 of file polynomial_blueprints.cpp.


Member Data Documentation

Definition at line 595 of file polynomial.hpp.

Definition at line 596 of file polynomial.hpp.

Definition at line 596 of file polynomial.hpp.


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


ecl_geometry
Author(s): Daniel Stonier
autogenerated on Wed Aug 26 2015 11:27:46