gsl::multilarge::nlinear::function_fdf::concept_fdf Struct Reference

This is an abstract base class. More...

#include <multilarge_nlinear_function_fdf.hpp>

Collaboration diagram for gsl::multilarge::nlinear::function_fdf::concept_fdf:

Public Member Functions
virtual int	f (gsl::vector const &x, gsl::vector &f)=0
	The function. More...
virtual int	df (CBLAS_TRANSPOSE_t TransJ, gsl::vector const &x, gsl::vector const &u, gsl::vector &v, gsl::matrix &JTJ)=0
	The derivatives (as Jacobian matrix). More...
virtual size_t	xSize () const =0
	This function should return the number of elements of x in f(). More...
virtual size_t	fSize () const =0
	This function should return the number of elements of f in f(). 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_fdf can be used in the constructor of function. This version allows gsl::vector instead of gsl_vector* with a small overhead.

Definition at line 65 of file multilarge_nlinear_function_fdf.hpp.

Member Function Documentation

df()

virtual int gsl::multilarge::nlinear::function_fdf::concept_fdf::df ( CBLAS_TRANSPOSE_t  TransJ, gsl::vector const &  x, gsl::vector const &  u, gsl::vector &  v, gsl::matrix &  JTJ  )

pure virtual

The derivatives (as Jacobian matrix).

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

Parameters

TransJ	Set to blas::Trans to transpose J
x	The argument vector
u	An input vector
v	An output vector
JTJ	(Jacobian) matrix of size \(n\times n\) where \(n\) is the size of x; this holds the return values: may be null.

Returns

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

f()

virtual int gsl::multilarge::nlinear::function_fdf::concept_fdf::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 value from the exception class for failure.

fSize()

virtual size_t gsl::multilarge::nlinear::function_fdf::concept_fdf::fSize ( ) const

pure virtual

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

xSize()

virtual size_t gsl::multilarge::nlinear::function_fdf::concept_fdf::xSize ( ) const

pure virtual

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

---

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

• multilarge_nlinear_function_fdf.hpp