gsl::multifit::nlinear::function_fdf::concept_df Struct Reference

This is an abstract base class. More...

#include <multifit_nlinear_function_fdf.hpp>

Collaboration diagram for gsl::multifit::nlinear::function_fdf::concept_df:

Public Member Functions
virtual int	df (gsl::vector const &x, gsl::matrix &J)=0
	The derivatives (as Jacobian matrix). More...

Detailed Description

This is an 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 concept_f and concept_df can be used in the constructor of function. This version allows gsl::vector instead of gsl_vector* with a small overhead.

Definition at line 90 of file multifit_nlinear_function_fdf.hpp.

Member Function Documentation

df()

virtual int gsl::multifit::nlinear::function_fdf::concept_df::df ( gsl::vector const &  x, gsl::matrix &  J  )

pure virtual

The derivatives (as Jacobian matrix).

This can be undefined in which case finite difference approximations are used.

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 value from the exception class for failure.

---

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

• multifit_nlinear_function_fdf.hpp