Emrys::ModelWithMethod< Model_, Method_ > Class Template Reference

A process model and the prediction method that one mode of a SwitchingModel predicts it by, in place of the filter's [switching-models]. More...

#include <EmrysFilter/Models/SwitchingModel.h>

Public Types
using	ModelType = Model_
	the process model
using	MethodType = Method_
	the prediction method

Public Member Functions
	ModelWithMethod (Model_ model, Method_ method)
	model, predicted by method.
Model_ const &	model () const
Model_ &	model ()
Method_ const &	method () const

Detailed Description

template<typename Model_, typename Method_>
class Emrys::ModelWithMethod< Model_, Method_ >

A process model and the prediction method that one mode of a SwitchingModel predicts it by, in place of the filter's [switching-models].

A switching model's modes predict by the filter's method unless a mode's model carries its own, as a FixedStepModel always does and a model given to withMethod() does: in SwitchingModel{chain, cruise, withMethod(turn, methods::unscented())} the cruise mode predicts by the filter's method, Linearized by default, and the turn mode by Unscented. It is a switching model's argument only: SwitchingModel::model() returns the model it holds, and no other filter takes it.

Template Parameters

Model_	the process model, which is not fixed-step
Method_	the prediction method (see TransformMethod), not an Iterated one

See also

withMethod(), SwitchingModel

Member Function Documentation

method()

template<typename Model_, typename Method_>

Method_ const & Emrys::ModelWithMethod< Model_, Method_ >::method ( ) const

inlinenodiscard

Returns

the prediction method

model() [1/2]

template<typename Model_, typename Method_>

Model_ & Emrys::ModelWithMethod< Model_, Method_ >::model ( )

inlinenodiscard

Returns

the process model, to change its parameters

model() [2/2]

template<typename Model_, typename Method_>

Model_ const & Emrys::ModelWithMethod< Model_, Method_ >::model ( ) const

inlinenodiscard

Returns

the process model

---

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

• EmrysFilter/Models/SwitchingModel.h