Struct Waveform 

pub struct Waveform<T: SampleType, P: Precision = f32> { /* private fields */ }

Struct representing a waveform, consisting of output numeric type, sampling rate and a vector of PeriodicFunctions.

Implementations

impl<T: SampleType, P: Precision> Waveform<T, P>

pub fn new(sample_rate: impl Into<P>) -> Self

Initializes new empty Waveform

Panics

This method will panic if sample_rate is not a finite, positive, non-zero number.

Examples

use wavegen::Waveform;

let wf = Waveform::<f32>::new(500.0);

assert!(wf.iter().take(100).all(|y| y == 0.0));

pub fn with_components( sample_rate: impl Into<P>, components: Vec<PeriodicFunction<P>>, ) -> Self

Initializes new Waveform with predefined components

Panics

This method will panic if sample_rate is not a finite, positive, non-zero number.

Examples

use wavegen::{Waveform, sine, dc_bias};

let wf = Waveform::<f32>::with_components(100.0, vec![sine!(1.), dc_bias!(-50.)]);

pub fn add_component(&mut self, component: PeriodicFunction<P>)

Ads a new component to existing Waveform.

Examples

use wavegen::{Waveform, sine, dc_bias};

let mut wf = Waveform::<f32>::new(100.0);
wf.add_component(sine!(10.));
wf.add_component(dc_bias!(5.));

assert_eq!(2, wf.components().len());

pub fn sample_rate(&self) -> &P

Gets sample rate of this Waveform.

Examples

use wavegen::Waveform;

let wf = Waveform::<f32>::new(42.0);

assert_eq!(42.0, *wf.sample_rate());

pub fn components(&self) -> &Vec<PeriodicFunction<P>>

Returns list of components this Waveform consists of.

Examples

use wavegen::{Waveform, sine, dc_bias};

let wf = Waveform::<f32>::with_components(42.0, vec![sine!(1.), dc_bias!(5.)]);

assert_eq!(2, wf.components().len());

pub fn iter(&self) -> WaveformIterator<'_, T, P>

Returns an iterator over this Waveform samples.

Examples

use wavegen::{Waveform, sine};

let wf = Waveform::<f32>::with_components(42.0, vec![sine!(1.)]);
let samples = wf.iter().take(100).collect::<Vec<_>>();

Trait Implementations

impl<'a, T: SampleType, P: Precision> IntoIterator for &'a Waveform<T, P>

type Item = T

The type of the elements being iterated over.

type IntoIter = WaveformIterator<'a, T, P>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.