Base for providing a numerical jacobian [abstract base]. More...
#include <jacobian.h>
This is provides a Jacobian which is numerically determined by differentiating a user-specified function (typically of the form of mm_funct).
By convention, the Jacobian is stored in the order J[i][j]
(or J(i,j)
) where the rows have index i
which runs from 0 to ny-1
and the columns have index j
with runs from 0 to nx-1
.
Default template arguments
func_t
- mm_functvec_t
- boost::numeric::ublas::vector<double>mat_t
- boost::numeric::ublas::matrix<double> Definition at line 64 of file jacobian.h.
Public Member Functions | |
virtual int | set_function (func_t &f) |
Set the function to compute the Jacobian of. | |
virtual int | operator() (size_t nx, vec_t &x, size_t ny, vec_t &y, mat_t &j)=0 |
Evaluate the Jacobian j at point y(x) | |
Public Attributes | |
bool | err_nonconv |
If true, call the error handler if the routine does not converge. | |
Protected Attributes | |
func_t | func |
A pointer to the user-specified function. | |
Private Member Functions | |
jacobian (const jacobian &) | |
jacobian & | operator= (const jacobian &) |
Documentation generated with Doxygen. Provided under the
GNU Free Documentation License (see License Information).