donglora/vendor/fixed/RELEASES.md

Version 1.29.0 (2025-02-26)

• The crate now requires rustc version 1.83.0 or later.
• The following methods were added to all fixed-point numbers, to the Fixed trait, and to the Saturating, Wrapping and Unwrapped wrappers:
  • unbounded_shl, unbounded_shr
  • from_ascii, from_ascii_binary, from_ascii_octal, from_ascii_hex
  • saturating_from_ascii, saturating_from_ascii_binary, saturating_from_ascii_octal, saturating_from_ascii_hex
  • wrapping_from_ascii, wrapping_from_ascii_binary, wrapping_from_ascii_octal, wrapping_from_ascii_hex
  • unwrapped_from_ascii, unwrapped_from_ascii_binary, unwrapped_from_ascii_octal, unwrapped_from_ascii_hex
  • overflowing_from_ascii, overflowing_from_ascii_binary, overflowing_from_ascii_octal, overflowing_from_ascii_hex
• The cast_unsigned method was added to all signed fixed-point numbers, to their Saturating, Wrapping and Unwrapped wrappers, and to the Fixed trait.
• The cast_signed method was added to all unsigned fixed-point numbers, to their Saturating, Wrapping and Unwrapped wrappers, and to the Fixed trait.
• The following methods are now usable in constant context:
  • mul_acc, checked_mul_acc, saturating_mul_acc, wrapping_mul_acc, unwrapped_mul_acc, overflowing_mul_acc
• Now ParseFixedError implements Error even when the std optional feature is disabled.

Version 1.28.0 news (2024-07-25)

• The crate now requires rustc version 1.79.0 or later.
• The following methods were added to all fixed-point numbers and to the Fixed trait:
  • unchecked_add, unchecked_sub, unchecked_mul_int
• For all fixed-point numbers and the Fixed trait, the following methods were renamed. The old method names are deprecated.
  • round_ties_to_even renamed to round_ties_even
  • checked_round_ties_to_even renamed to checked_round_ties_even
  • saturating_round_ties_to_even renamed to saturating_round_ties_even
  • wrapping_round_ties_to_even renamed to wrapping_round_ties_even
  • unwrapped_round_ties_to_even renamed to unwrapped_round_ties_even
  • overflowing_round_ties_to_even renamed to overflowing_round_ties_even
• The following constants were added to the consts module and as associated constants to fixed-point types:
  • SQRT_2PI, FRAC_1_SQRT_2PI
• The experimental feature nightly-float was added.
• For the experimental feature num-traits, the following traits were implemented for all fixed-point numbers:
  • ConstZero, ConstOne
  • ToBytes, FromBytes

Version 1.27.0 (2024-03-27)

• The hypot method was added to all fixed-point numbers, to the Fixed trait, and to the Saturating, Wrapping and Unwrapped wrappers.
• The following methods were added to all fixed-point numbers and to the Fixed trait:
  • checked_hypot, saturating_hypot, wrapping_hypot, unwrapped_hypot, overflowing_hypot
  • saturating_sqrt, wrapping_sqrt, unwrapped_sqrt, overflowing_sqrt

Version 1.26.0 (2024-03-06)

• The sqrt method was added to all fixed-point numbers, to the Fixed trait, and to the Saturating, Wrapping and Unwrapped wrappers.
• The checked_sqrt method was added to all fixed-point numbers and to the Fixed trait.

Version 1.25.1 (2024-02-06)

• Bug fix: formatting numbers with LowerExp and UpperExp was producing incorrect output when rounding incremented a zero in the middle of a string, for example format!("{:.2e}", I16F16::lit("9.099")).

Version 1.25.0 (2024-02-05)

• Bug fix: formatting numbers with LowerExp and UpperExp was producing incorrect output for very small numbers, for example format!("{:e}", I16F16::DELTA).
• Bug fix: formatting numbers with LowerExp and UpperExp was panicking for some cases of positive exponents and small precision, for example format!("{:.1e}", I16F16::from_num(1001)).
• Bug fix: formatting numbers with LowerExp and UpperExp was producing incorrect output when rounding adds a more significant digit, for example format!("{:.1e}", I16F16::lit("0.999")).
• The experimental borsh feature was promoted to an optional feature, and the optional borsh crate dependency was updated to version 1.0.

Version 1.24.0 (2023-09-19)

