ExtremeFinderND Class Reference

Finds the nearest local extreme position in ND's.
Implementation of Powell's Quadratically Convergent Method. More...

Inheritance diagram for ExtremeFinderND:

Public Member Functions
	ExtremeFinderND (const FloatMathFunctionND &func, bool max, int itermax)
virtual	~ExtremeFinderND ()
const float *	extremePos () const
template<class IDXABL >
void	extremePos (IDXABL &sp) const
	Sets the sp variable to the extreme position. More...
float	extremeVal () const
int	nextStep ()
int	nrIter () const
template<class IDXABL >
void	setStartPos (const IDXABL &sp)
Public Member Functions inherited from SequentialTask
	SequentialTask (const char *nm=nullptr)
virtual	~SequentialTask ()
virtual int	doStep ()
bool	execute ()
ProgressMeter *	progressMeter ()
const ProgressMeter *	progressMeter () const
void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...
Public Member Functions inherited from Task
virtual	~Task ()
virtual void	controlWork (Control)
virtual void	enableWorkControl (bool=true)
	Must be called before execute() More...
virtual uiRetVal	errorWithDetails () const
virtual Control	getState () const
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...
bool	workControlEnabled () const
Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=0)
	NamedCallBacker (const NamedCallBacker &)
virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const
bool	operator== (const NamedCallBacker &oth) const
bool	operator== (const NamedObject &oth) 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	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...
void	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
virtual bool	isCapsule () const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...
void	stopReceivingNotifications () const
Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)
	NamedObject (const NamedObject &oth)
virtual	~NamedObject ()
virtual BufferString	getName () const
bool	getNameFromPar (const IOPar &)
virtual const name_type &	name () const
NamedObject &	operator= (const NamedObject &)
bool	operator== (const NamedObject &oth) const
virtual void	setName (const char *nm)
Public Member Functions inherited from ObjectWithName
virtual	~ObjectWithName ()
bool	hasName (const char *nm) const
bool	hasName (const name_type &nm) const
void	putNameInPar (IOPar &) const

Private Member Functions
float	linExtreme (float *)

Private Attributes
float	fret_
float	ftol_
const FloatMathFunctionND &	func_
int	iter_
const int	itermax_
const bool	max_
int	n_
float *	p_
float *	pt_
ObjectSet< float >	xi_

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run , Pause , Stop }
Public Types inherited from ObjectWithName
typedef OD::String	name_type
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 ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()
Protected Member Functions inherited from Task
	Task (const char *nm=nullptr)
virtual bool	shouldContinue ()
Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const
Protected Attributes inherited from SequentialTask
int	lastupdate_
ProgressMeter *	progressmeter_
Protected Attributes inherited from Task
Control	control_
Threads::ConditionVar *	workcontrolcondvar_
Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_
Notifier< NamedCallBacker >	delnotif_
Protected Attributes inherited from NamedObject
BufferString	name_

Detailed Description

Finds the nearest local extreme position in ND's.
Implementation of Powell's Quadratically Convergent Method.

Note

The implementation is not tested (yet) 030512.

<>

Constructor & Destructor Documentation

ExtremeFinderND()

ExtremeFinderND::ExtremeFinderND	(	const FloatMathFunctionND &	func,
		bool	max,
		int	itermax
	)

Parameters

func	The function to be searched
max	Specifies wether a min or max should be searched for
itermax	The maximum number of iterations

~ExtremeFinderND()

virtual ExtremeFinderND::~ExtremeFinderND ( )

virtual

Member Function Documentation

extremePos() [1/2]

const float* ExtremeFinderND::extremePos ( ) const

inline

Returns

A pointer to the extreme positions

extremePos() [2/2]

template<class IDXABL >

void ExtremeFinderND::extremePos ( IDXABL &  sp ) const

inline

Sets the sp variable to the extreme position.

extremeVal()

float ExtremeFinderND::extremeVal ( ) const

inline

Returns

The extreme value

linExtreme()

float ExtremeFinderND::linExtreme ( float *  )

private

nextStep()

int ExtremeFinderND::nextStep ( )

virtual

Return values

MoreToDo()	Not finished. Call me again.
Finished()	Nothing more to do.
ErrorOccurred()	Something went wrong.

Note

if function returns a value greater than cMoreToDo(), it should be interpreted as cMoreToDo().

Implements SequentialTask.

nrIter()

int ExtremeFinderND::nrIter

(

)

const

Returns

The number of iterations

setStartPos()

template<class IDXABL >

void ExtremeFinderND::setStartPos ( const IDXABL &  sp )

inline

Member Data Documentation

fret_

float ExtremeFinderND::fret_

private

ftol_

float ExtremeFinderND::ftol_

private

func_

const FloatMathFunctionND& ExtremeFinderND::func_

private

iter_

int ExtremeFinderND::iter_

private

itermax_

const int ExtremeFinderND::itermax_

private

max_

const bool ExtremeFinderND::max_

private

n_

int ExtremeFinderND::n_

private

p_

float* ExtremeFinderND::p_

private

pt_

float* ExtremeFinderND::pt_

private

xi_

ObjectSet<float> ExtremeFinderND::xi_

private