Struct RPLL

pub struct RPLL { /* private fields */ }

Reciprocal PLL.

Consumes noisy, quantized timestamps of a reference signal and reconstructs the phase and frequency of the update() invocations with respect to (and in units of 1 << 32 of) that reference. In other words, update() rate ralative to reference frequency, u32::MAX corresponding to both being equal.

Implementations

impl RPLL

pub fn new(dt2: u32) -> Self

Create a new RPLL instance.

Args:

• dt2: inverse update() rate. 1 << dt2 is the counter rate to update() rate ratio.

Returns: Initialized RPLL instance.

pub fn update( &mut self, input: Option<i32>, shift_frequency: u32, shift_phase: u32, ) -> (i32, u32)

Advance the RPLL and optionally supply a new timestamp.

Args:

• input: Optional new timestamp (wrapping around at the i32 boundary). There can be at most one timestamp per update() cycle (1 << dt2 counter cycles).
• shift_frequency: Frequency lock settling time. 1 << shift_frequency is frequency lock settling time in counter periods. The settling time must be larger than the signal period to lock to.
• shift_phase: Phase lock settling time. Usually one less than shift_frequency (see there).

Returns: A tuple containing the current phase (wrapping at the i32 boundary, pi) and frequency.

pub fn phase(&self) -> i32

Return the current phase estimate

pub fn frequency(&self) -> u32

Return the current frequency estimate

Trait Implementations

impl Clone for RPLL

fn clone(&self) -> RPLL

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for RPLL

fn default() -> RPLL

Returns the “default value” for a type.

impl Copy for RPLL