Struct IterationConf

pub struct IterationConf {
    pub smoother: SmoothingArc,
    pub absolute_tol: f64,
    pub relative_tol: f64,
    pub max_iterations: usize,
    pub max_divergences: usize,
    pub force_failure: bool,
}

Defines a filter iteration configuration. Allows iterating on an OD solution until convergence criteria is met. The root mean squared of the prefit residuals ratios is used to assess convergence between iterations.

Fields

smoother: SmoothingArc

The number of measurements to account for in the iteration

absolute_tol: f64

The absolute tolerance of the RMS prefit residual ratios

relative_tol: f64

The relative tolerance between the latest RMS prefit residual ratios and the best RMS prefit residual ratios so far

max_iterations: usize

The maximum number of iterations to allow (will raise an error if the filter has not converged after this many iterations)

max_divergences: usize

The maximum number of subsequent divergences in RMS.

force_failure: bool

Set to true to force an ODP failure when the convergence criteria is not met

Implementations

impl IterationConf

pub fn builder() -> IterationConfBuilder<((), (), (), (), (), ())>

Create a builder for building IterationConf. On the builder, call .smoother(...)(optional), .absolute_tol(...)(optional), .relative_tol(...)(optional), .max_iterations(...)(optional), .max_divergences(...)(optional), .force_failure(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of IterationConf.

impl IterationConf

pub fn once() -> Self

Iterate and smooth only once

Trait Implementations

impl Clone for IterationConf

fn clone(&self) -> IterationConf

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IterationConf

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for IterationConf

fn default() -> Self

The default absolute tolerance is 1e-2 (calibrated on an EKF with error).

impl Display for IterationConf

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl TryFrom<SmoothingArc> for IterationConf

fn try_from(smoother: SmoothingArc) -> Result<Self, Self::Error>

Converts a smoother into an interation configuration to iterate just once without failing

type Error = NyxError

The type returned in the event of a conversion error.

impl Copy for IterationConf