jac_funct Class Template Reference

Base for a square Jacobian where J is computed at x given y=f(x) [abstract base]. More...

#include <jacobian.h>

Inheritance diagram for jac_funct:

jac_funct_cmfptr jac_funct_fptr jac_funct_mfptr jacobian exact_jacobian simple_jacobian

Detailed Description

template<class param_t, class vec_t = ovector_base, class mat_t = omatrix_base>
class jac_funct< param_t, vec_t, mat_t >

Base for a square Jacobian where J is computed at x given y=f(x) [abstract base].

Compute

\[ J_{ij} = \frac{\partial f_i}{\partial x_j} \]

The vec_t objects in operator() could have been written to be const, but they are not const so that they can be used as temporary workspace. They are typically restored to their original values before operator() exits.

For Jacobian functions with C-style arrays and matrices, use the corresponding children of jac_vfunct .

Definition at line 56 of file jacobian.h.


Public Member Functions

virtual int operator() (size_t nv, vec_t &x, vec_t &y, mat_t &j, param_t &pa)=0
 The operator().

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

Documentation generated with Doxygen and provided under the GNU Free Documentation License. See License Information for details.

Project hosting provided by SourceForge.net Logo, O2scl Sourceforge Project Page