vnl_least_squares_cost_function Class Reference

#include <vnl_least_squares_cost_function.h>

Inheritance diagram for vnl_least_squares_cost_function:

Detailed Description

An adaptor that converts a vnl_least_squares_function to a vnl_cost_function.

Definition at line 24 of file vnl_least_squares_cost_function.h.


Public Member Functions
	vnl_least_squares_cost_function (vnl_least_squares_function *f)
double	f (const vnl_vector< double > &x)
	The main function. Given the parameter vector x, compute the value of f(x).
virtual void	gradf (const vnl_vector< double > &x, vnl_vector< double > &gradient)
	Calculate the gradient of f at parameter vector x.
vnl_vector< double >	gradf (vnl_vector< double > const &x)
	Conveniences for printing grad, fdgrad.
virtual void	compute (vnl_vector< double > const &x, double f, vnl_vector< double > g)
	Compute one or both of f and g.
int	get_number_of_unknowns () const
	Return the number of unknowns.
void	fdgradf (vnl_vector< double > const &x, vnl_vector< double > &gradient, double stepsize=1e-5)
	Compute finite-difference gradient.
vnl_vector< double >	fdgradf (vnl_vector< double > const &x)
virtual double	reported_error (double f_value)
	Called when error is printed for user.
virtual double	get_range_min () const
	Return bounding cube of range (outputs).
virtual double	get_range_max () const
virtual vnl_unary_function< double, vnl_vector< double > > *	Copy () const
	Copy should allocate a copy of this on the heap and return it.
Public Attributes
int	dim
Protected Member Functions
void	set_number_of_unknowns (int number_of_unknowns)
	Set number of unknowns.
Protected Attributes
vnl_vector< double >	storage_
vnl_matrix< double >	jacobian_
vnl_least_squares_function *	f_

Constructor & Destructor Documentation

vnl_least_squares_cost_function::vnl_least_squares_cost_function ( vnl_least_squares_function * f )

Definition at line 14 of file vnl_least_squares_cost_function.cxx.

Member Function Documentation

double vnl_least_squares_cost_function::f ( const vnl_vector< double > & x ) [virtual]

The main function. Given the parameter vector x, compute the value of f(x).

Reimplemented from vnl_cost_function.

Definition at line 22 of file vnl_least_squares_cost_function.cxx.

void vnl_least_squares_cost_function::gradf	(	const vnl_vector< double > &	x,
		vnl_vector< double > &	gradient
	)			`[virtual]`

Calculate the gradient of f at parameter vector x.

Reimplemented from vnl_cost_function.

Definition at line 28 of file vnl_least_squares_cost_function.cxx.

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

Conveniences for printing grad, fdgrad.

Definition at line 67 of file vnl_cost_function.cxx.

void vnl_cost_function::compute	(	vnl_vector< double > const &	x,
		double *	f,
		vnl_vector< double > *	g
	)			`[virtual, inherited]`

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 16 of file vnl_cost_function.cxx.

int vnl_cost_function::get_number_of_unknowns ( ) const [inline, inherited]

Return the number of unknowns.

Definition at line 50 of file vnl_cost_function.h.

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

Compute finite-difference gradient.

Definition at line 46 of file vnl_cost_function.cxx.

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

Definition at line 74 of file vnl_cost_function.cxx.

virtual double vnl_cost_function::reported_error ( double f_value ) [inline, virtual, inherited]

Called when error is printed for user.

Definition at line 56 of file vnl_cost_function.h.

void vnl_cost_function::set_number_of_unknowns ( int number_of_unknowns ) [inline, protected, inherited]

Set number of unknowns.

Definition at line 65 of file vnl_cost_function.h.

virtual double vnl_unary_function< double , vnl_vector< double > >::get_range_min ( ) const [virtual, inherited]

Return bounding cube of range (outputs).

virtual double vnl_unary_function< double , vnl_vector< double > >::get_range_max ( ) const [virtual, inherited]

Return bounding cube of range (outputs).

virtual vnl_unary_function<double , vnl_vector< double > >* vnl_unary_function< double , vnl_vector< double > >::Copy ( ) const [inline, virtual, inherited]