CoDiPack  2.2.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
codi::DummyHessian Struct Reference

Dummy Hessian. Has size zero and no logic in any call. More...

#include <hessian.hpp>

Inheritance diagram for codi::DummyHessian:

Public Member Functions

size_t getM () const
 Get size of rows (output variables).
 
size_t getN () const
 Get size of columns (input variables).
 
DummyValueoperator() (size_t const i, size_t const j, size_t const k)
 Reference access.
 
DummyValue operator() (size_t const i, size_t const j, size_t const k) const
 Value access.
 
void resize (size_t const m, size_t const n)
 Resize to the new dimensions.
 
size_t size () const
 Get total size of the Hessian.
 
- Public Member Functions inherited from codi::HessianInterface< DummyValue >
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, size_t const k)
 Reference access.
 
T operator() (size_t const i, size_t const j, size_t const k) const
 Value access.
 
void resize (size_t const m, size_t const n)
 Resize to the new dimensions.
 
size_t size () const
 Get total size of the Hessian.
 
virtual ~HessianInterface ()
 Destructor.
 

Additional Inherited Members

- Public Types inherited from codi::HessianInterface< DummyValue >
using T
 See HessianInterface.
 

Detailed Description

Dummy Hessian. Has size zero and no logic in any call.

Member Function Documentation

◆ getM()

size_t codi::DummyHessian::getM ( ) const
inline

Get size of rows (output variables).

◆ getN()

size_t codi::DummyHessian::getN ( ) const
inline

Get size of columns (input variables).

◆ operator()() [1/2]

DummyValue & codi::DummyHessian::operator() ( size_t const i,
size_t const j,
size_t const k )
inline

Reference access.

Parameters
[in]iOutput value of the function. Range: [0, m).
[in]jInput value of the function. First derivative direction. Range: [0,n).
[in]kInput value of the function. Second derivative direction. Range: [0,n).

◆ operator()() [2/2]

DummyValue codi::DummyHessian::operator() ( size_t const i,
size_t const j,
size_t const k ) const
inline

Value access.

Parameters
[in]iOutput value of the function. Range: [0, m).
[in]jInput value of the function. First derivative direction. Range: [0,n).
[in]kInput value of the function. Second derivative direction. Range: [0,n).

◆ resize()

void codi::DummyHessian::resize ( size_t const m,
size_t const n )
inline

Resize to the new dimensions.

◆ size()

size_t codi::DummyHessian::size ( ) const
inline

Get total size of the Hessian.


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