vnl_amoeba_LSCF Class Reference

Inheritance diagram for vnl_amoeba_LSCF:

Public Member Functions
	vnl_amoeba_LSCF (vnl_least_squares_function &ls)
	~vnl_amoeba_LSCF () override=default
double	f (vnl_vector< double > const &x) override
	Apply the function. More...
virtual void	gradf (vnl_vector< double > const &x, vnl_vector< double > &gradient)
	Calculate the gradient of f at parameter vector x. More...
vnl_vector< double >	gradf (vnl_vector< double > const &x)
	Conveniences for printing grad, fdgrad. More...
virtual void	compute (vnl_vector< double > const &x, double *f, vnl_vector< double > *g)
	Compute one or both of f and g. More...
int	get_number_of_unknowns () const
	Return the number of unknowns. More...
void	fdgradf (vnl_vector< double > const &x, vnl_vector< double > &gradient, double stepsize=1e-5)
	Compute finite-difference gradient. More...
vnl_vector< double >	fdgradf (vnl_vector< double > const &x)
virtual double	reported_error (double f_value)
	Called when error is printed for user. More...
virtual double	get_range_min () const
	Return bounding cube of range (outputs). More...
virtual double	get_range_max () const
	Return bounding cube of range (outputs). More...
virtual vnl_unary_function< double, vnl_vector< double > > *	Copy () const
	Copy should allocate a copy of this on the heap and return it. More...

Public Attributes
int	dim

Protected Member Functions
void	set_number_of_unknowns (int number_of_unknowns)
	Set number of unknowns. More...

Private Attributes
vnl_least_squares_function *	ls_
vnl_vector< double >	fx

Detailed Description

Definition at line 393 of file vnl_amoeba.cxx.

Constructor & Destructor Documentation

vnl_amoeba_LSCF()

vnl_amoeba_LSCF::vnl_amoeba_LSCF ( vnl_least_squares_function &  ls )

inline

Definition at line 398 of file vnl_amoeba.cxx.

~vnl_amoeba_LSCF()

vnl_amoeba_LSCF::~vnl_amoeba_LSCF ( )

overridedefault

Member Function Documentation

compute()

void vnl_cost_function::compute ( vnl_vector< double > const &  x, double *  f, vnl_vector< double > *  g  )

virtualinherited

Compute one or both of f and g.

Normally implemented in terms of the above two, but may be faster if specialized. f != 0 => compute f

Definition at line 13 of file vnl_cost_function.cxx.

Copy()

virtual vnl_unary_function<double , vnl_vector< double > >* vnl_unary_function< double , vnl_vector< double > >::Copy ( ) const

inlinevirtualinherited

Copy should allocate a copy of this on the heap and return it.

If Subclasses do not implement this function, it will return null, but many applications will never call it, so this may not be a problem for you.

Definition at line 44 of file vnl_unary_function.h.

f()

double vnl_amoeba_LSCF::f ( vnl_vector< double > const &  i )

inlineoverridevirtual

Apply the function.

The name is "f" rather than operator(), as the function will generally be called through a pointer. Note that the function is NOT const when you subclass.

Implements vnl_unary_function< double, vnl_vector< double > >.

Definition at line 404 of file vnl_amoeba.cxx.

fdgradf() [1/2]

void vnl_cost_function::fdgradf ( vnl_vector< double > const &  x, vnl_vector< double > &  gradient, double  stepsize = 1e-5  )

inherited

Compute finite-difference gradient.

Compute fd gradient.

Definition at line 43 of file vnl_cost_function.cxx.

fdgradf() [2/2]

vnl_vector< double > vnl_cost_function::fdgradf ( vnl_vector< double > const &  x )

inherited

Definition at line 70 of file vnl_cost_function.cxx.

get_number_of_unknowns()

int vnl_cost_function::get_number_of_unknowns ( ) const

inlineinherited

Return the number of unknowns.

Definition at line 48 of file vnl_cost_function.h.

get_range_max()

RETURN vnl_unary_function< RETURN, ARGUMENT >::get_range_max ( ) const

virtualinherited

Return bounding cube of range (outputs).

Definition at line 36 of file vnl_unary_function.hxx.

get_range_min()

RETURN vnl_unary_function< RETURN, ARGUMENT >::get_range_min ( ) const

virtualinherited

Return bounding cube of range (outputs).

Definition at line 29 of file vnl_unary_function.hxx.

gradf() [1/2]

void vnl_cost_function::gradf ( vnl_vector< double > const &  x, vnl_vector< double > &  gradient  )

virtualinherited

Calculate the gradient of f at parameter vector x.

Default implementation of gradf is to call compute.

Reimplemented in vnl_least_squares_cost_function.

Definition at line 33 of file vnl_cost_function.cxx.

gradf() [2/2]

vnl_vector< double > vnl_cost_function::gradf ( vnl_vector< double > const &  x )

inherited

Conveniences for printing grad, fdgrad.

Definition at line 63 of file vnl_cost_function.cxx.

reported_error()

virtual double vnl_cost_function::reported_error ( double  f_value )

inlinevirtualinherited

Called when error is printed for user.

Definition at line 54 of file vnl_cost_function.h.

set_number_of_unknowns()

void vnl_cost_function::set_number_of_unknowns ( int  number_of_unknowns )

inlineprotectedinherited

Set number of unknowns.

Definition at line 63 of file vnl_cost_function.h.

Member Data Documentation

dim

int vnl_cost_function::dim

inherited

Definition at line 66 of file vnl_cost_function.h.

fx

vnl_vector<double> vnl_amoeba_LSCF::fx

private

Definition at line 396 of file vnl_amoeba.cxx.

ls_

vnl_least_squares_function* vnl_amoeba_LSCF::ls_

private

Definition at line 395 of file vnl_amoeba.cxx.

---

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

• core/vnl/algo/vnl_amoeba.cxx