EmrysFilter 0.1.0
State estimation utilities in C++23 using Eigen
Loading...
Searching...
No Matches
Emrys::WithJacobian< Value, Jacobian > Struct Template Reference

What a function returns when it knows its Jacobian: its value, and the Jacobian of its output differences in its uncertain inputs' differences, at the same point (decisions.md [returned-jacobians]). More...

#include <EmrysFilter/Models/Methods.h>

Public Attributes

Value value
 the function's value
Jacobian jacobian
 its Jacobian, one matrix or a tuple of blocks

Detailed Description

template<typename Value, typename Jacobian>
struct Emrys::WithJacobian< Value, Jacobian >

What a function returns when it knows its Jacobian: its value, and the Jacobian of its output differences in its uncertain inputs' differences, at the same point (decisions.md [returned-jacobians]).

Made by withJacobian().

Jacobian is one matrix when the function has one uncertain input, and otherwise a std::tuple of blocks, one per uncertain input in order, each with a row per output difference coordinate and a column per difference coordinate of its input. A model's function returns one matrix over its whole input instead, rows in its output's differences and columns in its input's (decisions.md [returned-jacobians]).


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