EmrysFilter 0.1.0
State estimation utilities in C++23 using Eigen
Loading...
Searching...
No Matches
Emrys::methods::Spread< Rule, A > Struct Template Reference

A sigma-point rule spread by axes of its own (decisions.md [sigma-point-axes]): Rule's unit points and weights, an UnscentedRule or a PointSet, carried into the input by the root A takes (Axes), in place of the default, roots::cholesky(roots::pivoted()). More...

#include <EmrysFilter/Models/Methods.h>

Public Attributes

Rule rule {}
 the unit points and weights
A axes {}
 the axes they are spread along

Detailed Description

template<typename Rule, typename A>
struct Emrys::methods::Spread< Rule, A >

A sigma-point rule spread by axes of its own (decisions.md [sigma-point-axes]): Rule's unit points and weights, an UnscentedRule or a PointSet, carried into the input by the root A takes (Axes), in place of the default, roots::cholesky(roots::pivoted()).

The axes apply to the input marked by withCross(), or to the first uncertain input when none is marked; the other inputs take the default, and an input that holds a root of its own, as a square-root form's blocks do, gives it to the axes as a factor. Wherever a rule is a method, a spread rule is: a measurement's method, a filter's prediction method, and the method an Iterated relinearizes.

A transform returns no std::expected, so axes that can fail are refused there at compile time, with a message naming roots::pivoted() to append and roots::squareRoot() for a caller who wants the std::expected.

Template Parameters
Rulethe sigma-point rule
Athe axes
See also
spread()

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