Struct Fixed16 

pub struct Fixed16(/* private fields */);

A signed fixed-point value with $frac_bits bits.

Implementations

impl Fixed16

A signed fixed-point type.

pub const INTEGER_BITS: u8 = 16u8

The number of integer bits.

pub const FRACTIONAL_BITS: u8 = 16u8

The number of fractional bits.

pub const ZERO: Self

The fixed-point value representing 0.0.

pub const ONE: Self

The fixed-point value representing 1.0.

pub const MIN: Self

The minimum representable value of this type.

pub const MAX: Self

The maximum representable value of this type.

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

Returns the fixed-point value with the same bit-representation as the given value.

pub const fn get(self) -> i32

pub fn from_f32(n: f32) -> Self

Converts an f32 floating-point value to fixed point.

This conversion may be lossy, with behavior like standard Rust float-to-int casting. Extra precision will be truncated, and the result will be saturated if it doesn’t fit in the underlying type’s range. NaN returns 0.0.

pub fn from_f64(n: f64) -> Self

Converts an f64 floating-point value to fixed-point.

This conversion may be lossy, with behavior like standard Rust float-to-int casting. Extra precision will be truncated, and the result will be saturated if it doesn’t fit in the underlying type’s range. NaN returns 0.0.

pub fn to_f32(self) -> f32

Converts this fixed-point value to f32 floating-point.

This conversion may be lossy if f32 does not have enough precision to represent the fixed-point value.

Use From to ensure that the conversion is lossless at compile-time.

pub fn to_f64(self) -> f64

Converts this fixed-point value to f64 floating-point.

This conversion may be lossy if f64 does not have enough precision to represent the fixed-point value.

Use From to ensure that the conversion is lossless at compile-time.

pub const fn is_zero(self) -> bool

Returns true if this is equal to 0.0.

pub const fn is_one(self) -> bool

Returns true if this is equal to 1.0.

pub fn mul_int(self, other: i32) -> i32

Multiplies this fixed-point by an integer, returning the integer result. The result uses full range of the integer. The fractional bits will be truncated.

pub const fn wrapping_neg(self) -> Self

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type. -Self::MIN is the only case where wrapping occurs.

pub const fn wrapping_add(self, other: Self) -> Self

Wrapping (modular) addition. Computes self + rhs, wrapping around at the boundary of the type.

pub const fn wrapping_sub(self, other: Self) -> Self

Wrapping (modular) subtraction. Computes self - rhs, wrapping around at the boundary of the type.

pub const fn wrapping_mul(self, other: Self) -> Self

Wrapping (modular) multiplication. Computes self * rhs, wrapping around at the boundary of the type.

pub const fn wrapping_div(self, other: Self) -> Self

Wrapping (modular) division. Computes self / rhs, wrapping around at the boundary of the type.

pub const fn wrapping_mul_int(self, other: i32) -> i32

Wrapping (modular) multiplication. Multiplies this fixed-point by an integer, returning the integer result. The result will use the full size of the integer. The fractional bits will be truncated.

Trait Implementations

impl Add for Fixed16

type Output = Fixed16

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Fixed16

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for Fixed16

fn clone(&self) -> Fixed16

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Fixed16

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

Formats the value using the given formatter.

impl Default for Fixed16

fn default() -> Self

Returns the default value of 0.0.

impl Display for Fixed16

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

Formats the value using the given formatter.

impl Div<i32> for Fixed16

type Output = Fixed16

The resulting type after applying the / operator.

fn div(self, other: i32) -> Self

Performs the / operation.

impl Div for Fixed16

type Output = Fixed16

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<i32> for Fixed16

fn div_assign(&mut self, other: i32)

Performs the /= operation.

impl DivAssign for Fixed16

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl From<Fixed16> for f64

fn from(n: Fixed16) -> f64

Converts to this type from the input type.

impl From<i16> for Fixed16

fn from(n: i16) -> Self

Converts to this type from the input type.

impl From<i8> for Fixed16

fn from(n: i8) -> Self

Converts to this type from the input type.

impl Hash for Fixed16

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<Fixed16> for i32

type Output = Fixed16

The resulting type after applying the * operator.

fn mul(self, other: Fixed16) -> Fixed16

Performs the * operation.

impl Mul<i32> for Fixed16

type Output = Fixed16

The resulting type after applying the * operator.

fn mul(self, other: i32) -> Self

Performs the * operation.

impl Mul for Fixed16

type Output = Fixed16

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<i32> for Fixed16

fn mul_assign(&mut self, other: i32)

Performs the *= operation.

impl MulAssign for Fixed16

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl Neg for Fixed16

type Output = Fixed16

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl Ord for Fixed16

fn cmp(&self, other: &Fixed16) -> 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 Fixed16

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Fixed16

fn partial_cmp(&self, other: &Fixed16) -> 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 Sub for Fixed16

type Output = Fixed16

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Fixed16

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Copy for Fixed16

impl Eq for Fixed16

impl StructuralPartialEq for Fixed16