ScaledFunction Class Reference

A function scaled by some constant. More...

#include <PolynomialEvolution.h>

Inheritance diagram for ScaledFunction:

Collaboration diagram for ScaledFunction:

Public Member Functions
	ScaledFunction (const OneArgumentDiffFunction *f, double scale, double deriv_x=Core::NaN)
	Create the function. More...
double	operator() (double x) const
	Evaluates the function at the given x. More...
const FunctionDerivatives *	deriv (double x) const
	Returns the derivatives at the given x. More...
double	order (unsigned deriv_order=1) const
	For a derivative object returns the derivative of the given order. More...
double	range_high () const
	The upper end of the range over which the function is defined. More...
double	range_low () const
	The lower end of the range over which the function is defined. More...
Core::InterpSolutionIterator	crossings (double) const
	An iterator over the x values where the function takes the given value. More...
Public Member Functions inherited from Core::OneArgumentFunction< double, double >
virtual	~OneArgumentFunction ()
	Provide a virtual destructor for a virtual class. More...

Private Attributes
const OneArgumentDiffFunction *	__f
double	__scale
double	__deriv_x

Additional Inherited Members
Private Member Functions inherited from Core::FunctionDerivatives
virtual	~FunctionDerivatives ()
	Clean up. More...

Detailed Description

A function scaled by some constant.

Definition at line 594 of file PolynomialEvolution.h.

Constructor & Destructor Documentation

ScaledFunction()

ScaledFunction::ScaledFunction ( const OneArgumentDiffFunction *  f, double  scale, double  deriv_x = Core::NaN  )

inline

Create the function.

Definition at line 601 of file PolynomialEvolution.h.

Member Function Documentation

crossings()

Core::InterpSolutionIterator ScaledFunction::crossings ( double  ) const

inlinevirtual

An iterator over the x values where the function takes the given value.

Implements Core::OneArgumentFunction< double, double >.

Definition at line 625 of file PolynomialEvolution.h.

deriv()

const FunctionDerivatives* ScaledFunction::deriv ( double  x ) const

inlinevirtual

Returns the derivatives at the given x.

Implements Core::OneArgumentDiffFunction.

Definition at line 611 of file PolynomialEvolution.h.

operator()()

double ScaledFunction::operator() ( double  x ) const

inlinevirtual

Evaluates the function at the given x.

Implements Core::OneArgumentFunction< double, double >.

Definition at line 607 of file PolynomialEvolution.h.

order()

double ScaledFunction::order ( unsigned  deriv_order = 1 ) const

virtual

For a derivative object returns the derivative of the given order.

Implements Core::FunctionDerivatives.

Definition at line 606 of file PolynomialEvolution.cpp.

range_high()

double ScaledFunction::range_high ( ) const

inlinevirtual

The upper end of the range over which the function is defined.

Implements Core::OneArgumentFunction< double, double >.

Definition at line 618 of file PolynomialEvolution.h.

range_low()

double ScaledFunction::range_low ( ) const

inlinevirtual

The lower end of the range over which the function is defined.

Implements Core::OneArgumentFunction< double, double >.

Definition at line 621 of file PolynomialEvolution.h.

---

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

• /home/kpenev/projects/git/poet/poet_src/unit_tests/shared/PolynomialEvolution.h
• /home/kpenev/projects/git/poet/poet_src/unit_tests/shared/PolynomialEvolution.cpp