// Copyright © 2018–2025 Trevor Spiteri // This library is free software: you can redistribute it and/or // modify it under the terms of either // // * the Apache License, Version 2.0 or // * the MIT License // // at your option. // // You should have recieved copies of the Apache License and the MIT // License along with the library. If not, see // and // . use crate::from_str::ParseFixedError; use crate::traits::{Fixed, FixedSigned, FixedUnsigned, FromFixed, ToFixed}; use crate::types::extra::{LeEqU8, LeEqU16, LeEqU32, LeEqU64, LeEqU128}; use crate::{ FixedI8, FixedI16, FixedI32, FixedI64, FixedI128, FixedU8, FixedU16, FixedU32, FixedU64, FixedU128, }; use core::fmt::{ Binary, Debug, Display, Formatter, LowerExp, LowerHex, Octal, Result as FmtResult, UpperExp, UpperHex, }; use core::iter::{Product, Sum}; use core::ops::{ Add, AddAssign, BitAnd, BitAndAssign, BitOr, BitOrAssign, BitXor, BitXorAssign, Div, DivAssign, Mul, MulAssign, Neg, Not, Rem, RemAssign, Shl, ShlAssign, Shr, ShrAssign, Sub, SubAssign, }; use core::str::FromStr; /// Provides intentionally wrapped arithmetic on fixed-point numbers. /// /// The underlying value can be retrieved through the `.0` index. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let max = Wrapping(I16F16::MAX); /// let delta = Wrapping(I16F16::DELTA); /// assert_eq!(I16F16::MIN, (max + delta).0); /// ``` #[repr(transparent)] #[derive(Clone, Copy, Default, Hash, Eq, PartialEq, Ord, PartialOrd)] pub struct Wrapping(pub F); impl Wrapping { /// Zero. /// /// See also FixedI32::[ZERO][FixedI32::ZERO] and /// FixedU32::[ZERO][FixedU32::ZERO]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// assert_eq!(Wrapping::::ZERO, Wrapping(I16F16::ZERO)); /// ``` pub const ZERO: Wrapping = Wrapping(F::ZERO); /// The difference between any two successive representable numbers, Δ. /// /// See also FixedI32::[DELTA][FixedI32::DELTA] and /// FixedU32::[DELTA][FixedU32::DELTA]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// assert_eq!(Wrapping::::DELTA, Wrapping(I16F16::DELTA)); /// ``` pub const DELTA: Wrapping = Wrapping(F::DELTA); /// The smallest value that can be represented. /// /// See also FixedI32::[MIN][FixedI32::MIN] and /// FixedU32::[MIN][FixedU32::MIN]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// assert_eq!(Wrapping::::MIN, Wrapping(I16F16::MIN)); /// ``` pub const MIN: Wrapping = Wrapping(F::MIN); /// The largest value that can be represented. /// /// See also FixedI32::[MAX][FixedI32::MAX] and /// FixedU32::[MAX][FixedU32::MAX]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// assert_eq!(Wrapping::::MAX, Wrapping(I16F16::MAX)); /// ``` pub const MAX: Wrapping = Wrapping(F::MAX); /// [`true`] if the type is signed. /// /// See also FixedI32::[IS\_SIGNED][FixedI32::IS_SIGNED] and /// FixedU32::[IS\_SIGNED][FixedU32::IS_SIGNED]. /// /// # Examples /// /// ```rust /// use fixed::types::{I16F16, U16F16}; /// use fixed::Wrapping; /// assert!(Wrapping::::IS_SIGNED); /// assert!(!Wrapping::::IS_SIGNED); /// ``` pub const IS_SIGNED: bool = F::IS_SIGNED; /// The number of integer bits. /// /// See also FixedI32::[INT\_NBITS][FixedI32::INT_NBITS] and /// FixedU32::[INT\_NBITS][FixedU32::INT_NBITS]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// assert_eq!(Wrapping::::INT_NBITS, I16F16::INT_NBITS); /// ``` pub const INT_NBITS: u32 = F::INT_NBITS; /// The number of fractional bits. /// /// See also FixedI32::[FRAC\_NBITS][FixedI32::FRAC_NBITS] and /// FixedU32::[FRAC\_NBITS][FixedU32::FRAC_NBITS]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// assert_eq!(Wrapping::::FRAC_NBITS, I16F16::FRAC_NBITS); /// ``` pub const FRAC_NBITS: u32 = F::FRAC_NBITS; /// Creates a fixed-point number that has a bitwise representation /// identical to the given integer. /// /// See also FixedI32::[from\_bits][FixedI32::from_bits] and /// FixedU32::[from\_bits][FixedU32::from_bits]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// assert_eq!(Wrapping::::from_bits(0x1C), Wrapping(I16F16::from_bits(0x1C))); /// ``` #[inline] pub fn from_bits(bits: F::Bits) -> Wrapping { Wrapping(F::from_bits(bits)) } /// Creates an integer that has a bitwise representation identical /// to the given fixed-point number. /// /// See also FixedI32::[to\_bits][FixedI32::to_bits] and /// FixedU32::[to\_bits][FixedU32::to_bits]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let w = Wrapping(I16F16::from_bits(0x1C)); /// assert_eq!(w.to_bits(), 0x1C); /// ``` #[inline] pub fn to_bits(self) -> F::Bits { self.0.to_bits() } /// Converts a fixed-point number from big endian to the target’s /// endianness. /// /// See also FixedI32::[from\_be][FixedI32::from_be] and /// FixedU32::[from\_be][FixedU32::from_be]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let w = Wrapping(I16F16::from_bits(0x1234_5678)); /// if cfg!(target_endian = "big") { /// assert_eq!(Wrapping::from_be(w), w); /// } else { /// assert_eq!(Wrapping::from_be(w), w.swap_bytes()); /// } /// ``` #[inline] pub fn from_be(w: Self) -> Self { Wrapping(F::from_be(w.0)) } /// Converts a fixed-point number from little endian to the /// target’s endianness. /// /// See also FixedI32::[from\_le][FixedI32::from_le] and /// FixedU32::[from\_le][FixedU32::from_le]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let w = Wrapping(I16F16::from_bits(0x1234_5678)); /// if cfg!(target_endian = "little") { /// assert_eq!(Wrapping::from_le(w), w); /// } else { /// assert_eq!(Wrapping::from_le(w), w.swap_bytes()); /// } /// ``` #[inline] pub fn from_le(w: Self) -> Self { Wrapping(F::from_le(w.0)) } /// Converts `self` to big endian from the target’s endianness. /// /// See also FixedI32::[to\_be][FixedI32::to_be] and /// FixedU32::[to\_be][FixedU32::to_be]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let w = Wrapping(I16F16::from_bits(0x1234_5678)); /// if cfg!(target_endian = "big") { /// assert_eq!(w.to_be(), w); /// } else { /// assert_eq!(w.to_be(), w.swap_bytes()); /// } /// ``` #[inline] #[must_use] pub fn to_be(self) -> Self { Wrapping(self.0.to_be()) } /// Converts `self` to little endian from the target’s endianness. /// /// See also FixedI32::[to\_le][FixedI32::to_le] and /// FixedU32::[to\_le][FixedU32::to_le]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let w = Wrapping(I16F16::from_bits(0x1234_5678)); /// if cfg!(target_endian = "little") { /// assert_eq!(w.to_le(), w); /// } else { /// assert_eq!(w.to_le(), w.swap_bytes()); /// } /// ``` #[inline] #[must_use] pub fn to_le(self) -> Self { Wrapping(self.0.to_le()) } /// Reverses the byte order of the fixed-point number. /// /// See also FixedI32::[swap\_bytes][FixedI32::swap_bytes] and /// FixedU32::[swap\_bytes][FixedU32::swap_bytes]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let w = Wrapping(I16F16::from_bits(0x1234_5678)); /// let swapped = Wrapping(I16F16::from_bits(0x7856_3412)); /// assert_eq!(w.swap_bytes(), swapped); /// ``` #[inline] #[must_use] pub fn swap_bytes(self) -> Self { Wrapping(self.0.swap_bytes()) } /// Creates a fixed-point number from its representation /// as a byte array in big endian. /// /// See also /// FixedI32::[from\_be\_bytes][FixedI32::from_be_bytes] and /// FixedU32::[from\_be\_bytes][FixedU32::from_be_bytes]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let bytes = [0x12, 0x34, 0x56, 0x78]; /// assert_eq!( /// Wrapping::::from_be_bytes(bytes), /// Wrapping::::from_bits(0x1234_5678) /// ); /// ``` #[inline] pub fn from_be_bytes(bytes: F::Bytes) -> Self { Wrapping(F::from_be_bytes(bytes)) } /// Creates a fixed-point number from its representation /// as a byte array in little endian. /// /// See also /// FixedI32::[from\_le\_bytes][FixedI32::from_le_bytes] and /// FixedU32::[from\_le\_bytes][FixedU32::from_le_bytes]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let bytes = [0x78, 0x56, 0x34, 0x12]; /// assert_eq!( /// Wrapping::::from_le_bytes(bytes), /// Wrapping::::from_bits(0x1234_5678) /// ); /// ``` #[inline] pub fn from_le_bytes(bytes: F::Bytes) -> Self { Wrapping(F::from_le_bytes(bytes)) } /// Creates a fixed-point number from its representation /// as a byte array in native endian. /// /// See also /// FixedI32::[from\_ne\_bytes][FixedI32::from_ne_bytes] and /// FixedU32::[from\_ne\_bytes][FixedU32::from_ne_bytes]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let bytes = if cfg!(target_endian = "big") { /// [0x12, 0x34, 0x56, 0x78] /// } else { /// [0x78, 0x56, 0x34, 0x12] /// }; /// assert_eq!( /// Wrapping::::from_ne_bytes(bytes), /// Wrapping::::from_bits(0x1234_5678) /// ); /// ``` #[inline] pub fn from_ne_bytes(bytes: F::Bytes) -> Self { Wrapping(F::from_ne_bytes(bytes)) } /// Returns the memory representation of this fixed-point /// number as a byte array in big-endian byte order. /// /// See also FixedI32::[to\_be\_bytes][FixedI32::to_be_bytes] /// and FixedU32::[to\_be\_bytes][FixedU32::to_be_bytes]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// assert_eq!( /// Wrapping::::from_bits(0x1234_5678).to_be_bytes(), /// [0x12, 0x34, 0x56, 0x78] /// ); /// ``` #[inline] pub fn to_be_bytes(self) -> F::Bytes { self.0.to_be_bytes() } /// Returns the memory representation of this fixed-point /// number as a byte array in little-endian byte order. /// /// See also FixedI32::[to\_le\_bytes][FixedI32::to_le_bytes] /// and FixedU32::[to\_le\_bytes][FixedU32::to_le_bytes]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// assert_eq!( /// Wrapping::::from_bits(0x1234_5678).to_le_bytes(), /// [0x78, 0x56, 0x34, 0x12] /// ); /// ``` #[inline] pub fn to_le_bytes(self) -> F::Bytes { self.0.to_le_bytes() } /// Returns the memory representation of this fixed-point /// number as a byte array in native-endian byte order. /// /// See also FixedI32::[to\_ne\_bytes][FixedI32::to_ne_bytes] /// and FixedU32::[to\_ne\_bytes][FixedU32::to_ne_bytes]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let bytes = if cfg!(target_endian = "big") { /// [0x12, 0x34, 0x56, 0x78] /// } else { /// [0x78, 0x56, 0x34, 0x12] /// }; /// assert_eq!( /// Wrapping::::from_bits(0x1234_5678).to_ne_bytes(), /// bytes /// ); /// ``` #[inline] pub fn to_ne_bytes(self) -> F::Bytes { self.0.to_ne_bytes() } /// Wrapping conversion from another number. /// /// The other number can be: /// /// * A fixed-point number. Any extra fractional bits are /// discarded, which rounds towards −∞. /// * An integer of type [`i8`], [`i16`], [`i32`], [`i64`], [`i128`], /// [`isize`], [`u8`], [`u16`], [`u32`], [`u64`], [`u128`], or /// [`usize`]. /// * A floating-point number of type /// [half]::[f16][half::f16], /// [half]::[bf16][half::bf16], [`f32`], [`f64`] or /// [`F128`]. For this conversion, the method rounds to the nearest, /// with ties rounding to even. /// * Any other number `src` for which [`ToFixed`] is /// implemented, in which case this method returns /// [Wrapping]\(src.[wrapping\_to\_fixed][ToFixed::wrapping_to_fixed]\()). /// /// See also /// FixedI32::[wrapping\_from\_num][FixedI32::wrapping_from_num] /// and /// FixedU32::[wrapping\_from\_num][FixedU32::wrapping_from_num]. /// /// # Panics /// /// For floating-point numbers, panics if the value is not [finite]. /// /// # Examples /// /// ```rust /// use fixed::types::{I4F4, I16F16}; /// use fixed::Wrapping; /// /// // 0x1234.5678 wraps into 0x4.5 /// let src = I16F16::from_bits(0x1234_5678); /// let dst = Wrapping::::from_num(src); /// assert_eq!(dst, Wrapping(I4F4::from_bits(0x45))); /// /// // 0x1234 wraps into 0x4.0 /// let src_int = 0x1234_i32; /// let dst_int = Wrapping::::from_num(src_int); /// assert_eq!(dst_int, Wrapping(I4F4::from_bits(0x40))); /// /// // 129.75 wrapped into 1.75 (binary 1.1100) /// let src_float = 129.75; /// let dst_float = Wrapping::::from_num(src_float); /// assert_eq!(dst_float, Wrapping(I4F4::from_bits(0b11100))); /// ``` /// /// [`F128`]: crate::F128 /// [finite]: f64::is_finite #[inline] #[track_caller] pub fn from_num(src: Src) -> Wrapping { Wrapping(src.wrapping_to_fixed()) } /// Converts a fixed-point number to another number, wrapping the /// value on overflow. /// /// The other number can be: /// /// * Another fixed-point number. Any extra fractional bits are /// discarded, which rounds towards −∞. /// * An integer of type [`i8`], [`i16`], [`i32`], [`i64`], [`i128`], /// [`isize`], [`u8`], [`u16`], [`u32`], [`u64`], [`u128`], or /// [`usize`]. Any fractional bits are discarded, which rounds /// towards −∞. /// * A floating-point number of type /// [half]::[f16][half::f16], /// [half]::[bf16][half::bf16], [`f32`], [`f64`] or /// [`F128`]. For this conversion, the method rounds to the nearest, /// with ties rounding to even. /// * Any other type `Dst` for which [`FromFixed`] is /// implemented, in which case this method returns /// Dst::[wrapping\_from\_fixed][FromFixed::wrapping_from_fixed]\(self.0). /// /// See also FixedI32::[wrapping\_to\_num][FixedI32::wrapping_to_num] and /// FixedU32::[wrapping\_to\_num][FixedU32::wrapping_to_num]. /// /// # Examples /// /// ```rust /// use fixed::types::{I16F16, I2F6, I4F4}; /// use fixed::Wrapping; /// /// // conversion that fits /// let src = Wrapping(I4F4::from_num(1.75)); /// let expected = I16F16::from_num(1.75); /// assert_eq!(src.to_num::(), expected); /// /// // conversion that wraps /// let src = Wrapping(I4F4::MAX); /// let wrapped = I2F6::from_bits(I2F6::MAX.to_bits() << 2); /// assert_eq!(src.to_num::(), wrapped); /// ``` /// /// [`F128`]: crate::F128 #[inline] pub fn to_num(self) -> Dst { Dst::wrapping_from_fixed(self.0) } /// Parses a string slice containing binary digits to return a fixed-point number. /// /// Rounding is to the nearest, with ties rounded to even. /// /// See also /// FixedI32::[wrapping\_from\_str\_binary][FixedI32::wrapping_from_str_binary] /// and /// FixedU32::[wrapping\_from\_str\_binary][FixedU32::wrapping_from_str_binary]. /// /// # Examples /// /// ```rust /// use fixed::types::I8F8; /// use fixed::Wrapping; /// let check = Wrapping(I8F8::from_bits(0b1110001 << (8 - 1))); /// assert_eq!(Wrapping::::from_str_binary("101100111000.1"), Ok(check)); /// ``` #[inline] pub fn from_str_binary(src: &str) -> Result, ParseFixedError> { F::wrapping_from_str_binary(src).map(Wrapping) } /// Parses a string slice containing octal digits to return a fixed-point number. /// /// Rounding is to the nearest, with ties rounded to even. /// /// See also /// FixedI32::[wrapping\_from\_str\_octal][FixedI32::wrapping_from_str_octal] /// and /// FixedU32::[wrapping\_from\_str\_octal][FixedU32::wrapping_from_str_octal]. /// /// # Examples /// /// ```rust /// use fixed::types::I8F8; /// use fixed::Wrapping; /// let check = Wrapping(I8F8::from_bits(0o1654 << (8 - 3))); /// assert_eq!(Wrapping::::from_str_octal("7165.4"), Ok(check)); /// ``` #[inline] pub fn from_str_octal(src: &str) -> Result, ParseFixedError> { F::wrapping_from_str_octal(src).map(Wrapping) } /// Parses a string slice containing hexadecimal digits to return a fixed-point number. /// /// Rounding is to the nearest, with ties rounded to even. /// /// See also /// FixedI32::[wrapping\_from\_str\_hex][FixedI32::wrapping_from_str_hex] /// and /// FixedU32::[wrapping\_from\_str\_hex][FixedU32::wrapping_from_str_hex]. /// /// # Examples /// /// ```rust /// use fixed::types::I8F8; /// use fixed::Wrapping; /// let check = Wrapping(I8F8::from_bits(0xFFE)); /// assert_eq!(Wrapping::::from_str_hex("C0F.FE"), Ok(check)); /// ``` #[inline] pub fn from_str_hex(src: &str) -> Result, ParseFixedError> { F::wrapping_from_str_hex(src).map(Wrapping) } /// Parses an ASCII-byte slice containing decimal digits to return a fixed-point number. /// /// Rounding is to the nearest, with ties rounded to even. /// /// See also /// FixedI32::[wrapping\_from\_ascii][FixedI32::wrapping_from_ascii] /// and /// FixedU32::[wrapping\_from\_ascii][FixedU32::wrapping_from_ascii]. /// /// # Examples /// /// ```rust /// use fixed::types::I8F8; /// use fixed::Wrapping; /// // 16 + 3/4 = 16.75 /// let check = Wrapping(I8F8::from_bits((16 << 8) + (3 << 8) / 4)); /// assert_eq!(Wrapping::::from_ascii(b"16.75"), Ok(check)); /// ``` #[inline] pub fn from_ascii(src: &[u8]) -> Result, ParseFixedError> { F::wrapping_from_ascii(src).map(Wrapping) } /// Parses an ASCII-byte slice containing binary digits to return a fixed-point number. /// /// Rounding is to the nearest, with ties rounded to even. /// /// See also /// FixedI32::[wrapping\_from\_ascii\_binary][FixedI32::wrapping_from_ascii_binary] /// and /// FixedU32::[wrapping\_from\_ascii\_binary][FixedU32::wrapping_from_ascii_binary]. /// /// # Examples /// /// ```rust /// use fixed::types::I8F8; /// use fixed::Wrapping; /// let check = Wrapping(I8F8::from_bits(0b1110001 << (8 - 1))); /// assert_eq!(Wrapping::::from_ascii_binary(b"101100111000.1"), Ok(check)); /// ``` #[inline] pub fn from_ascii_binary(src: &[u8]) -> Result, ParseFixedError> { F::wrapping_from_ascii_binary(src).map(Wrapping) } /// Parses an ASCII-byte slice containing octal digits to return a fixed-point number. /// /// Rounding is to the nearest, with ties rounded to even. /// /// See also /// FixedI32::[wrapping\_from\_ascii\_octal][FixedI32::wrapping_from_ascii_octal] /// and /// FixedU32::[wrapping\_from\_ascii\_octal][FixedU32::wrapping_from_ascii_octal]. /// /// # Examples /// /// ```rust /// use fixed::types::I8F8; /// use fixed::Wrapping; /// let check = Wrapping(I8F8::from_bits(0o1654 << (8 - 3))); /// assert_eq!(Wrapping::::from_ascii_octal(b"7165.4"), Ok(check)); /// ``` #[inline] pub fn from_ascii_octal(src: &[u8]) -> Result, ParseFixedError> { F::wrapping_from_ascii_octal(src).map(Wrapping) } /// Parses an ASCII-byte slice containing hexadecimal digits to return a fixed-point number. /// /// Rounding is to the nearest, with ties rounded to even. /// /// See also /// FixedI32::[wrapping\_from\_ascii\_hex][FixedI32::wrapping_from_ascii_hex] /// and /// FixedU32::[wrapping\_from\_ascii\_hex][FixedU32::wrapping_from_ascii_hex]. /// /// # Examples /// /// ```rust /// use fixed::types::I8F8; /// use fixed::Wrapping; /// let check = Wrapping(I8F8::from_bits(0xFFE)); /// assert_eq!(Wrapping::::from_ascii_hex(b"C0F.FE"), Ok(check)); /// ``` #[inline] pub fn from_ascii_hex(src: &[u8]) -> Result, ParseFixedError> { F::wrapping_from_ascii_hex(src).map(Wrapping) } /// Returns the integer part. /// /// Note that since the numbers are stored in two’s complement, /// negative numbers with non-zero fractional parts will be /// rounded towards −∞, except in the case where there are no /// integer bits, for example for the type /// [Wrapping]<[I0F16]>, where the return value /// is always zero. /// /// See also FixedI32::[int][FixedI32::int] and /// FixedU32::[int][FixedU32::int]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// assert_eq!(Wrapping(I16F16::from_num(12.25)).int(), Wrapping(I16F16::from_num(12))); /// assert_eq!(Wrapping(I16F16::from_num(-12.25)).int(), Wrapping(I16F16::from_num(-13))); /// ``` /// /// [I0F16]: crate::types::I0F16 #[inline] #[must_use] pub fn int(self) -> Wrapping { Wrapping(self.0.int()) } /// Returns the fractional part. /// /// Note that since the numbers are stored in two’s complement, /// the returned fraction will be non-negative for negative /// numbers, except in the case where there are no integer bits, /// for example for the type /// [Wrapping]<[I0F16]>, /// where the return value is always equal to `self`. /// /// See also FixedI32::[frac][FixedI32::frac] and /// FixedU32::[frac][FixedU32::frac]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// assert_eq!(Wrapping(I16F16::from_num(12.25)).frac(), Wrapping(I16F16::from_num(0.25))); /// assert_eq!(Wrapping(I16F16::from_num(-12.25)).frac(), Wrapping(I16F16::from_num(0.75))); /// ``` /// /// [I0F16]: crate::types::I0F16 #[inline] #[must_use] pub fn frac(self) -> Wrapping { Wrapping(self.0.frac()) } /// Rounds to the next integer towards 0. /// /// See also /// FixedI32::[round\_to\_zero][FixedI32::round_to_zero] and /// FixedU32::[round\_to\_zero][FixedU32::round_to_zero]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let three = Wrapping(I16F16::from_num(3)); /// assert_eq!(Wrapping(I16F16::from_num(3.9)).round_to_zero(), three); /// assert_eq!(Wrapping(I16F16::from_num(-3.9)).round_to_zero(), -three); /// ``` #[inline] #[must_use] pub fn round_to_zero(self) -> Wrapping { Wrapping(self.0.round_to_zero()) } /// Wrapping ceil. Rounds to the next integer towards +∞, wrapping /// on overflow. /// /// See also /// FixedI32::[wrapping\_ceil][FixedI32::wrapping_ceil] and /// FixedU32::[wrapping\_ceil][FixedU32::wrapping_ceil]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let two_half = Wrapping(I16F16::from_num(5) / 2); /// assert_eq!(two_half.ceil(), Wrapping(I16F16::from_num(3))); /// assert_eq!(Wrapping(I16F16::MAX).ceil(), Wrapping(I16F16::MIN)); /// ``` #[inline] #[must_use] pub fn ceil(self) -> Wrapping { Wrapping(self.0.wrapping_ceil()) } /// Wrapping floor. Rounds to the next integer towards −∞, /// wrapping on overflow. /// /// Overflow can only occur for signed numbers with zero integer /// bits. /// /// See also /// FixedI32::[wrapping\_floor][FixedI32::wrapping_floor] and /// FixedU32::[wrapping\_floor][FixedU32::wrapping_floor]. /// /// # Examples /// /// ```rust /// use fixed::types::{I0F32, I16F16}; /// use fixed::Wrapping; /// let two_half = Wrapping(I16F16::from_num(5) / 2); /// assert_eq!(two_half.floor(), Wrapping(I16F16::from_num(2))); /// assert_eq!(Wrapping(I0F32::MIN).floor(), Wrapping(I0F32::ZERO)); /// ``` #[inline] #[must_use] pub fn floor(self) -> Wrapping { Wrapping(self.0.wrapping_floor()) } /// Wrapping round. Rounds to the next integer to the nearest, /// with ties rounded away from zero, and wrapping on overflow. /// /// See also /// FixedI32::[wrapping\_round][FixedI32::wrapping_round] and /// FixedU32::[wrapping\_round][FixedU32::wrapping_round]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let two_half = Wrapping(I16F16::from_num(5) / 2); /// assert_eq!(two_half.round(), Wrapping(I16F16::from_num(3))); /// assert_eq!((-two_half).round(), Wrapping(I16F16::from_num(-3))); /// assert_eq!(Wrapping(I16F16::MAX).round(), Wrapping(I16F16::MIN)); /// ``` #[inline] #[must_use] pub fn round(self) -> Wrapping { Wrapping(self.0.wrapping_round()) } /// Wrapping round. Rounds to the next integer to the nearest, with ties /// rounded to even, and wrapping on overflow. /// /// See also /// FixedI32::[wrapping\_round\_ties\_even][FixedI32::wrapping_round_ties_even] /// and /// FixedU32::[wrapping\_round\_ties\_even][FixedU32::wrapping_round_ties_even]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let two_half = Wrapping(I16F16::from_num(2.5)); /// assert_eq!(two_half.round_ties_even(), Wrapping(I16F16::from_num(2))); /// let three_half = Wrapping(I16F16::from_num(3.5)); /// assert_eq!(three_half.round_ties_even(), Wrapping(I16F16::from_num(4))); /// let max = Wrapping(I16F16::MAX); /// assert_eq!(max.round_ties_even(), Wrapping(I16F16::MIN)); /// ``` #[inline] #[must_use] pub fn round_ties_even(self) -> Wrapping { Wrapping(self.0.wrapping_round_ties_even()) } /// Returns the number of ones in the binary representation. /// /// See also FixedI32::[count\_ones][FixedI32::count_ones] and /// FixedU32::[count\_ones][FixedU32::count_ones]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let w = Wrapping(I16F16::from_bits(0x00FF_FF00)); /// assert_eq!(w.count_ones(), w.0.count_ones()); /// ``` #[inline] #[doc(alias("popcount", "popcnt"))] pub fn count_ones(self) -> u32 { self.0.count_ones() } /// Returns the number of zeros in the binary representation. /// /// See also FixedI32::[count\_zeros][FixedI32::count_zeros] /// and FixedU32::[count\_zeros][FixedU32::count_zeros]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let w = Wrapping(I16F16::from_bits(0x00FF_FF00)); /// assert_eq!(w.count_zeros(), w.0.count_zeros()); /// ``` #[inline] pub fn count_zeros(self) -> u32 { self.0.count_zeros() } /// Returns the number of leading ones in the binary representation. /// /// See also FixedI32::[leading\_ones][FixedI32::leading_ones] /// and FixedU32::[leading\_ones][FixedU32::leading_ones]. /// /// # Examples /// /// ```rust /// use fixed::types::U16F16; /// use fixed::Wrapping; /// let w = Wrapping(U16F16::from_bits(0xFF00_00FF)); /// assert_eq!(w.leading_ones(), w.0.leading_ones()); /// ``` #[inline] pub fn leading_ones(self) -> u32 { self.0.leading_ones() } /// Returns the number of leading zeros in the binary representation. /// /// See also /// FixedI32::[leading\_zeros][FixedI32::leading_zeros] and /// FixedU32::[leading\_zeros][FixedU32::leading_zeros]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let w = Wrapping(I16F16::from_bits(0x00FF_FF00)); /// assert_eq!(w.leading_zeros(), w.0.leading_zeros()); /// ``` #[inline] pub fn leading_zeros(self) -> u32 { self.0.leading_zeros() } /// Returns the number of trailing ones in the binary representation. /// /// See also /// FixedI32::[trailing\_ones][FixedI32::trailing_ones] and /// FixedU32::[trailing\_ones][FixedU32::trailing_ones]. /// /// # Examples /// /// ```rust /// use fixed::types::U16F16; /// use fixed::Wrapping; /// let w = Wrapping(U16F16::from_bits(0xFF00_00FF)); /// assert_eq!(w.trailing_ones(), w.0.trailing_ones()); /// ``` #[inline] pub fn trailing_ones(self) -> u32 { self.0.trailing_ones() } /// Returns the number of trailing zeros in the binary representation. /// /// See also /// FixedI32::[trailing\_zeros][FixedI32::trailing_zeros] and /// FixedU32::[trailing\_zeros][FixedU32::trailing_zeros]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let w = Wrapping(I16F16::from_bits(0x00FF_FF00)); /// assert_eq!(w.trailing_zeros(), w.0.trailing_zeros()); /// ``` #[inline] pub fn trailing_zeros(self) -> u32 { self.0.trailing_zeros() } /// Returns the square root. /// /// See also /// FixedI32::[wrapping\_sqrt][FixedI32::wrapping_sqrt] and /// FixedU32::[wrapping\_sqrt][FixedU32::wrapping_sqrt]. /// /// # Panics /// /// Panics if the number is negative. /// /// # Examples /// /// ```rust /// use fixed::types::I0F32; /// use fixed::Wrapping; /// assert_eq!(Wrapping(I0F32::lit("0b0.0001")).sqrt().0, I0F32::lit("0b0.01")); /// /// // This method handles the overflow corner case. /// let w = Wrapping(I0F32::from_num(0.25)); /// assert_eq!(w.sqrt().0, -0.5); /// ``` #[inline] #[track_caller] pub fn sqrt(self) -> Self { Wrapping(self.0.wrapping_sqrt()) } /// Integer base-2 logarithm, rounded down. /// /// See also FixedI32::[int\_log2][FixedI32::int_log2] and /// FixedU32::[int\_log2][FixedU32::int_log2]. /// /// # Panics /// /// Panics if the fixed-point number is ≤ 0. #[inline] #[track_caller] #[doc(alias("ilog2"))] pub fn int_log2(self) -> i32 { self.0.int_log2() } /// Integer base-10 logarithm, rounded down. /// /// See also FixedI32::[int\_log10][FixedI32::int_log10] and /// FixedU32::[int\_log10][FixedU32::int_log10]. /// /// # Panics /// /// Panics if the fixed-point number is ≤ 0. #[inline] #[track_caller] #[doc(alias("ilog10"))] pub fn int_log10(self) -> i32 { self.0.int_log10() } /// Integer logarithm to the specified base, rounded down. /// /// See also FixedI32::[int\_log][FixedI32::int_log] and /// FixedU32::[int\_log][FixedU32::int_log]. /// /// # Panics /// /// Panics if the fixed-point number is ≤ 0 or if the base is < 2. #[inline] #[track_caller] #[doc(alias("ilog"))] pub fn int_log(self, base: u32) -> i32 { self.0.int_log(base) } /// Reverses the order of the bits of the fixed-point number. /// /// See also FixedI32::[reverse\_bits][FixedI32::reverse_bits] /// and FixedU32::[reverse\_bits][FixedU32::reverse_bits]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let i = I16F16::from_bits(0x1234_5678); /// assert_eq!(Wrapping(i).reverse_bits(), Wrapping(i.reverse_bits())); /// ``` #[inline] #[must_use = "this returns the result of the operation, without modifying the original"] pub fn reverse_bits(self) -> Wrapping { Wrapping(self.0.reverse_bits()) } /// Shifts to the left by `n` bits, wrapping the truncated bits to the right end. /// /// See also FixedI32::[rotate\_left][FixedI32::rotate_left] /// and FixedU32::[rotate\_left][FixedU32::rotate_left]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let i = I16F16::from_bits(0x00FF_FF00); /// assert_eq!(Wrapping(i).rotate_left(12), Wrapping(i.rotate_left(12))); /// ``` #[inline] #[must_use = "this returns the result of the operation, without modifying the original"] pub fn rotate_left(self, n: u32) -> Wrapping { Wrapping(self.0.rotate_left(n)) } /// Shifts to the right by `n` bits, wrapping the truncated bits to the left end. /// /// See also FixedI32::[rotate\_right][FixedI32::rotate_right] /// and FixedU32::[rotate\_right][FixedU32::rotate_right]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let i = I16F16::from_bits(0x00FF_FF00); /// assert_eq!(Wrapping(i).rotate_right(12), Wrapping(i.rotate_right(12))); /// ``` #[inline] #[must_use = "this returns the result of the operation, without modifying the original"] pub fn rotate_right(self, n: u32) -> Wrapping { Wrapping(self.0.rotate_right(n)) } /// Returns [`true`] if the number is zero. /// /// See also FixedI32::[is\_zero][FixedI32::is_zero] and /// FixedU32::[is\_zero][FixedU32::is_zero]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// assert!(Wrapping(I16F16::ZERO).is_zero()); /// assert!(!Wrapping(I16F16::from_num(4.3)).is_zero()); /// ``` #[inline] pub fn is_zero(self) -> bool { self.0.is_zero() } /// Returns the distance from `self` to `other`. /// /// See also /// FixedI32::[wrapping\_dist][FixedI32::wrapping_dist] and /// FixedU32::[wrapping\_dist][FixedU32::wrapping_dist]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// type Wr = Wrapping; /// assert_eq!(Wr::from_num(-1).dist(Wr::from_num(4)), Wr::from_num(5)); /// assert_eq!(Wr::MIN.dist(Wr::MAX), -Wr::DELTA); /// ``` #[inline] #[must_use = "this returns the result of the operation, without modifying the original"] pub fn dist(self, other: Wrapping) -> Wrapping { Wrapping(self.0.wrapping_dist(other.0)) } /// Returns the mean of `self` and `other`. /// /// See also FixedI32::[mean][FixedI32::mean] and /// FixedU32::[mean][FixedU32::mean]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let three = Wrapping(I16F16::from_num(3)); /// let four = Wrapping(I16F16::from_num(4)); /// assert_eq!(three.mean(four), Wrapping(I16F16::from_num(3.5))); /// assert_eq!(three.mean(-four), Wrapping(I16F16::from_num(-0.5))); /// ``` #[inline] #[must_use = "this returns the result of the operation, without modifying the original"] pub fn mean(self, other: Wrapping) -> Wrapping { Wrapping(self.0.mean(other.0)) } /// Compute the hypotenuse of a right triange. /// /// See also /// FixedI32::[wrapping\_hypot][FixedI32::wrapping_hypot] and /// FixedU32::[wrapping\_hypot][FixedU32::wrapping_hypot]. /// /// # Examples /// /// ```rust /// use fixed::types::I8F8; /// use fixed::Wrapping; /// type Wr = Wrapping; /// // hypot(3, 4) == 5 /// assert_eq!(Wr::from_num(3).hypot(Wr::from_num(4)), Wr::from_num(5)); /// // hypot(88, 105) == 137, which wraps to -119 /// assert_eq!(Wr::from_num(88).hypot(Wr::from_num(105)), Wr::from_num(-119)); /// ``` #[inline] #[must_use = "this returns the result of the operation, without modifying the original"] pub fn hypot(self, other: Wrapping) -> Wrapping { Wrapping(self.0.wrapping_hypot(other.0)) } /// Returns the reciprocal (inverse), 1/`self`. /// /// See also /// FixedI32::[wrapping\_recip][FixedI32::wrapping_recip] and /// FixedU32::[wrapping\_recip][FixedU32::wrapping_recip]. /// /// # Panics /// /// Panics if `self` is zero. /// /// # Examples /// /// ```rust /// use fixed::types::I8F24; /// use fixed::Wrapping; /// let quarter = Wrapping(I8F24::from_num(0.25)); /// let frac_1_512 = Wrapping(I8F24::ONE / 512); /// assert_eq!(quarter.recip(), Wrapping(I8F24::from_num(4))); /// assert_eq!(frac_1_512.recip(), Wrapping(I8F24::ZERO)); /// ``` #[inline] #[track_caller] #[must_use] pub fn recip(self) -> Wrapping { Wrapping(self.0.wrapping_recip()) } /// Returns the next multiple of `other`. /// /// See also /// FixedI32::[wrapping\_next\_multiple\_of][FixedI32::wrapping_next_multiple_of] /// and /// FixedU32::[wrapping\_next\_multiple\_of][FixedU32::wrapping_next_multiple_of]. /// /// # Panics /// /// Panics if `other` is zero. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let one_point_5 = Wrapping::::from_num(1.5); /// let four = Wrapping::::from_num(4); /// let four_point_5 = Wrapping::::from_num(4.5); /// assert_eq!(four.next_multiple_of(one_point_5), four_point_5); /// /// let max = Wrapping::::MAX; /// let max_minus_delta = max - Wrapping::::DELTA; /// assert_eq!(max.next_multiple_of(max_minus_delta), max_minus_delta * 2); /// ``` #[inline] #[track_caller] #[must_use] pub fn next_multiple_of(self, other: Wrapping) -> Wrapping { Wrapping(self.0.wrapping_next_multiple_of(other.0)) } /// Multiply and add. Returns `self` × `mul` + `add`. /// /// See also /// FixedI32::[wrapping\_mul\_add][FixedI32::wrapping_mul_add] /// and /// FixedU32::[wrapping\_mul\_add][FixedU32::wrapping_mul_add]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let half = Wrapping(I16F16::from_num(0.5)); /// let three = Wrapping(I16F16::from_num(3)); /// let four = Wrapping(I16F16::from_num(4)); /// let max = Wrapping(I16F16::MAX); /// assert_eq!(three.mul_add(half, four), Wrapping(I16F16::from_num(5.5))); /// assert_eq!(max.mul_add(three, max), max * 4); /// ``` #[inline] #[must_use = "this returns the result of the operation, without modifying the original"] pub fn mul_add(self, mul: Wrapping, add: Wrapping) -> Wrapping { Wrapping(self.0.wrapping_mul_add(mul.0, add.0)) } /// Adds `self` to the product `a` × `b`. /// /// See also /// FixedI32::[wrapping\_add\_prod][FixedI32::wrapping_add_prod] /// and /// FixedU32::[wrapping\_add\_prod][FixedU32::wrapping_add_prod]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let half = Wrapping(I16F16::from_num(0.5)); /// let three = Wrapping(I16F16::from_num(3)); /// let four = Wrapping(I16F16::from_num(4)); /// let max = Wrapping(I16F16::MAX); /// assert_eq!(four.add_prod(three, half), Wrapping(I16F16::from_num(5.5))); /// assert_eq!(max.add_prod(max, three), max * 4); /// ``` #[inline] #[must_use] pub fn add_prod(self, a: Wrapping, b: Wrapping) -> Wrapping { Wrapping(self.0.wrapping_add_prod(a.0, b.0)) } /// Multiply and accumulate. Adds (`a` × `b`) to `self`. /// /// See also /// FixedI32::[wrapping\_mul\_acc][FixedI32::wrapping_mul_acc] /// and /// FixedU32::[wrapping\_mul\_acc][FixedU32::wrapping_mul_acc]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let mut acc = Wrapping(I16F16::from_num(3)); /// acc.mul_acc(Wrapping(I16F16::from_num(4)), Wrapping(I16F16::from_num(0.5))); /// assert_eq!(acc, Wrapping(I16F16::from_num(5))); /// /// acc = Wrapping(I16F16::MAX); /// acc.mul_acc(Wrapping(I16F16::MAX), Wrapping(I16F16::from_num(3))); /// assert_eq!(acc, Wrapping(I16F16::MAX) * 4); /// ``` #[inline] pub fn mul_acc(&mut self, a: Wrapping, b: Wrapping) { self.0.wrapping_mul_acc(a.0, b.0); } /// Euclidean division. /// /// See also /// FixedI32::[wrapping\_div\_euclid][FixedI32::wrapping_div_euclid] /// and /// FixedU32::[wrapping\_div\_euclid][FixedU32::wrapping_div_euclid]. /// /// # Panics /// /// Panics if the divisor is zero. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let num = Wrapping(I16F16::from_num(7.5)); /// let den = Wrapping(I16F16::from_num(2)); /// assert_eq!(num.div_euclid(den), Wrapping(I16F16::from_num(3))); /// let quarter = Wrapping(I16F16::from_num(0.25)); /// let check = (Wrapping(I16F16::MAX) * 4i32).round_to_zero(); /// assert_eq!(Wrapping(I16F16::MAX).div_euclid(quarter), check); /// ``` #[inline] #[track_caller] #[must_use = "this returns the result of the operation, without modifying the original"] pub fn div_euclid(self, divisor: Wrapping) -> Wrapping { Wrapping(self.0.wrapping_div_euclid(divisor.0)) } /// Remainder for Euclidean division. /// /// See also FixedI32::[rem\_euclid][FixedI32::rem_euclid] and /// FixedU32::[rem\_euclid][FixedU32::rem_euclid]. /// /// # Panics /// /// Panics if the divisor is zero. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let num = Wrapping(I16F16::from_num(7.5)); /// let den = Wrapping(I16F16::from_num(2)); /// assert_eq!(num.rem_euclid(den), Wrapping(I16F16::from_num(1.5))); /// assert_eq!((-num).rem_euclid(den), Wrapping(I16F16::from_num(0.5))); /// ``` #[inline] #[track_caller] #[must_use = "this returns the result of the operation, without modifying the original"] pub fn rem_euclid(self, divisor: Wrapping) -> Wrapping { Wrapping(self.0.rem_euclid(divisor.0)) } /// Euclidean division by an integer. /// /// See also /// FixedI32::[wrapping\_div\_euclid\_int][FixedI32::wrapping_div_euclid_int] /// and /// FixedU32::[wrapping\_div\_euclid\_int][FixedU32::wrapping_div_euclid_int]. /// /// # Panics /// /// Panics if the divisor is zero. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let num = Wrapping(I16F16::from_num(7.5)); /// assert_eq!(num.div_euclid_int(2), Wrapping(I16F16::from_num(3))); /// let min = Wrapping(I16F16::MIN); /// assert_eq!(min.div_euclid_int(-1), min); /// ``` #[inline] #[track_caller] #[must_use = "this returns the result of the operation, without modifying the original"] pub fn div_euclid_int(self, divisor: F::Bits) -> Wrapping { Wrapping(self.0.wrapping_div_euclid_int(divisor)) } /// Remainder for Euclidean division. /// /// See also /// FixedI32::[wrapping\_rem\_euclid\_int][FixedI32::wrapping_rem_euclid_int] /// and /// FixedU32::[wrapping\_rem\_euclid\_int][FixedU32::wrapping_rem_euclid_int]. /// /// # Panics /// /// Panics if the divisor is zero. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// let num = Wrapping(I16F16::from_num(7.5)); /// assert_eq!(num.rem_euclid_int(2), Wrapping(I16F16::from_num(1.5))); /// assert_eq!((-num).rem_euclid_int(2), Wrapping(I16F16::from_num(0.5))); /// ``` #[inline] #[track_caller] #[must_use = "this returns the result of the operation, without modifying the original"] pub fn rem_euclid_int(self, divisor: F::Bits) -> Wrapping { Wrapping(self.0.wrapping_rem_euclid_int(divisor)) } /// Unbounded shift left. Computes `self << rhs`, without bounding the value /// of `rhs`. /// /// See also /// FixedI32::[unbounded\_shl][FixedI32::unbounded_shl] and /// FixedU32::[unbounded\_shl][FixedU32::unbounded_shl]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// type Wr = Wrapping; /// let num = Wrapping(I16F16::from_num(1.5)); /// assert_eq!(num.unbounded_shl(5), num << 5); /// assert_eq!(num.unbounded_shl(32), Wr::ZERO); /// ``` #[must_use = "this returns the result of the operation, without modifying the original"] #[inline] pub fn unbounded_shl(self, rhs: u32) -> Wrapping { Wrapping(self.0.unbounded_shl(rhs)) } /// Unbounded shift right. Computes `self >> rhs`, without bounding the /// value of `rhs`. /// /// See also /// FixedI32::[unbounded\_shr][FixedI32::unbounded_shr] and /// FixedU32::[unbounded\_shr][FixedU32::unbounded_shr]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// type Wr = Wrapping; /// let num = Wrapping(I16F16::from_num(1.5)); /// assert_eq!(num.unbounded_shr(5), num >> 5); /// assert_eq!(num.unbounded_shr(32), Wr::ZERO); /// assert_eq!((-num).unbounded_shr(5), (-num) >> 5); /// assert_eq!((-num).unbounded_shr(32), -Wr::DELTA); /// ``` #[must_use = "this returns the result of the operation, without modifying the original"] #[inline] pub fn unbounded_shr(self, rhs: u32) -> Wrapping { Wrapping(self.0.unbounded_shr(rhs)) } /// Linear interpolation between `start` and `end`. /// /// See also /// FixedI32::[wrapping\_lerp][FixedI32::wrapping_lerp] and /// FixedU32::[wrapping\_lerp][FixedU32::wrapping_lerp]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// type Wr = Wrapping; /// assert_eq!(Wr::from_num(0.5).lerp(Wr::ZERO, Wr::MAX), Wr::MAX / 2); /// assert_eq!(Wr::from_num(1.5).lerp(Wr::ZERO, Wr::MAX), Wr::MAX + Wr::MAX / 2); /// ``` #[inline] #[must_use] pub fn lerp(self, start: Wrapping, end: Wrapping) -> Wrapping { Wrapping(self.0.wrapping_lerp(start.0, end.0)) } /// Inverse linear interpolation between `start` and `end`. /// /// See also /// FixedI32::[wrapping\_inv\_lerp][FixedI32::wrapping_inv_lerp] and /// FixedU32::[wrapping\_inv\_lerp][FixedU32::wrapping_inv_lerp]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// type Wr = Wrapping; /// assert_eq!( /// Wr::from_num(25).inv_lerp(Wr::from_num(20), Wr::from_num(40)), /// Wr::from_num(0.25) /// ); /// ``` #[inline] #[must_use] pub fn inv_lerp(self, start: Wrapping, end: Wrapping) -> Wrapping { Wrapping(self.0.wrapping_inv_lerp(start.0, end.0)) } /// Wrapping round. Rounds to the next integer to the nearest, with ties /// rounded to even, and wrapping on overflow. #[inline] #[must_use] #[deprecated(since = "1.28.0", note = "renamed to `round_ties_even`")] pub fn round_ties_to_even(self) -> Wrapping { self.round_ties_even() } } impl Wrapping { /// Returns the bit pattern of `self` reinterpreted as an unsigned /// fixed-point number of the same size. /// /// See also FixedI32::[cast\_unsigned][FixedU32::cast_unsigned]. /// /// # Examples /// /// ```rust /// use fixed::types::{I16F16, U16F16}; /// use fixed::Wrapping; /// /// let n = Wrapping(-I16F16::DELTA); /// assert_eq!(n.cast_unsigned(), Wrapping(U16F16::MAX)); /// ``` #[must_use] #[inline] pub fn cast_unsigned(self) -> Wrapping { Wrapping(self.0.cast_unsigned()) } /// Returns the number of bits required to represent the value. /// /// The number of bits required includes an initial one for /// negative numbers, and an initial zero for non-negative /// numbers. /// /// See also FixedI32::[signed\_bits][FixedI32::signed_bits]. /// /// # Examples /// /// ```rust /// use fixed::types::I4F4; /// use fixed::Wrapping; /// assert_eq!(Wrapping(I4F4::from_num(-3)).signed_bits(), 7); // “_101.0000” /// assert_eq!(Wrapping(I4F4::from_num(-1)).signed_bits(), 5); // “___1.0000” /// assert_eq!(Wrapping(I4F4::from_num(-0.0625)).signed_bits(), 1); // “____.___1” /// assert_eq!(Wrapping(I4F4::from_num(0)).signed_bits(), 1); // “____.___0” /// assert_eq!(Wrapping(I4F4::from_num(0.0625)).signed_bits(), 2); // “____.__01” /// assert_eq!(Wrapping(I4F4::from_num(1)).signed_bits(), 6); // “__01.0000” /// assert_eq!(Wrapping(I4F4::from_num(3)).signed_bits(), 7); // “_011.0000” /// ``` #[inline] pub fn signed_bits(self) -> u32 { self.0.signed_bits() } /// Returns [`true`] if the number is > 0. /// /// See also FixedI32::[is\_positive][FixedI32::is_positive]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// assert!(Wrapping(I16F16::from_num(4.3)).is_positive()); /// assert!(!Wrapping(I16F16::ZERO).is_positive()); /// assert!(!Wrapping(I16F16::from_num(-4.3)).is_positive()); /// ``` #[inline] pub fn is_positive(self) -> bool { self.0.is_positive() } /// Returns [`true`] if the number is < 0. /// /// See also FixedI32::[is\_negative][FixedI32::is_negative]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// assert!(!Wrapping(I16F16::from_num(4.3)).is_negative()); /// assert!(!Wrapping(I16F16::ZERO).is_negative()); /// assert!(Wrapping(I16F16::from_num(-4.3)).is_negative()); /// ``` #[inline] pub fn is_negative(self) -> bool { self.0.is_negative() } /// Wrapping absolute value. Returns the absolute value, wrapping /// on overflow. /// /// Overflow can only occur when trying to find the absolute value /// of the minimum value. /// /// See also FixedI32::[wrapping\_abs][FixedI32::wrapping_abs]. /// /// # Examples /// /// ```rust /// use fixed::types::I16F16; /// use fixed::Wrapping; /// assert_eq!(Wrapping(I16F16::from_num(-5)).abs(), Wrapping(I16F16::from_num(5))); /// assert_eq!(Wrapping(I16F16::MIN).abs(), Wrapping(I16F16::MIN)); /// ``` #[inline] #[must_use] pub fn abs(self) -> Wrapping { Wrapping(self.0.wrapping_abs()) } /// Returns a number representing the sign of `self`. /// /// # Warning /// /// Using this method when 1 and −1 cannot be represented is /// almost certainly a bug, however, this is allowed and gives the /// following wrapped results. /// /// * When there are no integer bits, for example for the type /// [Wrapping]<[I0F16]>, the return value /// is always zero. /// * When there is one integer bit, for example for the type /// [Wrapping]<[I1F15]>, the return value /// is zero when `self` is zero, and −1 otherwise. This means /// that for a positive number, −1 is returned, because +1 /// does not fit and is wrapped to −1. /// /// See also /// FixedI32::[wrapping\_signum][FixedI32::wrapping_signum]. /// /// # Examples /// /// ```rust /// use fixed::types::{I0F32, I1F31, I16F16}; /// use fixed::Wrapping; /// /// assert_eq!(Wrapping(::from_num(-3.9)).signum(), Wrapping(I16F16::NEG_ONE)); /// assert_eq!(Wrapping(::ZERO).signum(), Wrapping(I16F16::ZERO)); /// assert_eq!(Wrapping(::from_num(3.9)).signum(), Wrapping(I16F16::ONE)); /// /// assert_eq!(Wrapping(::from_num(0.5)).signum(), Wrapping(I1F31::NEG_ONE)); /// assert_eq!(Wrapping(::from_num(0.25)).signum(), Wrapping(I0F32::ZERO)); /// assert_eq!(Wrapping(::from_num(-0.5)).signum(), Wrapping(I0F32::ZERO)); /// ``` /// /// [I0F16]: crate::types::I0F16 /// [I1F15]: crate::types::I1F15 #[inline] #[must_use] pub fn signum(self) -> Wrapping { Wrapping(self.0.wrapping_signum()) } /// Addition with an unsigned fixed-point number. /// /// See also /// FixedI32::[wrapping\_add\_unsigned][FixedI32::wrapping_add_unsigned]. /// /// # Examples /// /// ```rust /// use fixed::types::{I16F16, U16F16}; /// use fixed::Wrapping; /// assert_eq!( /// Wrapping::::from_num(-5).add_unsigned(U16F16::from_num(3)), /// Wrapping::::from_num(-2) /// ); /// assert_eq!( /// Wrapping::::ZERO.add_unsigned(U16F16::MAX), /// -Wrapping::::DELTA /// ); /// ``` #[inline] #[must_use] pub fn add_unsigned(self, rhs: F::Unsigned) -> Wrapping { Wrapping(self.0.wrapping_add_unsigned(rhs)) } /// Subtraction with an unsigned fixed-point number. /// /// See also /// FixedI32::[wrapping\_sub\_unsigned][FixedI32::wrapping_sub_unsigned]. /// /// # Examples /// /// ```rust /// use fixed::types::{I16F16, U16F16}; /// use fixed::Wrapping; /// assert_eq!( /// Wrapping::::from_num(3).sub_unsigned(U16F16::from_num(5)), /// Wrapping::::from_num(-2) /// ); /// assert_eq!( /// Wrapping::::ZERO.sub_unsigned(U16F16::MAX), /// Wrapping::::DELTA /// ); /// ``` #[inline] #[must_use] pub fn sub_unsigned(self, rhs: F::Unsigned) -> Wrapping { Wrapping(self.0.wrapping_sub_unsigned(rhs)) } } impl Wrapping { /// Returns the bit pattern of `self` reinterpreted as a signed fixed-point /// number of the same size. /// /// See also FixedU32::[cast\_signed][FixedU32::cast_signed]. /// /// # Examples /// /// ```rust /// use fixed::types::{I16F16, U16F16}; /// use fixed::Wrapping; /// /// let n = Wrapping(U16F16::MAX); /// assert_eq!(n.cast_signed(), Wrapping(-I16F16::DELTA)); /// ``` #[must_use] #[inline] pub fn cast_signed(self) -> Wrapping { Wrapping(self.0.cast_signed()) } /// Returns the number of bits required to represent the value. /// /// See also /// FixedU32::[significant\_bits][FixedU32::significant_bits]. /// /// # Examples /// /// ```rust /// use fixed::types::U4F4; /// use fixed::Wrapping; /// assert_eq!(Wrapping(U4F4::from_num(0)).significant_bits(), 0); // “____.____” /// assert_eq!(Wrapping(U4F4::from_num(0.0625)).significant_bits(), 1); // “____.___1” /// assert_eq!(Wrapping(U4F4::from_num(1)).significant_bits(), 5); // “___1.0000” /// assert_eq!(Wrapping(U4F4::from_num(3)).significant_bits(), 6); // “__11.0000” /// ``` #[inline] pub fn significant_bits(self) -> u32 { self.0.significant_bits() } /// Returns [`true`] if the fixed-point number is /// 2k for some integer k. /// /// See also /// FixedU32::[is\_power\_of\_two][FixedU32::is_power_of_two]. /// /// # Examples /// /// ```rust /// use fixed::types::U16F16; /// use fixed::Wrapping; /// assert!(Wrapping(U16F16::from_num(0.5)).is_power_of_two()); /// assert!(Wrapping(U16F16::from_num(4)).is_power_of_two()); /// assert!(!Wrapping(U16F16::from_num(5)).is_power_of_two()); /// ``` #[inline] pub fn is_power_of_two(self) -> bool { self.0.is_power_of_two() } /// Returns the highest one in the binary representation, or zero /// if `self` is zero. /// /// If `self` > 0, the highest one is equal to the largest power /// of two that is ≤ `self`. /// /// See also FixedU32::[highest\_one][FixedU32::highest_one]. /// /// # Examples /// /// ```rust /// use fixed::types::U16F16; /// use fixed::Wrapping; /// type T = Wrapping; /// assert_eq!(T::from_bits(0b11_0010).highest_one(), T::from_bits(0b10_0000)); /// assert_eq!(T::from_num(0.3).highest_one(), T::from_num(0.25)); /// assert_eq!(T::from_num(4).highest_one(), T::from_num(4)); /// assert_eq!(T::from_num(6.5).highest_one(), T::from_num(4)); /// assert_eq!(T::ZERO.highest_one(), T::ZERO); /// ``` #[inline] #[must_use] pub fn highest_one(self) -> Wrapping { Wrapping(self.0.highest_one()) } /// Returns the smallest power of two that is ≥ `self`. /// /// If the next power of two is too large to fit, it is wrapped to zero. /// /// See also /// FixedU32::[wrapping\_next\_power\_of\_two][FixedU32::wrapping_next_power_of_two]. /// /// # Examples /// /// ```rust /// use fixed::types::U16F16; /// use fixed::Wrapping; /// type T = Wrapping; /// assert_eq!(T::from_bits(0b11_0010).next_power_of_two(), T::from_bits(0b100_0000)); /// assert_eq!(T::from_num(0.3).next_power_of_two(), T::from_num(0.5)); /// assert_eq!(T::from_num(4).next_power_of_two(), T::from_num(4)); /// assert_eq!(T::from_num(6.5).next_power_of_two(), T::from_num(8)); /// // if the next power of two is too large, it is wrapped to zero /// assert_eq!(T::MAX.next_power_of_two(), T::ZERO); /// ``` #[inline] #[must_use] pub fn next_power_of_two(self) -> Wrapping { Wrapping(self.0.wrapping_next_power_of_two()) } /// Addition with an signed fixed-point number. /// /// See also /// FixedU32::[wrapping\_add\_signed][FixedU32::wrapping_add_signed]. /// /// # Examples /// /// ```rust /// use fixed::types::{I16F16, U16F16}; /// use fixed::Wrapping; /// assert_eq!( /// Wrapping::::from_num(5).add_signed(I16F16::from_num(-3)), /// Wrapping::::from_num(2) /// ); /// assert_eq!( /// Wrapping::::ZERO.add_signed(-I16F16::DELTA), /// Wrapping::::MAX /// ); /// ``` #[inline] #[must_use] pub fn add_signed(self, rhs: F::Signed) -> Wrapping { Wrapping(self.0.wrapping_add_signed(rhs)) } /// Subtraction with an signed fixed-point number. /// /// See also /// FixedU32::[wrapping\_sub\_signed][FixedU32::wrapping_sub_signed]. /// /// # Examples /// /// ```rust /// use fixed::types::{I16F16, U16F16}; /// use fixed::Wrapping; /// assert_eq!( /// Wrapping::::from_num(5).sub_signed(I16F16::from_num(-3)), /// Wrapping::::from_num(8) /// ); /// assert_eq!( /// Wrapping::::ZERO.sub_signed(I16F16::DELTA), /// Wrapping::::MAX /// ); /// ``` #[inline] #[must_use] pub fn sub_signed(self, rhs: F::Signed) -> Wrapping { Wrapping(self.0.wrapping_sub_signed(rhs)) } } impl Display for Wrapping { #[inline] fn fmt(&self, f: &mut Formatter) -> FmtResult { Display::fmt(&self.0, f) } } impl Debug for Wrapping { #[inline] fn fmt(&self, f: &mut Formatter) -> FmtResult { Debug::fmt(&self.0, f) } } impl Binary for Wrapping { #[inline] fn fmt(&self, f: &mut Formatter) -> FmtResult { Binary::fmt(&self.0, f) } } impl Octal for Wrapping { #[inline] fn fmt(&self, f: &mut Formatter) -> FmtResult { Octal::fmt(&self.0, f) } } impl LowerHex for Wrapping { #[inline] fn fmt(&self, f: &mut Formatter) -> FmtResult { LowerHex::fmt(&self.0, f) } } impl UpperHex for Wrapping { #[inline] fn fmt(&self, f: &mut Formatter) -> FmtResult { UpperHex::fmt(&self.0, f) } } impl LowerExp for Wrapping { #[inline] fn fmt(&self, f: &mut Formatter) -> FmtResult { LowerExp::fmt(&self.0, f) } } impl UpperExp for Wrapping { #[inline] fn fmt(&self, f: &mut Formatter) -> FmtResult { UpperExp::fmt(&self.0, f) } } impl From for Wrapping { /// Wraps a fixed-point number. #[inline] fn from(src: F) -> Wrapping { Wrapping(src) } } impl FromStr for Wrapping { type Err = ParseFixedError; /// Parses a string slice containing decimal digits to return a fixed-point number. /// /// Rounding is to the nearest, with ties rounded to even. #[inline] fn from_str(s: &str) -> Result { F::wrapping_from_str(s).map(Wrapping) } } macro_rules! op { ($wrapping:ident, $Op:ident $op:ident, $OpAssign:ident $op_assign:ident) => { impl $Op> for Wrapping { type Output = Wrapping; #[inline] fn $op(self, other: Wrapping) -> Wrapping { Wrapping((self.0).$wrapping(other.0)) } } impl $Op> for &Wrapping { type Output = Wrapping; #[inline] fn $op(self, other: Wrapping) -> Wrapping { Wrapping((self.0).$wrapping(other.0)) } } impl $Op<&Wrapping> for Wrapping { type Output = Wrapping; #[inline] fn $op(self, other: &Wrapping) -> Wrapping { Wrapping((self.0).$wrapping(other.0)) } } impl $Op<&Wrapping> for &Wrapping { type Output = Wrapping; #[inline] fn $op(self, other: &Wrapping) -> Wrapping { Wrapping((self.0).$wrapping(other.0)) } } impl $OpAssign> for Wrapping { #[inline] fn $op_assign(&mut self, other: Wrapping) { self.0 = (self.0).$wrapping(other.0); } } impl $OpAssign<&Wrapping> for Wrapping { #[inline] fn $op_assign(&mut self, other: &Wrapping) { self.0 = (self.0).$wrapping(other.0); } } impl $OpAssign for Wrapping { #[inline] fn $op_assign(&mut self, other: F) { self.0 = (self.0).$wrapping(other); } } impl $OpAssign<&F> for Wrapping { #[inline] fn $op_assign(&mut self, other: &F) { self.0 = (self.0).$wrapping(*other); } } }; } macro_rules! op_bitwise { ($Op:ident $op:ident, $OpAssign:ident $op_assign:ident) => { impl $Op> for Wrapping where F: $Op, { type Output = Wrapping; #[inline] fn $op(self, other: Wrapping) -> Wrapping { Wrapping((self.0).$op(other.0)) } } impl $Op> for &Wrapping where for<'a> &'a F: $Op, { type Output = Wrapping; #[inline] fn $op(self, other: Wrapping) -> Wrapping { Wrapping((self.0).$op(other.0)) } } impl $Op<&Wrapping> for Wrapping where for<'a> F: $Op<&'a F, Output = F>, { type Output = Wrapping; #[inline] fn $op(self, other: &Wrapping) -> Wrapping { Wrapping((self.0).$op(&other.0)) } } impl $Op<&Wrapping> for &Wrapping where for<'a, 'b> &'a F: $Op<&'b F, Output = F>, { type Output = Wrapping; #[inline] fn $op(self, other: &Wrapping) -> Wrapping { Wrapping((self.0).$op(&other.0)) } } impl $OpAssign> for Wrapping where F: $OpAssign, { #[inline] fn $op_assign(&mut self, other: Wrapping) { (self.0).$op_assign(other.0); } } impl $OpAssign<&Wrapping> for Wrapping where for<'a> F: $OpAssign<&'a F>, { #[inline] fn $op_assign(&mut self, other: &Wrapping) { (self.0).$op_assign(&other.0); } } impl $OpAssign for Wrapping where F: $OpAssign, { #[inline] fn $op_assign(&mut self, other: F) { (self.0).$op_assign(other); } } impl $OpAssign<&F> for Wrapping where for<'a> F: $OpAssign<&'a F>, { #[inline] fn $op_assign(&mut self, other: &F) { (self.0).$op_assign(other); } } }; } macro_rules! op_shift { ( $Op:ident $op:ident, $OpAssign:ident $op_assign:ident; $($Rhs:ident),* ) => { $( impl $Op<$Rhs> for Wrapping where F: $Op, { type Output = Wrapping; #[inline] fn $op(self, other: $Rhs) -> Wrapping { let nbits = size_of::() as u32 * 8; Wrapping((self.0).$op(other as u32 % nbits)) } } impl $Op<$Rhs> for &Wrapping where for<'a> &'a F: $Op, { type Output = Wrapping; #[inline] fn $op(self, other: $Rhs) -> Wrapping { let nbits = size_of::() as u32 * 8; Wrapping((self.0).$op(other as u32 % nbits)) } } impl $Op<&$Rhs> for Wrapping where F: $Op, { type Output = Wrapping; #[inline] fn $op(self, other: &$Rhs) -> Wrapping { let nbits = size_of::() as u32 * 8; Wrapping((self.0).$op(*other as u32 % nbits)) } } impl $Op<&$Rhs> for &Wrapping where for<'a> &'a F: $Op, { type Output = Wrapping; #[inline] fn $op(self, other: &$Rhs) -> Wrapping { let nbits = size_of::() as u32 * 8; Wrapping((self.0).$op(*other as u32 % nbits)) } } impl $OpAssign<$Rhs> for Wrapping where F: $OpAssign, { #[inline] fn $op_assign(&mut self, other: $Rhs) { let nbits = size_of::() as u32 * 8; (self.0).$op_assign(other as u32 % nbits); } } impl $OpAssign<&$Rhs> for Wrapping where F: $OpAssign, { #[inline] fn $op_assign(&mut self, other: &$Rhs) { let nbits = size_of::() as u32 * 8; (self.0).$op_assign(*other as u32 % nbits); } } )* }; } impl Neg for Wrapping { type Output = Wrapping; #[inline] fn neg(self) -> Wrapping { Wrapping((self.0).wrapping_neg()) } } impl Neg for &Wrapping { type Output = Wrapping; #[inline] fn neg(self) -> Wrapping { Wrapping((self.0).wrapping_neg()) } } op! { wrapping_add, Add add, AddAssign add_assign } op! { wrapping_sub, Sub sub, SubAssign sub_assign } op! { wrapping_mul, Mul mul, MulAssign mul_assign } op! { wrapping_div, Div div, DivAssign div_assign } op! { rem, Rem rem, RemAssign rem_assign } impl Not for Wrapping where F: Not, { type Output = Wrapping; #[inline] fn not(self) -> Wrapping { Wrapping((self.0).not()) } } impl Not for &Wrapping where for<'a> &'a F: Not, { type Output = Wrapping; #[inline] fn not(self) -> Wrapping { Wrapping((self.0).not()) } } op_bitwise! { BitAnd bitand, BitAndAssign bitand_assign } op_bitwise! { BitOr bitor, BitOrAssign bitor_assign } op_bitwise! { BitXor bitxor, BitXorAssign bitxor_assign } op_shift! { Shl shl, ShlAssign shl_assign; i8, i16, i32, i64, i128, isize, u8, u16, u32, u64, u128, usize } op_shift! { Shr shr, ShrAssign shr_assign; i8, i16, i32, i64, i128, isize, u8, u16, u32, u64, u128, usize } impl Sum> for Wrapping { fn sum(iter: I) -> Wrapping where I: Iterator>, { iter.fold(Wrapping(F::ZERO), Add::add) } } impl<'a, F: 'a + Fixed> Sum<&'a Wrapping> for Wrapping { fn sum(iter: I) -> Wrapping where I: Iterator>, { iter.fold(Wrapping(F::ZERO), Add::add) } } impl Product> for Wrapping { fn product(mut iter: I) -> Wrapping where I: Iterator>, { match iter.next() { None => Wrapping(1.wrapping_to_fixed()), Some(first) => iter.fold(first, Mul::mul), } } } impl<'a, F: 'a + Fixed> Product<&'a Wrapping> for Wrapping { fn product(mut iter: I) -> Wrapping where I: Iterator>, { match iter.next() { None => Wrapping(1.wrapping_to_fixed()), Some(first) => iter.fold(*first, Mul::mul), } } } // The following cannot be implemented for Wrapping where F: Fixed, // otherwise there will be a conflicting implementation error. For // example we cannot implement both these without triggering E0119: // // impl Op for Wrapping { /* ... */ } // impl Op<&F::Bits> for Wrapping { /* ... */ } // // To work around this, we provide implementations like this: // // impl Op for Wrapping> { /* ... */ } // impl Op<&i8> for Wrapping> { /* ... */ } // impl Op for Wrapping> { /* ... */ } // impl Op<&i16> for Wrapping> { /* ... */ } // ... macro_rules! op_bits { ( $Fixed:ident($Bits:ident $(, $LeEqU:ident)*)::$wrapping:ident, $Op:ident $op:ident, $OpAssign:ident $op_assign:ident ) => { impl $Op<$Bits> for Wrapping<$Fixed> { type Output = Wrapping<$Fixed>; #[inline] fn $op(self, other: $Bits) -> Wrapping<$Fixed> { Wrapping((self.0).$wrapping(other)) } } impl $Op<$Bits> for &Wrapping<$Fixed> { type Output = Wrapping<$Fixed>; #[inline] fn $op(self, other: $Bits) -> Wrapping<$Fixed> { Wrapping((self.0).$wrapping(other)) } } impl $Op<&$Bits> for Wrapping<$Fixed> { type Output = Wrapping<$Fixed>; #[inline] fn $op(self, other: &$Bits) -> Wrapping<$Fixed> { Wrapping((self.0).$wrapping(*other)) } } impl $Op<&$Bits> for &Wrapping<$Fixed> { type Output = Wrapping<$Fixed>; #[inline] fn $op(self, other: &$Bits) -> Wrapping<$Fixed> { Wrapping((self.0).$wrapping(*other)) } } impl $OpAssign<$Bits> for Wrapping<$Fixed> { #[inline] fn $op_assign(&mut self, other: $Bits) { self.0 = (self.0).$wrapping(other); } } impl $OpAssign<&$Bits> for Wrapping<$Fixed> { #[inline] fn $op_assign(&mut self, other: &$Bits) { self.0 = (self.0).$wrapping(*other); } } }; } macro_rules! ops { ($Fixed:ident($Bits:ident, $LeEqU:ident)) => { op_bits! { $Fixed($Bits)::wrapping_mul_int, Mul mul, MulAssign mul_assign } op_bits! { $Fixed($Bits)::wrapping_div_int, Div div, DivAssign div_assign } op_bits! { $Fixed($Bits, $LeEqU)::rem, Rem rem, RemAssign rem_assign } }; } ops! { FixedI8(i8, LeEqU8) } ops! { FixedI16(i16, LeEqU16) } ops! { FixedI32(i32, LeEqU32) } ops! { FixedI64(i64, LeEqU64) } ops! { FixedI128(i128, LeEqU128) } ops! { FixedU8(u8, LeEqU8) } ops! { FixedU16(u16, LeEqU16) } ops! { FixedU32(u32, LeEqU32) } ops! { FixedU64(u64, LeEqU64) } ops! { FixedU128(u128, LeEqU128) }