EmrysFilter 0.1.0
State estimation utilities in C++23 using Eigen
Loading...
Searching...
No Matches
Emrys::UnboundFixedStep< Model_, Method_, Time_ > Class Template Reference

A process model taken over one fixed time step, not yet bound to a state space: what fixedStep() returns. More...

#include <EmrysFilter/Models/ProcessModel.h>

Public Types

using ModelType = Model_
 the process model taken over the step
using MethodType = Method_
 the prediction method
using TimeType = Time_
 the time step's type

Public Member Functions

 UnboundFixedStep (Model_ model, Time_ dt, Method_ method)
 model taken over the step dt, predicting by method
Model_ const & model () const
Method_ const & method () const
Time_ const & timeStep () const
template<typename Space>
bool partitions (Space const &space) const

Static Public Member Functions

template<typename Space>
static consteval internal::StaticPartition staticPartition ()

Detailed Description

template<ProcessModel Model_, typename Method_, typename Time_>
class Emrys::UnboundFixedStep< Model_, Method_, Time_ >

A process model taken over one fixed time step, not yet bound to a state space: what fixedStep() returns.

A filter given one binds it to its state's space and scalar, as the FixedStepModel over them, which does the work that depends only on the step once, when the filter is built; so the space is named once, by the filter's state. simulate() and PosteriorCramerRaoBound take one too, over the space they are given, as the model and its step.

Template Parameters
Model_the process model
Method_the prediction method
Time_the time step's type, any TimeStep (see Time steps)
See also
fixedStep(), FixedStepModel, Models

Member Function Documentation

◆ method()

template<ProcessModel Model_, typename Method_, typename Time_>
Method_ const & Emrys::UnboundFixedStep< Model_, Method_, Time_ >::method ( ) const
inlinenodiscard
Returns
the prediction method

◆ model()

template<ProcessModel Model_, typename Method_, typename Time_>
Model_ const & Emrys::UnboundFixedStep< Model_, Method_, Time_ >::model ( ) const
inlinenodiscard
Returns
the process model taken over the step

◆ partitions()

template<ProcessModel Model_, typename Method_, typename Time_>
template<typename Space>
bool Emrys::UnboundFixedStep< Model_, Method_, Time_ >::partitions ( Space const & space) const
inlinenodiscard
Returns
whether the process model writes every coordinate of space once

◆ staticPartition()

template<ProcessModel Model_, typename Method_, typename Time_>
template<typename Space>
consteval internal::StaticPartition Emrys::UnboundFixedStep< Model_, Method_, Time_ >::staticPartition ( )
inlinestaticnodiscardconsteval
Returns
what the process model's types say about whether it writes every coordinate of Space once, as its staticPartition()

◆ timeStep()

template<ProcessModel Model_, typename Method_, typename Time_>
Time_ const & Emrys::UnboundFixedStep< Model_, Method_, Time_ >::timeStep ( ) const
inlinenodiscard
Returns
the time step \( \Delta t \), as it was given

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