• The crate now requires rustc version 1.71.0 or later.
• The saturating_div_int method was added to all fixed-point numbers and to the Fixed trait.
• The Saturating wrapper was added.

Version 1.23.1 (2023-03-14)

• Bug fix: comparison of signed and unsigned numbers where the signed number was wider than the unsigned number was truncating bits from the signed number (issue 57).
• The half crate dependency is now satisfied by version 1.8 as well as version 2.

Version 1.23.0 (2023-02-06)

• String parsing of binary, octal and hexadecimal strings now supports base-2 exponents starting with the separator “p” or “P”.
• Bug fix: int_log10, int_log, checked_int_log10 and checked_int_log were panicking or returning incorrect values for fixed-point numbers with no integer bits.

Version 1.22.1 (2023-01-26)

• The errors from the lit method have been improved.
• The track_caller attribute is now applied to many more inline functions that can panic.

Version 1.22.0 (2023-01-25)

• String parsing now supports an optional exponent for all supported radices.
• The lit method was added to all fixed-point numbers. This is useful to write fixed-point numbers literally in code and also works in constant context.
• All fixed-point numbers now implement LowerExp and UpperExp.
• The Fixed and FixedBits traits now have the added supertraits Binary, Octal, LowerHex, UpperHex, LowerExp and UpperExp.
• The Wrapping and Unwrapped wrappers now implement Binary, Octal, LowerHex, UpperHex, LowerExp and UpperExp.
• The implementation of Debug for fixed-point numbers now has more relaxed constraints on the fractional bits generic parameter: now Frac only needs to implement Unsigned.

Version 1.21.0 (2022-12-24)

• Comparisons involving fixed-point numbers now have more relaxed constraints on the fractional bits generic parameter: now Frac only needs to implement Unsigned.
• Better code should now be generated when comparing a fixed-point number to another fixed-point number.
• The following methods were added to the F128 struct:
  • min, max
  • clamp

Version 1.20.0 (2022-11-08)

• The TRY_ONE associated constant was added to the Fixed trait.
• The TRY_NEG_ONE associated constant was added to the FixedSigned trait.
• The const_from_fixed and const_from_int methods were added to all fixed-point numbers.
• The const_fixed_from_int macro is now deprecated.
• The following associated constants were added to the F128 struct:
  • DIGITS
  • MIN_10_EXP, MAX_10_EXP
• F128 now implements From for conversions from f64, f32, f16 and bf16.
• The fixed::f128::consts module was added with F128 basic mathematical constants.

Version 1.19.0 (2022-08-29)

• Bug fix: comparison of and conversion from subnormal floating-point numbers to fixed-point numbers were off by a factor of 2.
• The following associated constants were added to the FixedBits trait:
  • MIN, MAX
  • IS_SIGNED, BITS
• FixedEquiv is now a supertrait of the FixedBits trait.
• FixedBits now has more supertraits from the num-traits crate if the num-traits experimental feature is enabled.

Version 1.18.0 (2022-08-19)

• Bug fix: checked division methods were panicking when dividing MIN by -DELTA for fixed-point numbers with zero integer bits, that is when all bits are fractional bits (issue 51).
• The following methods were added to all fixed-point numbers, to the Fixed trait, and to the Wrapping and Unwrapped wrappers:
  • int_log, checked_int_log
• The F128 struct was added to replace the F128Bits struct which is now deprecated. F128 has standard floating-point ordering and various classification methods and associated constants.
• The from_str_dec method was added to the Unwrapped wrapper.
• The Contiguous trait from the bytemuck crate was implemented for all fixed-point numbers, added as a supertrait to the Fixed trait, and implemented for the Wrapping and Unwrapped wrappers.

Version 1.17.0 (2022-08-03)

