Classes | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
o2scl::jacobian_exact< func_t, vec_t, mat_t > Class Template Reference

A direct calculation of the jacobian using a deriv_base object. More...

#include <jacobian.h>

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

Classes

struct  ej_parms
 Parameter structure for passing information. More...
 

Public Member Functions

int set_deriv (deriv_base<> &de)
 Set the derivative object.
 
virtual int operator() (size_t nx, vec_t &x, size_t ny, vec_t &y, mat_t &jac)
 The operator()
 
virtual int jac_err (size_t nx, vec_t &x, size_t ny, vec_t &y, mat_t &jac, mat_t &err)
 Compute the Jacobian and its uncertainty from the numerical differentiation.
 
- Public Member Functions inherited from o2scl::jacobian< func_t, vec_t, mat_t >
virtual int set_function (func_t &f)
 Set the function to compute the Jacobian of.
 

Public Attributes

deriv_gsl def_deriv
 The default derivative object.
 
- Public Attributes inherited from o2scl::jacobian< func_t, vec_t, mat_t >
bool err_nonconv
 If true, call the error handler if the routine does not converge.
 

Protected Member Functions

double dfn (double x, ej_parms &ejp)
 Function for the derivative object.
 

Protected Attributes

deriv_basedptr
 Pointer to the derivative object.
 
- Protected Attributes inherited from o2scl::jacobian< func_t, vec_t, mat_t >
func_t func
 A pointer to the user-specified function.
 

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_exact< func_t, vec_t, mat_t >

By default, the stepsize, deriv_gsl::h is set to $ 10^{-4} $ in the jacobian_exact constructor.

Note that it is most often wasteful to use this Jacobian in a root-finding routine and using more approximate Jacobians is more efficient.

Default template arguments

Definition at line 340 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).