ExtremeFinder1D Class Reference

Finds extreme values in FloatMathFunctions. More...

Inheritance diagram for ExtremeFinder1D:

Public Member Functions
	ExtremeFinder1D (const FloatMathFunction &func, bool max, int itermax, float tol, const Interval< float > &startinterval, const Interval< float > *limitinterval)
virtual	~ExtremeFinder1D ()
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 uiString	message () const
virtual uiString	nrDoneText () const
virtual int64_t	nrDone () const
virtual int64_t	totalNr () const
virtual uiRetVal	errorWithDetails () const
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 NamedCallBacker
	NamedCallBacker (const char *nm=0)
	NamedCallBacker (const NamedCallBacker &)
bool	operator== (const NamedCallBacker &oth) const
bool	operator== (const NamedObject &oth) const
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const
bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const
void	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...
virtual bool	isCapsule () const
void	stopReceivingNotifications () const
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=0)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
virtual const OD::String &	name () const
virtual BufferString	getName () const
virtual void	setName (const char *nm)
bool	getNameFromPar (const IOPar &)
void	putNameInPar (IOPar &) const

Protected Attributes
float	ax_
float	bx_
float	cx_
float	e_
float	d_
float	a_
float	b_
float	u_
float	w_
float	v_
float	x_
float	fw_
float	fv_
float	fx_
Interval< float > *	limits_
int	iter_
const float	tol_
const FloatMathFunction &	func_
const bool	max_
const int	itermax_
Protected Attributes inherited from SequentialTask
ProgressMeter *	progressmeter_
int	lastupdate_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedCallBacker
Notifier< NamedCallBacker >	delnotif_
Threads::Atomic< bool >	delalreadytriggered_
Protected Attributes inherited from NamedObject
BufferString	name_

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	stdMessage ()
static uiString	stdNrDoneText ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()
Protected Member Functions inherited from Task
	Task (const char *nm=0)
virtual bool	shouldContinue ()
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const
Protected Member Functions inherited from CallBacker
void	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...

Detailed Description

Finds extreme values in FloatMathFunctions.

Implementation of Brent's Method in one dimension.

Constructor & Destructor Documentation

ExtremeFinder1D::ExtremeFinder1D	(	const FloatMathFunction &	func,
		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 ExtremeFinder1D::~ExtremeFinder1D ( )

virtual

Member Function Documentation

float ExtremeFinder1D::extremePos

(

)

const

Returns

The x value of the extreme value

float ExtremeFinder1D::extremeVal

(

)

const

Returns

The extreme value

int ExtremeFinder1D::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 ExtremeFinder1D::nrIter

(

)

const

Returns

The number of iterations

void ExtremeFinder1D::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 ExtremeFinder1D::a_

protected

float ExtremeFinder1D::ax_

protected

float ExtremeFinder1D::b_

protected

float ExtremeFinder1D::bx_

protected

float ExtremeFinder1D::cx_

protected

float ExtremeFinder1D::d_

protected

float ExtremeFinder1D::e_

protected

const FloatMathFunction& ExtremeFinder1D::func_

protected

float ExtremeFinder1D::fv_

protected

float ExtremeFinder1D::fw_

protected

float ExtremeFinder1D::fx_

protected

int ExtremeFinder1D::iter_

protected

const int ExtremeFinder1D::itermax_

protected

Interval<float>* ExtremeFinder1D::limits_

protected

const bool ExtremeFinder1D::max_

protected

const float ExtremeFinder1D::tol_

protected

float ExtremeFinder1D::u_

protected

float ExtremeFinder1D::v_

protected

float ExtremeFinder1D::w_

protected

float ExtremeFinder1D::x_

protected