gsl::multiroot::function_fdf::Concept Struct Reference

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

#include <multiroot_function_fdf.hpp>

Collaboration diagram for gsl::multiroot::function_fdf::Concept:

Public Member Functions
virtual int	f (gsl::vector const &x, gsl::vector &f)=0
	The function. More...
virtual int	df (gsl::vector const &x, gsl::matrix &J)=0
	The derivatives (as Jacobian matrix) More...
virtual int	fdf (gsl::vector const &x, gsl::vector &f, gsl::matrix &J)=0
	The function (returned as a vector) and derivatives (as Jacobian matrix) More...
virtual size_t	size () const =0
	This function should return the number of elements of x and f in f(). 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 object. Any class that implements f, df and fdf can be used in the constructor of function. This version allows gsl::vector instead of gsl_vector* with the small overhead of copying two pointers at each function evaluation.

Definition at line 58 of file multiroot_function_fdf.hpp.

Member Function Documentation

df()

virtual int gsl::multiroot::function_fdf::Concept::df ( gsl::vector const &  x, gsl::matrix &  J  )

pure virtual

The derivatives (as Jacobian matrix)

Parameters

x	The argument (vector)
J	(Jacobian) matrix of size \(n\times n\) where \(n\) is the size of x; this holds the return values.

Returns

An integer that represents the error code; return 0 (GSL_SUCCESS) for success and some alue from the exception class for failure.

f()

virtual int gsl::multiroot::function_fdf::Concept::f ( gsl::vector const &  x, gsl::vector &  f  )

pure virtual

The function.

Parameters

x	The argument (vector)
f	Vector of same size as x to hold the return values.

Returns

An integer that represents the error code; return 0 (GSL_SUCCESS) for success and some alue from the exception class for failure.

fdf()

virtual int gsl::multiroot::function_fdf::Concept::fdf ( gsl::vector const &  x, gsl::vector &  f, gsl::matrix &  J  )

pure virtual

The function (returned as a vector) and derivatives (as Jacobian matrix)

Parameters

x	The argument (vector)
f	Vector of same size as x to hold the return values.
J	(Jacobian) matrix of size \(n\times n\) where \(n\) is the size of x; this holds the return values.

Returns

An integer that represents the error code; return 0 (GSL_SUCCESS) for success and some alue from the exception class for failure.

size()

virtual size_t gsl::multiroot::function_fdf::Concept::size ( ) const

pure virtual

This function should return the number of elements of x and f in f().

---

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

• multiroot_function_fdf.hpp