gsl::function_fdf::Concept Struct Reference

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

#include <function_fdf.hpp>

Collaboration diagram for gsl::function_fdf::Concept:

Public Member Functions
virtual double	f (double x)=0
	The function. More...
virtual double	df (double x)=0
	The derivative. More...
virtual std::pair< double, double >	fdf (double x)=0
	The function and derivative. 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 89 of file function_fdf.hpp.

Member Function Documentation

df()

virtual double gsl::function_fdf::Concept::df ( double  x )

pure virtual

The derivative.

Parameters

x	The argument.

Returns

The derivative evaluated at x.

f()

virtual double gsl::function_fdf::Concept::f ( double  x )

pure virtual

The function.

Parameters

x	The argument.

Returns

The function evaluated at x.

fdf()

virtual std::pair< double, double > gsl::function_fdf::Concept::fdf ( double  x )

pure virtual

The function and derivative.

Parameters

x	The argument.

Returns

The function and derivative (in that order) evaluated at x.

---

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

• function_fdf.hpp