• The half crate dependency was updated to version 2.
• The inherent from_str method was added as a const function to all fixed-point numbers so that it can be use in constant context.
• The following methods are now const functions:
  • saturating_from_str, wrapping_from_str, overflowing_from_str
  • from_str_binary, saturating_from_str_binary, wrapping_from_str_binary, overflowing_from_str_binary
  • from_str_octal, saturating_from_str_octal, wrapping_from_str_octal, overflowing_from_str_octal
  • from_str_hex, saturating_from_str_hex, wrapping_from_str_hex, overflowing_from_str_hex
  • checked_div, saturating_div, wrapping_div, unwrapped_div, overflowing_div
  • recip, checked_recip, saturating_recip, wrapping_recip, unwrapped_recip, overflowing_recip
  • checked_rem_int, unwrapped_rem_int
  • div_euclid, checked_div_euclid, saturating_div_euclid, wrapping_div_euclid, unwrapped_div_euclid, overflowing_div_euclid
  • div_euclid_int, checked_div_euclid_int, saturating_div_euclid_int, wrapping_div_euclid_int, unwrapped_div_euclid_int, overflowing_div_euclid_int
  • rem_euclid_int, checked_rem_euclid_int, saturating_rem_euclid_int, wrapping_rem_euclid_int, unwrapped_rem_euclid_int, overflowing_rem_euclid_int
  • lerp, checked_lerp, saturating_lerp, wrapping_lerp, unwrapped_lerp, overflowing_lerp
  • inv_lerp, checked_inv_lerp, saturating_inv_lerp, wrapping_inv_lerp, unwrapped_inv_lerp, overflowing_inv_lerp
• The following methods were added to all fixed-point numbers and to the Fixed trait:
  • unwrapped_from_str, unwrapped_from_str_binary, unwrapped_from_str_octal, unwrapped_from_str_hex
• Bug fix: The following methods were not panicking on all errors as required for the Unwrapped wrapper:
  • <Unwrapped<F> as FromStr>::from_str
  • Unwrapped<F>::from_str_binary
  • Unwrapped<F>::from_str_octal
  • Unwrapped<F>::from_str_hex

Version 1.16.1 (2022-07-22)

• Cargo.toml now includes the rust-version field (merge request 11).

Version 1.16.0 (2022-06-30)

• The crate now requires rustc version 1.61.0 or later.
• The NEG_ONE constant was added to all signed fixed-point numbers that can represent the value −1.
• The add_prod method was added to all fixed-point numbers, to the Fixed trait, and to the Wrapping and Unwrapped wrappers.
• The following methods were added to all fixed-point numbers and to the Fixed trait:
  • checked_add_prod, saturating_add_prod, wrapping_add_prod, unwrapped_add_prod, overflowing_add_prod
• The following methods are now const functions:
  • int, frac, round_to_zero
  • ceil, checked_ceil, saturating_ceil, wrapping_ceil, unwrapped_ceil, overflowing_ceil
  • floor, checked_floor, saturating_floor, wrapping_floor, unwrapped_floor, overflowing_floor
  • round, checked_round, saturating_round, wrapping_round, unwrapped_round, overflowing_round
  • round_ties_to_even, checked_round_ties_to_even, saturating_round_ties_to_even, wrapping_round_ties_to_even, unwrapped_round_ties_to_even, overflowing_round_ties_to_even
  • int_log2, checked_int_log2, int_log10, checked_int_log2
  • wide_mul, wide_mul_unsigned, wide_mul_signed
  • wide_div, wide_sdiv, wide_div_unsigned, wide_sdiv_signed
  • checked_mul, saturating_mul, wrapping_mul, unwrapped_mul, overflowing_mul
  • mul_add, checked_mul_add, saturating_mul_add, wrapping_mul_add, unwrapped_mul_add, overflowing_mul_add
  • signum, checked_signum, saturating_signum, wrapping_signum, unwrapped_signum, overflowing_signum

Version 1.15.0 (2022-04-28)

• The following methods were added to all fixed-point signed numbers up to 64 bits wide:
  • wide_mul_unsigned
  • wide_sdiv
  • wide_div_unsigned
• The following methods were added to all fixed-point unsigned numbers up to 64 bits wide:
  • wide_mul_signed
  • wide_sdiv_signed

Version 1.14.0 (2022-03-20)

• The next_multiple_of method was added to all fixed-point numbers, to the Fixed trait, and to the Wrapping and Unwrapped wrappers.
• The following methods were added to all fixed-point numbers and to the Fixed trait:
  • abs_diff
  • checked_next_multiple_of, saturating_next_multiple_of, wrapping_next_multiple_of, unwrapped_next_multiple_of, overflowing_next_multiple_of
• The following methods were added to all signed fixed-point numbers, to the FixedSigned trait, and to the Wrapping and Unwrapped wrappers for signed numbers:
  • add_unsigned, sub_unsigned
  • checked_add_unsigned, saturating_add_unsigned, wrapping_add_unsigned, unwrapped_add_unsigned, overflowing_add_unsigned
  • checked_sub_unsigned, saturating_sub_unsigned, wrapping_sub_unsigned, unwrapped_sub_unsigned, overflowing_sub_unsigned
