#[derive(Debug, Clone, Copy, PartialEq)]
pub struct Vco {
pub f_min: f64,
pub f_max: f64,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum VcoError {
FMinExceedsFMax,
}
impl Vco {
pub fn new(f_min: f64, f_max: f64) -> Result<Self, VcoError> {
if f_min > f_max {
return Err(VcoError::FMinExceedsFMax);
}
Ok(Vco { f_min, f_max })
}
pub fn step(&self, phase: f64, freq_command: f64, dt: f64) -> f64 {
let freq = freq_command.clamp(self.f_min, self.f_max);
(phase + freq * dt).rem_euclid(1.0)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn steps_at_the_commanded_frequency_before_wrapping() {
let vco = Vco::new(0.0, 200_000.0).unwrap();
let phase = vco.step(0.0, 100_000.0, 1e-8);
assert!((phase - 1e-3).abs() < 1e-12);
}
#[test]
fn wraps_around_at_one() {
let vco = Vco::new(0.0, 200_000.0).unwrap();
let phase = vco.step(0.0, 100_000.0, 1e-5);
assert!(phase.abs() < 1e-9);
let phase2 = vco.step(0.5, 100_000.0, 1e-5);
assert!((phase2 - 0.5).abs() < 1e-9);
}
#[test]
fn clamps_frequency_command_to_range() {
let vco = Vco::new(50_000.0, 100_000.0).unwrap();
let phase_over = vco.step(0.0, 1_000_000.0, 1e-8);
let phase_at_max = vco.step(0.0, 100_000.0, 1e-8);
assert_eq!(phase_over, phase_at_max);
let phase_under = vco.step(0.0, -1_000_000.0, 1e-8);
let phase_at_min = vco.step(0.0, 50_000.0, 1e-8);
assert_eq!(phase_under, phase_at_min);
}
#[test]
fn f_min_exceeding_f_max_is_rejected_not_a_panic() {
assert_eq!(
Vco::new(200_000.0, 100_000.0),
Err(VcoError::FMinExceedsFMax)
);
}
}