BisectionExtremeFinder1D Class Reference

Bisection Extreme Finder. More...

Inheritance diagram for BisectionExtremeFinder1D:

Public Member Functions
	BisectionExtremeFinder1D (const FloatMathFunction &, bool max, int itermax, float tol, const Interval< float > &startinterval, const Interval< float > *limitinterval)
virtual	~BisectionExtremeFinder1D ()
void	reStart (const Interval< float > &startinterval, const Interval< float > *limitinterval)
float	extremePos () const
float	extremeVal () const
int	nrIter () const
int	nextStep ()
Public Member Functions inherited from SequentialTask
	SequentialTask (const char *nm=0)
virtual	~SequentialTask ()
void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...
ProgressMeter *	progressMeter ()
const ProgressMeter *	progressMeter () const
virtual int	doStep ()
bool	execute ()
Public Member Functions inherited from Task
virtual	~Task ()
virtual int64_t	nrDone () const
virtual int64_t	totalNr () const
virtual uiString	uiMessage () const
	will be message() again in 7.x More...
virtual uiString	uiNrDoneText () const
	will be nrDoneText() in 7.x More...
virtual void	enableWorkControl (bool=true)
	Must be called before execute() More...
bool	workControlEnabled () const
virtual void	controlWork (Control)
virtual Control	getState () const
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=0)
	NamedObject (const NamedObject *linkedto)
	NamedObject (const NamedObject &)
virtual	~NamedObject ()
void	setLinkedTo (NamedObject *)
bool	operator== (const NamedObject &oth) const
virtual const OD::String &	name () const
virtual const OD::String &	annotName () const
virtual void	setName (const char *)
void	setCleanName (const char *)
	cleans string first More...
void	deleteNotify (const CallBack &)
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (NotifierAccess &, const CallBack &, bool onlyifnew=false)
bool	attachCB (NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false)
void	detachCB (NotifierAccess &, const CallBack &)
void	detachCB (NotifierAccess *notif, const CallBack &cb)
bool	isNotifierAttached (NotifierAccess *) const
	Only for debugging purposes, don't use. More...

Protected Attributes
Interval< float > *	limits_
int	iter
const float	tol
const bool	max
const int	itermax
Interval< float >	current
float	startfuncval
float	stopfuncval
float	centerfuncval
bool	isok
const FloatMathFunction &	func
Protected Attributes inherited from SequentialTask
ProgressMeter *	progressmeter_
int	lastupdate_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedObject
BufferString *	name_
NamedObject *	linkedto_
CallBackSet *	delnotify_

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run, Pause, Stop }
Static Public Member Functions inherited from SequentialTask
static int	ErrorOccurred ()
static int	Finished ()
static int	MoreToDo ()
static int	WarningAvailable ()
Static Public Member Functions inherited from Task
static uiString	stdNrDoneText ()
static uiString	uiStdNrDoneText ()
Protected Member Functions inherited from Task
	Task (const char *nm=0)
virtual bool	shouldContinue ()
Protected Member Functions inherited from CallBacker
void	detachAllNotifiers ()
	Call from the destructor of your inherited object. More...

Detailed Description

Bisection Extreme Finder.

Constructor & Destructor Documentation

BisectionExtremeFinder1D::BisectionExtremeFinder1D	(	const FloatMathFunction &	,
		bool	max,
		int	itermax,
		float	tol,
		const Interval< float > &	startinterval,
		const Interval< float > *	limitinterval
	)

Parameters

func	The function, f(x) where the extreme value shoud be found
max	Specifies wether a min or max value should be found
itermax	Maximum number of iterations
tol	Tolerance on the function variable (x)
startinterval	The interval of x that the search will be inited by. Note that the search can go outside of this interval.
limitinterval	Set to true if only solutions within the interval is permitted

virtual BisectionExtremeFinder1D::~BisectionExtremeFinder1D ( )

virtual

Member Function Documentation

float BisectionExtremeFinder1D::extremePos

(

)

const

Returns

The x value of the extreme value

float BisectionExtremeFinder1D::extremeVal

(

)

const

Returns

The extreme value

int BisectionExtremeFinder1D::nextStep ( )

virtual

Will move the current extremePos one step towards the solution.

Return values

0	Finished
1	More to do
-1	Error (no extreme found or itermax reached The extreme value)

Implements SequentialTask.

int BisectionExtremeFinder1D::nrIter

(

)

const

Returns

The number of iterations

void BisectionExtremeFinder1D::reStart	(	const Interval< float > &	startinterval,
		const Interval< float > *	limitinterval
	)

Parameters

startinterval	The interval of x that the search will be inited by. Note that the search can go outside of this interval.
limitinterval	Set to true if only solutions within the interval is permitted

Member Data Documentation

float BisectionExtremeFinder1D::centerfuncval

protected

Interval<float> BisectionExtremeFinder1D::current

protected

const FloatMathFunction& BisectionExtremeFinder1D::func

protected

bool BisectionExtremeFinder1D::isok

protected

int BisectionExtremeFinder1D::iter

protected

const int BisectionExtremeFinder1D::itermax

protected

Interval<float>* BisectionExtremeFinder1D::limits_

protected

const bool BisectionExtremeFinder1D::max

protected

float BisectionExtremeFinder1D::startfuncval

protected

float BisectionExtremeFinder1D::stopfuncval

protected

const float BisectionExtremeFinder1D::tol

protected