• The following methods were added to all unsigned fixed-point numbers, to the FixedUnsigned trait, and to the Wrapping and Unwrapped wrappers for unsigned numbers:
  • add_signed, sub_signed
  • checked_add_signed, saturating_add_signed, wrapping_add_signed, unwrapped_add_signed, overflowing_add_signed
  • checked_sub_signed, saturating_sub_signed, wrapping_sub_signed, unwrapped_sub_signed, overflowing_sub_signed
• Supertraits were added to Fixed::Bits and to Fixed::NonZeroBits in order to allow conversions and operations in generic functions.
• The az crate dependency was updated to version 1.2.

Version 1.13.1 (2022-03-04)

• The const_fixed_from_int macro now accepts a visibility qualifier (merge request 10).

Version 1.13.0 (2022-02-22)

• The AddAssign, SubAssign, MulAssign, DivAssign, RemAssign, BitAndAssign, BitOrAssign and BitXorAssign traits for Wrapping<F> and Unwrapped<F> are now also implemented with F as the type of the right-hand side operand.
• Bug fix: compilation with certain flags was hanging for the thumbv6m target because of a rustc/LLVM issue. This version should not trigger the rustc/LLVM issue (issue 45).

Version 1.12.0 (2022-02-04)

• The crate now requires rustc version 1.57.0 or later.
• The wide_div method was added to all fixed-point numbers up to 64 bits wide (issue 25).
• The following methods are now const functions:
  • unwrapped_neg, unwrapped_add, unwrapped_sub
  • unwrapped_mul_int
  • unwrapped_shl, unwrapped_shr
  • unwrapped_abs, unwrapped_dist
  • unwrapped_next_power_of_two

Version 1.11.0 (2021-11-24)

• The following methods were added to all fixed-point numbers, to the Fixed trait, and to the Wrapping and Unwrapped wrappers:
  • lerp
  • inv_lerp
• The following methods were added to all fixed-point numbers and to the Fixed trait:
  • checked_lerp, saturating_lerp, wrapping_lerp, unwrapped_lerp, overflowing_lerp
  • checked_inv_lerp, saturating_inv_lerp, wrapping_inv_lerp, unwrapped_inv_lerp, overflowing_inv_lerp
• The typenum crate dependency was updated to version 1.14.
• The LeEqU8, LeEqU16, LeEqU32, LeEqU64 and LeEqU128 traits no longer have a direct 'static constraint, as it is a constraint of their supertrait Unsigned since typenum version 1.14. This fixes a potential compatibility issue introduced in version 1.9.0.
• An experimental feature was added to enable serialization using the borsh crate (merge request 9).

Version 1.10.0 (2021-08-23)

• The crate now requires rustc version 1.53.0 or later.
• {Div,DivAssign,Rem,RemAssign}<NonZeroU32> are now implemented for FixedU32, and similar for all other unsigned fixed-point numbers.
• {Rem,RemAssign}<NonZeroI32> are now implemented for FixedI32, and similar for all other signed fixed-point numbers.
• The new arbitrary optional feature was added to implement the Arbitrary trait provided by the arbitrary crate for all fixed-point numbers (issue 37).

Version 1.9.0 (2021-05-13)

• Fixed-point numbers can now be formatted as hexadecimal with Debug similarly to primitive integers, for example formatting with {:X?} will produce upper-case hexadecimal fixed-point numbers.
• The following methods were added to all fixed-point numbers, to the Fixed trait, and to the Wrapping and Unwrapped wrappers:
  • is_zero
  • dist
• The following methods were added to all fixed-point numbers and to the Fixed trait:
  • checked_dist, saturating_dist, wrapping_dist, unwrapped_dist, overflowing_dist
• The unsigned_dist method was added to all signed fixed-point types and to the FixedSigned trait.
• The following associated types and provided methods were added to the Fixed trait:
  • Signed, Unsigned
  • get_signed, get_unsigned
  • get_signed_mut, get_unsigned_mut
• The new trait FixedEquiv was added.
• The following traits from the bytemuck crate were implemented for all fixed-point numbers, added as supertraits to the Fixed trait, and implemented for the Wrapping and Unwrapped wrappers (issue 31).
  • Zeroable, Pod
  • TransparentWrapper

