gsl::multiroot::function::Concept Struct Referenceabstract
This is an empty abstract base class. More...
#include <multiroot_function.hpp>
Collaboration diagram for gsl::multiroot::function::Concept:
Public Member Functions | |
| virtual int | f (gsl::vector const &x, gsl::vector &f)=0 |
| The function. 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 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 62 of file multiroot_function.hpp.
Member Function Documentation
◆ 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.
◆ size()
|
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:
