Public Member Functions | Public Attributes | Protected Attributes | Private Member Functions | List of all members
o2scl::jacobian< func_t, vec_t, mat_t > Class Template Referenceabstract

Base for providing a numerical jacobian [abstract base]. More...

#include <jacobian.h>

Inheritance diagram for o2scl::jacobian< func_t, vec_t, mat_t >:
o2scl::jacobian_exact< func_t, vec_t, mat_t > o2scl::jacobian_gsl< func_t, vec_t, mat_t >

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 &)
jacobianoperator= (const jacobian &)

Detailed Description

template<class func_t = mm_funct11, class vec_t = boost::numeric::ublas::vector<double>, class mat_t = boost::numeric::ublas::matrix<double>>
class o2scl::jacobian< func_t, vec_t, mat_t >

This is provides a Jacobian which is numerically determined by differentiating a user-specified function (typically of the form of mm_funct11).

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

Definition at line 64 of file jacobian.h.

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

Documentation generated with Doxygen. Provided under the GNU Free Documentation License (see License Information).