Compatibility notes

• Now the Debug implementation for Wrapping outputs the value only without “Wrapping()”, and the Debug implementation for Unwrapped outputs the value only without “Unwrapped()”.
• The LeEqU8, LeEqU16, LeEqU32, LeEqU64 and LeEqU128 traits now have a 'static constraint. This should have no practical side effects, since these traits are a convenience feature and already have the Unsigned marker trait as a supertrait, and the types that implement Unsigned are 'static.
• The FixedOptionalFeatures trait was not sealed, which was as an oversight. Now it is sealed, and the documentation explicitly states that the trait should not be used directly.

Version 1.8.0 (2021-04-20)

• The following constants and method were added to all fixed-point numbers, to the Fixed trait, and to the Wrapping and Unwrapped wrappers:
  • ZERO, DELTA
  • mul_acc
• The ONE constant was added to all fixed-point numbers that can represent the value 1.
• The following methods were added to all fixed-point numbers and to the Fixed trait:
  • checked_mul_acc, saturating_mul_acc, wrapping_mul_acc, unwrapped_mul_acc, overflowing_mul_acc
  • saturating_div_euclid_int, saturating_rem_euclid_int
  • unwrapped_rem, unwrapped_rem_euclid
  • unwrapped_rem_int
• The following methods are now const functions:
  • checked_rem
  • rem_euclid, checked_rem_euclid
  • checked_div_int, wrapping_div_int, unwrapped_div_int, overflowing_div_int
• The following methods were added to all fixed-point numbers:
  • const_not
  • const_bitand, const_bitor, const_bitxor
• Many methods were marked with the must_use attribute.

Version 1.7.0 (2021-03-25)

• The crate now requires rustc version 1.50.0 or later.
• The following methods are now const functions:
  • next_power_of_two, checked_next_power_of_two, wrapping_next_power_of_two
• The following constant and methods were added to all fixed-point numbers, to the Fixed trait, and to the Wrapping and Unwrapped wrappers:
  • IS_SIGNED
  • from_be, from_le
  • to_be, to_le
  • swap_bytes
  • reverse_bits
  • mean
• The following methods were added to the Wrapping and Unwrapped wrappers:
  • from_be_bytes, from_le_bytes, from_ne_bytes
  • to_be_bytes, to_le_bytes, to_ne_bytes
• The following methods were added to all unsigned fixed-point types, to the FixedUnsigned trait, and to the Wrapping and Unwrapped wrappers for unsigned numbers:
  • significant_bits
  • highest_one
• The signed_bits method was added to all signed fixed-point types, to the FixedSigned trait, and to the Wrapping and Unwrapped wrappers for signed numbers.
• The following constants, which are available in other programming language standard libraries, were added to the consts module and as associated constants to fixed-point types:
  • SQRT_PI (Go), FRAC_1_SQRT_PI (C++)
  • SQRT_3 (C++), FRAC_1_SQRT_3 (C++)
  • SQRT_E (Go)
  • SQRT_PHI (Go)
  • GAMMA (C++)
  • CATALAN (Julia)
• Sum and Product are now supertraits of the Fixed trait.
• The F128Bits type was added to support conversions and comparisons between fixed-point numbers and binary128 floating-point numbers.
• The features that previously required the az and f16 optional features are now always provided. The az and f16 optional features are now deprecated and have no effect.
• For the experimental feature num-traits, the following traits were implemented for all fixed-point numbers:
  • OverflowingAdd, OverflowingSub, OverflowingMul

Version 1.6.0 (2021-02-05)

• The crate now requires rustc version 1.47.0 or later.
• The optional az crate dependency was updated to version 1.1.
• The unsigned_abs method was added to all signed fixed-point types and to the FixedSigned trait.
• The following methods are now const functions:
  • checked_neg, checked_add, checked_sub, checked_mul_int, checked_shl, checked_shr, checked_abs
• The unwrapped_to_fixed method was added to the ToFixed trait.
• The unwrapped_from_fixed method was added to the FromFixed trait.

Version 1.5.0 (2020-11-05)

