scsolver::numeric::SingleVarFuncObj Class Reference

#include <funcobj.hxx>

Inheritance diagram for scsolver::numeric::SingleVarFuncObj:

[legend]

List of all members.

Public Member Functions
	SingleVarFuncObj ()
virtual	~SingleVarFuncObj ()=0
virtual void	setVar (double var)=0
virtual double	getVar () const =0
virtual double	eval () const =0
virtual const ::std::string	getFuncString () const =0
double	operator() (double var)

---

Detailed Description

Non-linear function object that only has one variable. Used for a line-search algorithm.

Definition at line 87 of file funcobj.hxx.

---

Constructor & Destructor Documentation

scsolver::numeric::SingleVarFuncObj::SingleVarFuncObj

(

)

Definition at line 265 of file funcobj.cxx.

scsolver::numeric::SingleVarFuncObj::~SingleVarFuncObj

(

)

[pure virtual]

Definition at line 269 of file funcobj.cxx.

---

Member Function Documentation

virtual void scsolver::numeric::SingleVarFuncObj::setVar

(

double

var

)

[pure virtual]

Implemented in SingleVarTestFuncBase, scsolver::numeric::BaseFuncSingleObjImpl, scsolver::numeric::BaseFuncRatioObjImpl, and scsolver::numeric::PrefixedSingleVarFuncObj.

Referenced by scsolver::numeric::calcStepLength(), scsolver::numeric::findLargestStep(), operator()(), scsolver::numeric::satisfiesArmijosRule(), scsolver::numeric::PrefixedSingleVarFuncObj::setVar(), and scsolver::numeric::NumericalDiffer::T0().

virtual double scsolver::numeric::SingleVarFuncObj::getVar

(

)

const [pure virtual]

Implemented in SingleVarTestFuncBase, scsolver::numeric::BaseFuncSingleObjImpl, scsolver::numeric::BaseFuncRatioObjImpl, and scsolver::numeric::PrefixedSingleVarFuncObj.

Referenced by scsolver::numeric::PrefixedSingleVarFuncObj::getVar().

virtual double scsolver::numeric::SingleVarFuncObj::eval

(

)

const [pure virtual]

Implemented in TestFunc1, TestFunc2, TestFunc3, TestFunc4, TestFunc5, TestFunc6, TestFunc7, TestFunc8, TestFunc1, TestFunc2, TestFunc2, scsolver::numeric::BaseFuncSingleObjImpl, scsolver::numeric::BaseFuncRatioObjImpl, TestFunc1, scsolver::numeric::PrefixedSingleVarFuncObj, TestFunc1, TestFunc2, TestFunc3, TestFunc4, TestFunc5, TestFunc6, TestFunc7, TestFunc8, TestFuncMax1, TestFuncMax2, TestFunc1, and TestFunc1.

Referenced by scsolver::numeric::calcStepLength(), scsolver::numeric::PrefixedSingleVarFuncObj::eval(), scsolver::numeric::findLargestStep(), operator()(), scsolver::numeric::satisfiesArmijosRule(), and scsolver::numeric::NumericalDiffer::T0().

virtual const ::std::string scsolver::numeric::SingleVarFuncObj::getFuncString

(

)

const [pure virtual]

Return a display-friendly function string (e.g. x^3 + 2*x^2 + 4).

Implemented in TestFunc1, TestFunc2, TestFunc3, TestFunc4, TestFunc5, TestFunc6, TestFunc7, TestFunc8, TestFunc1, TestFunc2, TestFunc2, scsolver::numeric::BaseFuncSingleObjImpl, scsolver::numeric::BaseFuncRatioObjImpl, TestFunc1, scsolver::numeric::PrefixedSingleVarFuncObj, TestFunc1, TestFunc2, TestFunc3, TestFunc4, TestFunc5, TestFunc6, TestFunc7, TestFunc8, TestFuncMax1, TestFuncMax2, TestFunc1, and TestFunc1.

Referenced by scsolver::numeric::PrefixedSingleVarFuncObj::getFuncString(), scsolver::numeric::QuadFitLineSearch::solve(), and scsolver::numeric::BisectionSearch::solve().

double scsolver::numeric::SingleVarFuncObj::operator()

(

double

var

)

Definition at line 273 of file funcobj.cxx.

References eval(), and setVar().

---

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

• source/inc/numeric/funcobj.hxx
• source/numeric/funcobj.cxx

---