gsl::multifit::nlinear::function_fdf::concept_f Struct Reference

This is an abstract base class. More...

#include <multifit_nlinear_function_fdf.hpp>

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

Public Member Functions
virtual int	f (gsl::vector const &x, gsl::vector &f)=0
	The function. 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_f 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 multifit_nlinear_function_fdf.hpp.

Member Function Documentation

f()

virtual int gsl::multifit::nlinear::function_fdf::concept_f::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::multifit::nlinear::function_fdf::concept_f::fSize ( ) const

pure virtual

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

xSize()

virtual size_t gsl::multifit::nlinear::function_fdf::concept_f::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:

• multifit_nlinear_function_fdf.hpp