• The wide_mul method was added to all fixed-point numbers up to 64 bits wide (issue 25).
• Unwrapped methods for arithmetic together with the Unwrapped wrapper were added. Unwrapped methods panic on overflow, even when debug assertions are disabled, similar to how wrapping methods will wrap around even when debug assertions are enabled. (This was previously an experimental feature unwrapped.)
• The serde-str feature was added. (This was previously an experimental feature.)
• For the experimental feature num-traits, some missing supertraits were added to FixedOptionalFeatures.
• Bug fix: multiplication of FixedI128 was panicking when multiplying some large negative numbers (issue 26).

Version 1.4.0 (2020-10-22)

• The following methods were added to all fixed-point types, to the Fixed trait, and to the Wrapping wrapper:
  • recip, checked_recip, saturating_recip, wrapping_recip, overflowing_recip
• For the experimental feature num-traits, the following traits were implemented where applicable (issue 23):
  • Num
  • Signed, Unsigned
  • Inv
  • MulAdd, MulAddAssign
  • FloatConst
  • ToPrimitive, FromPrimitive
• For the experimental feature serde-str, serialization in human-readable formats was made more convenient to write manually (issue 24). This makes it incompatible with the version in 1.3.0.

Version 1.3.0 (2020-10-15)

• The MulAssign implementation on fixed-point numbers now accepts an rhs fixed-point number with a different number of fractional bits from self.
• The following methods were added to all fixed-point types, to the Fixed trait, and to the Wrapping wrapper:
  • mul_add, checked_mul_add, saturating_mul_add, wrapping_mul_add, overflowing_mul_add
• The new experimental feature unwrapped was added, providing arithmetic methods that panic on overflow even when debug assertions are disabled.
• The new experimental feature serde-str was added, which makes serialization use the number’s value in human-readable formats.

Version 1.2.0 (2020-09-02)

• The const_fixed_from_int! macro was added to make it easy to define constant fixed-point numbers using integer expressions (issue 20).

Version 1.1.0 (2020-07-21)

• The new experimental feature num-traits was added to implement some traits, and to also add the relevant traits as supertraits to the FixedOptionalFeatures trait (issue 18).

Version 1.0.0 (2020-06-04)

• The crate now requires rustc version 1.44.0 or later.
• The following methods are now const functions:
  • from_be_bytes, from_le_bytes, from_ne_bytes
  • to_be_bytes, to_le_bytes, to_ne_bytes
• All deprecated items were removed.

Version 0.5.7 (2020-05-11)

• The LosslessTryFrom and LosslessTryInto traits were added.
• The following methods were added to all fixed-point types, to the Fixed trait, and to the Wrapping wrapper:
  • leading_ones, trailing_ones
• The following method was added to unsigned fixed-point types and to the FixedUnsigned trait:
  • wrapping_next_power_of_two
• The PHI and FRAC_1_PHI constants were added to the consts module and as associated constants to fixed-point types.

Version 0.5.6 (2020-05-01)

• The following methods were added to signed fixed-point types and to the FixedSigned trait:
  • checked_signum, saturating_signum, wrapping_signum, overflowing_signum
• The LossyFrom and LossyInto traits were added to the prelude.
• Casts deprecated in version 0.3.1 of the az crate were marked as deprecated.

Version 0.5.5 (2020-04-16)

• Bug fix: an incorrect result could be given when comparing a signed fixed-point number of type FixedI to a number that would overflow by exactly one bit when converting to FixedI.
• The following associated constants were added to all fixed-point types, to the Fixed trait, and to the Wrapping wrapper:
  • MIN, MAX
• The following associated constants were added to the Fixed trait and to the Wrapping wrapper:
  • INT_NBITS, FRAC_NBITS
• The following methods were added to all fixed-point types and to the Fixed trait:
  • int_log2, int_log10
  • checked_int_log2, checked_int_log10
• The following methods were added to the Wrapping wrapper:
  • int_log2, int_log10
• The constants in the consts module were also added as associated constants to fixed-point types that can represent them.
• The following methods were deprecated:
  • min_value, max_value
  • int_nbits, frac_nbits

Version 0.5.4 (2020-02-21)

• Bug fix: rem_euclid_int and its checked versions were handling overflow incorrectly.

Version 0.5.3 (2020-02-13)

