Trait Coefficient

pub trait Coefficient:
    'static
    + Copy
    + Num
    + AsPrimitive<Self::ACCU> {
    type ACCU: AsPrimitive<Self> + Num;

    const ONE: Self;
    const NEG_ONE: Self;
    const ZERO: Self;
    const MIN: Self;
    const MAX: Self;

    // Required methods
    fn macc(self, s: Self::ACCU, min: Self, max: Self, e1: Self) -> (Self, Self);
    fn clip(self, min: Self, max: Self) -> Self;
    fn mul_scaled(self, other: Self) -> Self;
    fn div_scaled(self, other: Self) -> Self;
    fn quantize<C>(value: C) -> Self
       where Self: AsPrimitive<C>,
             C: Float + AsPrimitive<Self>;
}

Helper trait unifying fixed point and floating point coefficients/samples

Required Associated Constants

const ONE: Self

Multiplicative identity

const NEG_ONE: Self

Negative multiplicative identity, equal to -Self::ONE.

const ZERO: Self

Additive identity

const MIN: Self

Lowest value

const MAX: Self

Highest value

Required Associated Types

type ACCU: AsPrimitive<Self> + Num

Accumulator type

Required Methods

fn macc(self, s: Self::ACCU, min: Self, max: Self, e1: Self) -> (Self, Self)

Proper scaling and potentially using a wide accumulator. Clamp self such that min <= self <= max. Undefined result if max < min.

fn clip(self, min: Self, max: Self) -> Self

Clamp to between min and max

Undefined if min > max.

fn mul_scaled(self, other: Self) -> Self

Multiplication (scaled)

fn div_scaled(self, other: Self) -> Self

Division (scaled)

fn quantize<C>(value: C) -> Self

where Self: AsPrimitive<C>, C: Float + AsPrimitive<Self>,

Scale and quantize a floating point value.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl Coefficient for f32

const ONE: Self = 1f32

const NEG_ONE: Self = -1f32

const ZERO: Self = 0f32

const MIN: Self = -Inf_f32

const MAX: Self = +Inf_f32

type ACCU = f32

fn macc(self, s: Self::ACCU, min: Self, max: Self, _e1: Self) -> (Self, Self)

fn clip(self, min: Self, max: Self) -> Self

fn div_scaled(self, other: Self) -> Self

fn mul_scaled(self, other: Self) -> Self

fn quantize<C: Float + AsPrimitive<Self>>(value: C) -> Self

impl Coefficient for f64

const ONE: Self = 1f64

const NEG_ONE: Self = -1f64

const ZERO: Self = 0f64

const MIN: Self = -Inf_f64

const MAX: Self = +Inf_f64

type ACCU = f64

fn macc(self, s: Self::ACCU, min: Self, max: Self, _e1: Self) -> (Self, Self)

fn clip(self, min: Self, max: Self) -> Self

fn div_scaled(self, other: Self) -> Self

fn mul_scaled(self, other: Self) -> Self

fn quantize<C: Float + AsPrimitive<Self>>(value: C) -> Self

impl Coefficient for i8

const ONE: Self = 64i8

const NEG_ONE: Self = -64i8

const ZERO: Self = 0i8

const MIN: Self = -128i8

const MAX: Self = 127i8

type ACCU = i16

fn macc(self, s: Self::ACCU, min: Self, max: Self, e1: Self) -> (Self, Self)

fn clip(self, min: Self, max: Self) -> Self

fn div_scaled(self, other: Self) -> Self

fn mul_scaled(self, other: Self) -> Self

fn quantize<C>(value: C) -> Self

where Self: AsPrimitive<C>, C: Float + AsPrimitive<Self>,

impl Coefficient for i16

const ONE: Self = 16_384i16

const NEG_ONE: Self = -16_384i16

const ZERO: Self = 0i16

const MIN: Self = -32_768i16

const MAX: Self = 32_767i16

type ACCU = i32

fn macc(self, s: Self::ACCU, min: Self, max: Self, e1: Self) -> (Self, Self)

fn clip(self, min: Self, max: Self) -> Self

fn div_scaled(self, other: Self) -> Self

fn mul_scaled(self, other: Self) -> Self

fn quantize<C>(value: C) -> Self

where Self: AsPrimitive<C>, C: Float + AsPrimitive<Self>,

impl Coefficient for i32

const ONE: Self = 1_073_741_824i32

const NEG_ONE: Self = -1_073_741_824i32

const ZERO: Self = 0i32

const MIN: Self = -2_147_483_648i32

const MAX: Self = 2_147_483_647i32

type ACCU = i64

fn macc(self, s: Self::ACCU, min: Self, max: Self, e1: Self) -> (Self, Self)

fn clip(self, min: Self, max: Self) -> Self

fn div_scaled(self, other: Self) -> Self

fn mul_scaled(self, other: Self) -> Self

fn quantize<C>(value: C) -> Self

where Self: AsPrimitive<C>, C: Float + AsPrimitive<Self>,

impl Coefficient for i64

const ONE: Self = 4_611_686_018_427_387_904i64

const NEG_ONE: Self = -4_611_686_018_427_387_904i64

const ZERO: Self = 0i64

const MIN: Self = -9_223_372_036_854_775_808i64

const MAX: Self = 9_223_372_036_854_775_807i64

type ACCU = i128

fn macc(self, s: Self::ACCU, min: Self, max: Self, e1: Self) -> (Self, Self)

fn clip(self, min: Self, max: Self) -> Self

fn div_scaled(self, other: Self) -> Self

fn mul_scaled(self, other: Self) -> Self

fn quantize<C>(value: C) -> Self

where Self: AsPrimitive<C>, C: Float + AsPrimitive<Self>,

Implementors