adaptif 0.0.1

Adaptive filters for digital signal processing.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

use std::ops::Deref;

use crate::error::{Error, Result};
use crate::types::Float;

#[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct InputSignal<F: Float> {
    samples: Vec<F>,
}
impl<F: Float> InputSignal<F> {
    /// # Errors
    /// Returns an error if `input_signal` is empty.
    pub fn new(input_signal: Vec<F>) -> Result<Self> {
        if input_signal.is_empty() {
            Err(Error::EmptyInputArr)
        } else {
            Ok(InputSignal {
                samples: input_signal,
            })
        }
    }

    pub fn get(&self, n: usize) -> Option<InputSample<F>> {
        Some(InputSample(*self.samples.get(n)?))
    }

    #[allow(
        clippy::len_without_is_empty,
        reason = "InputSignal can't be empty (see new())"
    )]
    pub fn len(&self) -> usize {
        self.samples.len()
    }
}
impl<F: Float> AsRef<[F]> for InputSignal<F> {
    fn as_ref(&self) -> &[F] {
        &self.samples
    }
}
impl<F: Float> From<InputSignal<F>> for Vec<F> {
    fn from(value: InputSignal<F>) -> Self {
        value.samples
    }
}

#[derive(Debug, Clone, Copy)]
pub struct InputSample<F: Float>(pub F);
impl<F: Float> Deref for InputSample<F> {
    type Target = F;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn reject_empty_input() {
        assert!(matches!(
            InputSignal::<f64>::new(vec![]),
            Err(Error::EmptyInputArr)
        ));
    }
}