• Bug fix: round_to_zero was returning incorrect results for negative whole number operands.
• Bug fix: all remainder operations with a fixed-point LHS and an integer RHS were giving an incorrect answer (https://gitlab.com/tspiteri/fixed/issues/13).
• Bug fix: Euclidean division operations by integers were giving an incorrect answer.
• Rem and RemAssign were implemented for fixed-point numbers.
• The following methods were added to all fixed-point types and to the Fixed trait:
  • checked_rem
  • div_euclid, rem_euclid
  • checked_div_euclid, checked_rem_euclid
  • saturating_div_euclid
  • wrapping_div_euclid
  • overflowing_div_euclid
• The following methods were added to the Wrapping wrapper:
  • div_euclid, rem_euclid
  • div_euclid_int, rem_euclid_int
• The following methods were deprecated:
  • wrapping_rem_int, overflowing_rem_int

Version 0.5.2 (2020-02-02)

• Wrapping now supports serialization. (Thanks: Shane Pearman)

Version 0.5.1 (2019-12-22)

• ParseFixedError implements Error when the new std feature is enabled.

Version 0.5.0 (2019-12-06)

• The crate now requires rustc version 1.39.0 or later.
• The following methods were added to all fixed-point types and to the Fixed trait:
  • from_be_bytes, from_le_bytes, from_ne_bytes
  • to_be_bytes, to_le_bytes, to_ne_bytes
  • div_euclid_int, rem_euclid_int
  • checked_div_euclid_int, checked_rem_euclid_int
  • wrapping_div_euclid_int, wrapping_rem_euclid_int
  • overflowing_div_euclid_int, overflowing_rem_euclid_int
• Casts deprecated in version 0.3.1 of the az crate were marked as deprecated.

Incompatible changes

• Deprecated methods and modules were removed.

Version 0.4.6 (2019-10-16)

• Conversions to/from bf16 are now provided when the f16 option is enabled.
• The following methods are now const functions: saturating_neg, saturating_add, saturating_sub, saturating_mul_int, saturating_abs
• Support for casts using the az crate was added.

Version 0.4.5 (2019-08-30)

• Bug fix: display of many decimal numbers was panicking in debug mode or including a leading zero in release mode.
• Many methods were added to Wrapping for convenience, even if they do not involve wrapping.

Version 0.4.4 (2019-08-24)

• Bug fix: rounding could produce bad output for Binary, Octal, LowerHex and UpperHex.
• The following methods are now const functions: is_power_of_two, abs, wrapping_abs, overflowing_abs
• The method round_to_zero was added.
• The method round_ties_to_even and its checked versions were added.

Version 0.4.3 (2019-08-20)

• The crate now requires rustc version 1.34.0 or later.
• The precision argument is no longer ignored when formatting fixed-point numbers; precision should now be handled the same as for primitive floating-point numbers in the standard library.
• Parsing strings now rounds to the nearest with ties rounded to even.
• Checked versions of string parsing methods are now available as inherent methods to all fixed-point numbers, and as methods in the Fixed trait.
• Wrapping now has methods for parsing with wrapping, including an implementation of FromStr.
• The following methods are now const functions:
  • min_value, max_value, from_bits, to_bits
  • count_ones, count_zeros, leading_zeros, trailing_zeros rotate_left, rotate_right
  • wrapping_neg, wrapping_add, wrapping_sub, wrapping_mul_int, wrapping_shl, wrapping_shr
  • overflowing_neg, overflowing_add, overflowing_sub, overflowing_mul_int, overflowing_shl, overflowing_shr
  • is_positive, is_negative
• The associated constants INT_NBITS and FRAC_NBITS were added.
• The reexports in the frac module and the LeEqU* traits were moved into the new types::extra module.

Version 0.4.2 (2019-08-16)

• The new methods from_num and to_num together with their checked versions were added to all fixed-point numbers.
• The methods from_fixed, to_fixed, from_int, to_int, from_float, and to_float, and their checked versions, were deprecated.
• The new method from_num was added to the Wrapping wrapper.
• Bug fix: parsing of decimal fractions was fixed to give correctly rounded results for long decimal fraction strings, for example with four fractional bits, 0.96874999… (just below 31⁄32) and 0.96875 (31⁄32) are now parsed correctly as 0.9375 (15⁄16) and 1.0.

Version 0.4.1 (2019-08-12)

• All fixed-point types now implement FromStr.
• The methods from_str_binary, from_str_octal and from_str_hex were added.

Version 0.4.0 (2019-08-08)

• The crate now requires rustc version 1.31.0 or later.
• The traits module was added, with its traits Fixed, FixedSigned, FixedUnsigned, FromFixed, ToFixed, LossyFrom and LossyInto.
• The saturating_neg method was added to all fixed-point numbers, and the saturating_abs method was added to signed fixed-point numbers.
• The consts module was added.
• The signum method now wraps instead of panics in release mode.

Incompatible changes

• The sealed traits Int and Float now have no provided methods; the methods in the old implementation are now provided by FromFixed and ToFixed.
• Deprecated methods were removed.

Contributors

• @jean-airoldie
• @tspiteri

Version 0.3.3 (2019-06-27)

• Conversions to/from isize and usize were added.

Version 0.3.2 (2019-02-27)

• The Wrapping wrapper was added.

Version 0.3.1 (2019-02-07)

• Reimplement From<bool> for all fixed-point types which can represent the integer 1. This was inadvertently removed in 0.3.0.

Version 0.3.0 (2019-02-03)

• Incompatible change: the return type of to_int is now generic.
• Incompatible change: the Int trait implementation for bool was removed.
• The new method to_fixed was added.
• The new methods checked_to_fixed, checked_to_int, saturating_to_fixed, saturating_to_int, wrapping_to_fixed, wrapping_to_int, overflowing_to_fixed and overflowing_to_int were added.
• The methods from_fixed, to_fixed, checked_from_fixed, checked_to_fixed, saturating_from_fixed, saturating_to_fixed, wrapping_from_fixed, wrapping_to_fixed, overflowing_from_fixed and overflowing_to_fixed were added to the Int trait.
• The methods from_fixed, to_fixed, checked_to_fixed, saturating_to_fixed, wrapping_to_fixed and overflowing_to_fixed were added to the Float trait.
• PartialEq and PartialCmp are now implemented for all combinations of fixed-point numbers and primitive integers.
• The methods int_bits and frac_bits were deprecated and replaced by the methods int_nbits and frac_nbits.

Version 0.2.1 (2019-01-29)

• Bug fix: the from_fixed and from_int methods (and their checked counterparts) could return wrong values for negative values.
• Bug fix: display was using one fractional digit less than required, thus yielding the same output for diffent fixed-point numbers.

Version 0.2.0 (2019-01-29)

• Incompatible change: The method from_int was change to accept a generic parameter.
• The new methods from_fixed, checked_from_fixed, saturating_from_fixed, wrapping_from_fixed and overflowing_from_fixed were added.
• The new methods checked_from_int, saturating_from_int, wrapping_from_int and overflowing_from_int were added.
• The new methods from_float, checked_from_float, saturating_from_float, wrapping_from_float and overflowing_from_float were added.
• The new method to_float was added.
• The methods from_f16, from_f32, from_f64, to_f16, to_f32 and to_f64 were deprecated.
• The to_int method was fixed to truncate fractional bits as documented for negative values.
• The new methods ceil, floor, round, checked_ceil, checked_floor, checked_round, saturating_ceil, saturating_floor, saturating_round, wrapping_ceil, wrapping_floor, wrapping_round, overflowing_ceil, overflowing_floor and overflowing_round were added.
• The methods to_int_ceil, to_int_floor and to_int_round were deprecated.

Version 0.1.6 (2019-01-27)

• Optional serde support was added.

Version 0.1.5 (2019-01-26)

• Lossless infallible conversions between fixed-point numbers and numeric primitives are now supported using From and Into.
• A new module types is available with aliases for all supported fixed-point numbers.

Version 0.1.4 (2018-11-29)

• Division is now implemented for FixedI128 and FixedU128.

Version 0.1.3 (2018-08-23)

• The f16 feature was added, and new methods from_f16 and to_f16 were added.

Version 0.1.2 (2018-08-15)

• The crate can now be used without the standard library std.
• New methods from_f32 and from_f64 were added.
• New methods is_positive and is_negative were added to signed fixed-point numbers.

Version 0.1.1 (2018-08-11)

• Comparisons are now supported between all fixed-point numbers with the same underlying integer type.
• New static methods int_bits and frac_bits were added.
• New methods from_int, to_int, to_int_ceil, to_int_floor and to_int_round were added.
• New methods int and frac were added.
• Support for multiplication and division by integers was added.

Version 0.1.0 (2018-08-10)

• Unsigned constants provided by the typenum crate are now used for the number of fractional bits.
• Many methods and trait implementations available for primitive integers are now also supported by the fixed-point numbers.