Skip to main content

Kalman

Struct Kalman 

Source
pub struct Kalman { /* private fields */ }
Expand description

Kalman filter over the one-way delay gradient, per draft-ietf-rmcat-gcc-02 §5.3.

§What it is for

A single inter-group delay measurement is mostly noise: scheduling jitter at either end, the receiver’s clock resolution, and TWCC’s 250 µs quantisation all move it around by more than the signal does early on. The filter estimates the trend — is the queue growing, and how fast — while adapting how much it trusts each new measurement to how noisy the measurements have been.

§Pure

No clock, no allocation, no state beyond four numbers. Every input is a parameter, which is what lets upstream’s table-driven vectors port directly.

Implementations§

Source§

impl Kalman

Source

pub fn new() -> Self

A filter with the draft’s default tuning.

Source

pub fn with_process_noise(self, process_noise: f64) -> Self

How fast the underlying gradient is assumed to drift. Larger tracks faster and is noisier.

Source

pub fn estimate(&self) -> f64

The current trend estimate, in milliseconds per group.

Source

pub fn update(&mut self, measurement: f64) -> f64

Fold in one inter-group delay measurement and return the updated estimate.

measurement is arrival spread minus departure spread for a pair of groups, in milliseconds.

Trait Implementations§

Source§

impl Clone for Kalman

Source§

fn clone(&self) -> Kalman

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Kalman

Source§

impl Debug for Kalman

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Kalman

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.