gsl::multimin::function_fdf::Concept Struct Reference

This is an empty abstract base class. More...

#include <multimin_function_fdf.hpp>

Collaboration diagram for gsl::multimin::function_fdf::Concept:

Public Member Functions
virtual double	f (const vector &x)=0
	The function. More...
virtual void	df (const vector &x, vector &gradient)=0
	The derivative. More...
virtual void	fdf (const vector &x, double *result, vector &gradient)=0
	The function and derivative. More...
size_t	size () const
	The dimension of the function argument. More...

Detailed Description

This is an empty abstract base class.

Its main purpose is to define the Concept of a class whose objects can be used to construct a function_fdf object. Any class that implements all three functions can be used in the constructor of function_fdf. If class is derived from gsl::function_fdf::Concept, the compiler is likely to give better warnings if one of the three required functions is not implemented correctly.

Definition at line 80 of file multimin_function_fdf.hpp.

Member Function Documentation

df()

virtual void gsl::multimin::function_fdf::Concept::df ( const vector &  x, vector &  gradient  )

pure virtual

The derivative.

Parameters

x	The argument.
gradient	The derivative evaluated at x.

f()

virtual double gsl::multimin::function_fdf::Concept::f ( const vector &  x )

pure virtual

The function.

Parameters

x	The argument.

Returns

The function evaluated at x.

fdf()

virtual void gsl::multimin::function_fdf::Concept::fdf ( const vector &  x, double *  result, vector &  gradient  )

pure virtual

The function and derivative.

Parameters

x	The argument.
result	The function value at x.
gradient	The derivative evaluated at x.

size()

size_t gsl::multimin::function_fdf::Concept::size

(

)

const

The dimension of the function argument.

Returns

The dimension (number of elements) of the function argument

---

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

• multimin_function_fdf.hpp