Struct Q31 

#[repr(transparent)]
pub struct Q31(pub i32);

Strongly-typed Q1.31 fixed-point number stored in an i32.

Range is [-1.0, 0.9999999995343387]. Provides operator overloading (+, -, *, /) with saturating fixed-point arithmetic.

Tuple Fields

0: i32

Implementations

impl Q31

pub const ZERO: Self

Zero representation (0.0).

pub const ONE: Self

Maximum positive value (~1.0 = i32::MAX).

pub const MIN: Self

Minimum representable value (-1.0 = i32::MIN).

pub const MAX: Self

Maximum representable value (~1.0 = i32::MAX).

pub const DELTA: Self

Smallest positive step (1 / 2^31).

pub const fn from_bits(bits: i32) -> Self

Create from raw integer bits.

pub const fn to_bits(self) -> i32

Retrieve raw integer bits.

pub fn from_f32(v: f32) -> Self

Convert from f32 with rounding and saturation.

pub fn to_f32(self) -> f32

Convert to f32.

pub fn from_f64(v: f64) -> Self

Convert from f64 with rounding and saturation.

pub fn to_f64(self) -> f64

Convert to f64.

pub const fn saturating_add(self, rhs: Self) -> Self

Saturating addition.

pub const fn saturating_sub(self, rhs: Self) -> Self

Saturating subtraction.

pub fn saturating_mul(self, rhs: Self) -> Self

Saturating Q31 multiplication.

pub fn saturating_div(self, rhs: Self) -> Self

Saturating Q31 division with division-by-zero protection.

pub const fn abs(self) -> Self

Absolute value (saturating at Self::MAX for -1.0).

pub fn clamp(self, min: Self, max: Self) -> Self

Clamp to [min, max].

Trait Implementations

impl Add for Q31

type Output = Q31

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Q31

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Q31

fn clone(&self) -> Q31

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Q31

impl Debug for Q31

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Q31

fn default() -> Q31

Returns the “default value” for a type.

impl Div for Q31

type Output = Q31

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for Q31

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl DspSample for Q31

const ZERO: Self = Self::ZERO

Additive identity (0.0).

const ONE: Self = Self::ONE

Multiplicative identity or normalized unity (1.0).

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

Saturating addition.

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

Saturating subtraction.

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

Saturating multiplication.

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

Saturating division.

fn abs_val(self) -> Self

Absolute value.

fn to_f32(self) -> f32

Convert to floating-point f32.

fn from_f32(val: f32) -> Self

Convert from floating-point f32.

impl Eq for Q31

impl From<Q31> for i32

fn from(v: Q31) -> Self

Converts to this type from the input type.

impl From<Q31> for f32

fn from(v: Q31) -> Self

Converts to this type from the input type.

impl From<f32> for Q31

fn from(v: f32) -> Self

Converts to this type from the input type.

impl From<i32> for Q31

fn from(v: i32) -> Self

Converts to this type from the input type.

impl Hash for Q31

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul for Q31

type Output = Q31

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for Q31

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for Q31

type Output = Q31

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for Q31

fn cmp(&self, other: &Q31) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Q31

fn eq(&self, other: &Q31) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Q31

fn partial_cmp(&self, other: &Q31) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Q31

impl Sub for Q31

type Output = Q31

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Q31

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.