kai/pounder_test
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

rpll: docs

Browse Source
This commit is contained in:
Robert Jördens 2021-01-31 18:21:47 +01:00
parent d281783f2e
commit 43342cef91
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
dsp/src/rpll.rs
View File

@ -3,6 +3,8 @@
/// Consumes noisy, quantized timestamps of a reference signal and reconstructs /// 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 /// the phase and frequency of the update() invocations with respect to (and in units of
/// 1 << 32 of) that reference. /// 1 << 32 of) that reference.
/// In other words, `update()` rate ralative to reference frequency,
/// `u32::MAX` corresponding to both being equal.
#[derive(Copy, Clone, Default)] #[derive(Copy, Clone, Default)]
pub struct RPLL { pub struct RPLL {
dt2: u8, // 1 << dt2 is the counter rate to update() rate ratio dt2: u8, // 1 << dt2 is the counter rate to update() rate ratio
@ -40,7 +42,7 @@ impl RPLL {
/// ///
/// Returns: /// Returns:
/// A tuple containing the current phase (wrapping at the i32 boundary, pi) and /// A tuple containing the current phase (wrapping at the i32 boundary, pi) and
/// frequency (wrapping at the i32 boundary, Nyquist) estimate. /// frequency.
pub fn update( pub fn update(
&mut self, &mut self,
input: Option<i32>, input: Option<i32>,
@ -195,7 +197,7 @@ mod test {
limits[i] limits[i]
); );
} }
println!(""); println!();
} }
} }