Struct envelope_detector::peak::Peak

pub struct Peak<R = FullWave> {
    // some fields omitted
}

A peak rectifier, generic over FullWave, PositiveHalfWave and NegativeHalfWave rectification.

It produces a peak-following envelope when rectify is called over a signal of samples.

Methods

impl Peak<FullWave>

fn full_wave() -> Peak<FullWave>

A full-wave peak rectifier.

impl Peak<PositiveHalfWave>

fn positive_half_wave() -> Peak<PositiveHalfWave>

A positive half-wave peak rectifier.

impl Peak<NegativeHalfWave>

fn negative_half_wave() -> Peak<NegativeHalfWave>

A negative half-wave peak rectifier.

impl<R> Peak<R>

fn rectify(sample: f32) -> f32 where R: Rectifier

Return the rectified sample.

Trait Implementations

impl<R> Mode for Peak<R> where R: Rectifier

fn next_sample(&mut self, sample: f32) -> f32

Update state that is unique to the Mode.

impl<R: PartialEq> PartialEq for Peak<R>

fn eq(&self, __arg_0: &Peak<R>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Peak<R>) -> bool

This method tests for !=.

impl<R: Debug> Debug for Peak<R>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<R: Clone> Clone for Peak<R>

fn clone(&self) -> Peak<R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R: Copy> Copy for Peak<R>