Skip to main content

pamoja_complementary_new

Function pamoja_complementary_new 

Source
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pamoja_complementary_new( alpha: f32, initial: f32, ) -> *mut PamojaComplementary
Expand description

Creates a complementary filter, which fuses a drifting rate with a noisy absolute reading.

§Arguments

  • alpha - the weight on the integrated rate, held to 0 to 1; near 1 trusts the rate and corrects slowly. One that is not a number is taken as 0, following the absolute reading.
  • initial - the starting estimate.

§Returns

A handle the caller must release with pamoja_complementary_free.

§Safety

The returned handle must be freed exactly once.