CoDiPack  2.2.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
codi::JacobianInterface< T_T > Struct Template Reference

General interface for Jacobian access in CoDiPack. More...

#include <jacobianInterface.hpp>

Inheritance diagram for codi::JacobianInterface< T_T >:

Public Types

using T = T_T
 See JacobianInterface.
 

Public Member Functions

size_t getM () const
 Get size of rows (output variables).
 
size_t getN () const
 Get size of columns (input variables).
 
Toperator() (size_t const i, size_t const j)
 Reference access, i in [0, ..., m), j in [0, ..., n).
 
T operator() (size_t const i, size_t const j) const
 Value access, i in [0, ..., m), j in [0, ..., n).
 
void resize (size_t const m, size_t const n)
 Resize the Jacobian.
 
void setLogic (size_t const i, size_t const j, T const &v)
 Interface for the JacobianDelayAccessor.
 
size_t size () const
 Get total size of the Jacobian.
 

Detailed Description

template<typename T_T>
struct codi::JacobianInterface< T_T >

General interface for Jacobian access in CoDiPack.

Helper methods which store or read data from a Jacobian expect it to implement this interface.

See Mathematical naming conventions for the mathematical nomenclature of the arguments and components.

Template Parameters
T_TThe data type in the Jacobian.

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