Trait culsynth::DspType

pub trait DspType<T: DspFormatBase>: Copy + Default + Send + Add<Self, Output = Self> + Sub<Self, Output = Self> + PartialOrd {
    const PI: Self;
    const TAU: Self;

    // Required methods
    fn zero() -> Self;
    fn one() -> Self;
    fn dsp_saturating_add(self, rhs: Self) -> Self;
    fn multiply(self, rhs: Self) -> Self;
    fn divide_by_two(self) -> Self;
    fn scale(self, rhs: T::Scalar) -> Self;
}

A trait to simplify common operations on DSP Types. This is used to maximize the amount of code that can be agnostic to fixed and floating point

Required Associated Constants

const PI: Self

A constant representing the value PI (3.14159…)

const TAU: Self

A constant representing the value 2*[PI]

Required Methods

fn zero() -> Self

Returns zero

fn one() -> Self

Returns one

fn dsp_saturating_add(self, rhs: Self) -> Self

This function will perform a saturating addition for fixed-point types, and a normal addition for floating-point types

Used for when saturation is desired to avoid overflows, not correctness

fn multiply(self, rhs: Self) -> Self

Multiply this type with itself. This trait does not provide any specified behavior for fixed-point overflow.

fn divide_by_two(self) -> Self

Divide a value by two

fn scale(self, rhs: T::Scalar) -> Self

Multiply this type by a Scalar. This will never overflow (by definition, the result will always be smaller)

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl DspType<i16> for I4F28

const PI: Self = PhaseFxP::PI

const TAU: Self = PhaseFxP::TAU

fn zero() -> Self

fn one() -> Self

fn dsp_saturating_add(self, rhs: Self) -> Self

fn multiply(self, rhs: Self) -> Self

fn divide_by_two(self) -> Self

fn scale(self, rhs: ScalarFxP) -> Self

Implementors

impl DspType<i16> for FrequencyFxP

const PI: Self = FrequencyFxP::PI

const TAU: Self = FrequencyFxP::TAU

impl<T> DspType<T> for T

where T: From<IScalarFxP> + From<NoteFxP> + Float + Send,

const PI: Self = Self::PI

const TAU: Self = Self::TAU

impl<T: Fixed16 + Send> DspType<i16> for T

const PI: Self = T::PI

const TAU: Self = T::TAU