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

Where a step linearizes its input: a point, or a distribution, in place of the input's own mean and spread (decisions.md [linearization-reference]). More...

#include <EmrysFilter/Models/TransformArgs.h>

Public Types

using ReferenceType = Reference
 The point's type, or a reference to the distribution.

Public Member Functions

decltype(auto) mean () const

Public Attributes

Reference reference
 the point, or the distribution

Static Public Attributes

static constexpr bool IsDistribution = UncertainInput<std::remove_cvref_t<Reference>>
 Whether the reference is a distribution, which every method linearizes over, rather than a point, which only a linear method (Linearized) linearizes at.

Detailed Description

template<typename Reference>
struct Emrys::LinearizedAbout< Reference >

Where a step linearizes its input: a point, or a distribution, in place of the input's own mean and spread (decisions.md [linearization-reference]).

Made by linearizedAbout().

Template Parameters
Referencea plain vector, held by value, for a point; or a reference to an UncertainInput for a distribution, valid until the end of the full expression

Member Function Documentation

◆ mean()

template<typename Reference>
decltype(auto) Emrys::LinearizedAbout< Reference >::mean ( ) const
inlinenodiscard
Returns
the point, or the distribution's mean

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