rufft 0.2.1

A pure rust FFT library !
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

use crate::traits::FloatIterable;
use super::SamplingError;
use num_traits::{ Float, FloatConst, NumAssign, AsPrimitive };
use core::fmt::Debug;
use core::ops::{ Deref, DerefMut };

#[derive(Default)]
pub struct SineBuilder<F>
where 
    F: Float + FloatConst + NumAssign + AsPrimitive<usize> + 'static 
        + Default + Debug,
    usize: AsPrimitive<F>
{
    fs: Option<F>,
    f: Option<F>,
    phase_offset: Option<F>,
    bias: Option<F>,
    amplitude: Option<F>
}

impl<F> SineBuilder<F>
where
    F: Float + FloatConst + NumAssign + AsPrimitive<usize> + 'static 
        + Default + Debug,
    usize: AsPrimitive<F>
{
    pub fn new() -> Self {
        Default::default()
    }

    pub fn fs(mut self, fs: F) -> Self {
        self.fs = Some(fs);
        self
    }

    pub fn f(mut self, f: F) -> Self {
        self.f = Some(f);
        self
    }

    pub fn phase_offset(mut self, offset: F) -> Self {
        self.phase_offset = Some(offset);
        self
    }

    pub fn bias(mut self, bias: F) -> Self {
        self.bias = Some(bias);
        self
    }

    pub fn amplitude(mut self, amplitude: F) -> Self {
        self.bias = Some(amplitude);
        self
    }

    pub fn build(self) -> Result<SineIterator<F>, SamplingError<F>> {
        let two = F::one() + F::one();
        let fs = self.fs.ok_or(
            SamplingError::<F>::MissingSamplingFreq
        )?;
        let f = self.f.ok_or(
            SamplingError::<F>::MissingFreq
        )?;
        if fs < (two * f) {
            return Err(SamplingError::ShannonError { f: f, fs: fs })
        }
        let amplitude = match self.amplitude {
            Some(x) => x,
            None => F::one()
        };
        let bias = match self.bias {
            Some(x) => x,
            None => F::zero()
        };
        let phase_offset = match self.phase_offset {
            Some(x) => x,
            None => F::zero()
        };
        Ok(SineIterator {
            f: f,
            fs: fs,
            phase_offset: phase_offset,
            bias: bias,
            amplitude: amplitude,
            i: 0
        })
    }
}

pub struct SineIterator<F>
where 
    F: Float + FloatConst + NumAssign + AsPrimitive<usize> + 'static,
    usize: AsPrimitive<F>
{
    fs: F,
    f: F,
    phase_offset: F,
    bias: F,
    amplitude: F,
    i: usize
}

impl<F> Iterator for SineIterator<F>
where
    F: Float + FloatConst + NumAssign + 'static + AsPrimitive<usize>,
    usize: AsPrimitive<F>
{
    type Item = F;

    fn next(&mut self) -> Option<Self::Item> {
        let t = self.i.as_() / self.fs;
        self.i += 1;
        Some(
            (((F::TAU() * self.f * t) + self.phase_offset).sin() * self.amplitude) + self.bias
        )
    }
}

pub struct Sine<F, C>
where 
    F: Float + FloatConst + NumAssign + 'static,
    C: FloatIterable<F> //+ FromIterator<F>
{
    inner: C,
    marker: core::marker::PhantomData<F>
}

impl<F, C> Deref for Sine<F, C> 
where 
    F: Float + FloatConst + NumAssign + 'static,
    C: FloatIterable<F> //+ FromIterator<F>
{
    type Target = C;

    fn deref(&self) -> &Self::Target {
        &self.inner
    }
}

impl<F, C> DerefMut for Sine<F, C> 
where 
    F: Float + FloatConst + NumAssign + 'static,
    C: FloatIterable<F> //+ FromIterator<F>
{
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.inner
    }
}

// Implement FromIterator for Sine<F, C>
impl<F, C> FromIterator<F> for Sine<F, C>
where
    F: Float + FloatConst + NumAssign + 'static,
    C: FromIterator<F> + FloatIterable<F>,
{
    fn from_iter<T: IntoIterator<Item = F>>(iter: T) -> Self {
        Sine {
            inner: C::from_iter(iter),
            marker: core::marker::PhantomData,
        }
    }
}

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

    #[test]
    fn test_collectable() {
        //let samples = vec![1.0, 2.0, 3.0, 4.0, 5.0];
        let iter = SineBuilder::new()
            .f(100.0)
            .fs(400.0)
            .build()
            .unwrap();
        
        let _sine: Sine<f64, Vec<_>> = iter.take(200).collect();
        
    }
}