fixed/RELEASES.md

806 lines
42 KiB
Markdown
Raw Permalink Normal View History

2021-02-05 06:22:27 -08:00
<!-- Copyright © 20182021 Trevor Spiteri -->
2018-08-10 11:57:59 -07:00
<!-- Copying and distribution of this file, with or without
modification, are permitted in any medium without royalty provided the
copyright notice and this notice are preserved. This file is offered
as-is, without any warranty. -->
Version 1.11.0 (unreleased)
===========================
* The following methods were added to all fixed-point numbers, to the
[`Fixed`][tf-1-11] trait, and to the [`Wrapping`][w-1-11] and
[`Unwrapped`][u-1-11] wrappers:
* [`lerp`][f-l-1-11]
2021-10-15 11:52:04 -07:00
* [`inv_lerp`][f-il-1-11]
* The following methods were added to all fixed-point numbers and to the
[`Fixed`][tf-1-11] trait:
* [`checked_lerp`][f-cl-1-11], [`saturating_lerp`][f-sl-1-11],
[`wrapping_lerp`][f-wl-1-11], [`unwrapped_lerp`][f-ul-1-11],
[`overflowing_lerp`][f-ol-1-11]
2021-10-15 11:52:04 -07:00
* [`checked_inv_lerp`][f-cil-1-11], [`saturating_inv_lerp`][f-sil-1-11],
[`wrapping_inv_lerp`][f-wil-1-11], [`unwrapped_inv_lerp`][f-uil-1-11],
[`overflowing_inv_lerp`][f-oil-1-11]
* The [*typenum* crate] dependency was updated to [version
1.14][typenum-1-14].
* The [`LeEqU8`][leu8-1-11], [`LeEqU16`][leu16-1-11], [`LeEqU32`][leu32-1-11],
[`LeEqU64`][leu64-1-11] and [`LeEqU128`][leu128-1-11] traits no longer have
a direct `'static` constraint, as it is a constraint of their supertrait
[`Unsigned`][uns-1-11] since typenum [version 1.14][typenum-1-14]. This
fixes a potential compatibility issue introduced in version 1.9.0.
2021-10-15 11:52:04 -07:00
[f-cil-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.checked_inv_lerp
[f-cl-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.checked_lerp
2021-10-15 11:52:04 -07:00
[f-il-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.inv_lerp
[f-l-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.lerp
2021-10-15 11:52:04 -07:00
[f-oil-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.overflowing_inv_lerp
[f-ol-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.overflowing_lerp
2021-10-15 11:52:04 -07:00
[f-sil-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.saturating_inv_lerp
[f-sl-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.saturating_lerp
2021-10-15 11:52:04 -07:00
[f-uil-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.unwrapped_inv_lerp
[f-ul-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.unwrapped_lerp
2021-10-15 11:52:04 -07:00
[f-wil-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.wrapping_inv_lerp
[f-wl-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.wrapping_lerp
[leu128-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/types/extra/trait.LeEqU128.html
[leu16-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/types/extra/trait.LeEqU16.html
[leu32-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/types/extra/trait.LeEqU32.html
[leu64-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/types/extra/trait.LeEqU64.html
[leu8-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/types/extra/trait.LeEqU8.html
[tf-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/traits/trait.Fixed.html
[typenum-1-14]: https://docs.rs/typenum/~1.14/typenum/index.html
[u-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.Unwrapped.html
[uns-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/types/extra/trait.Unsigned.html
[w-1-11]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.Wrapping.html
2021-08-23 12:01:09 -07:00
Version 1.10.0 (2021-08-23)
2021-08-17 01:50:22 -07:00
===========================
2021-08-19 04:59:09 -07:00
* The crate now requires rustc version 1.53.0 or later.
2021-08-19 05:29:45 -07:00
* <code>{[Div][`Div`],[DivAssign][`DivAssign`],[Rem][`Rem`],[RemAssign][`RemAssign`]}\<[NonZeroU32][`NonZeroU32`]></code>
are now implemented for [`FixedU32`][fu-1-10], and similar for all other
unsigned fixed-point numbers.
* <code>{[Rem][`Rem`],[RemAssign][`RemAssign`]}\<[NonZeroI32][`NonZeroI32`]></code>
are now implemented for [`FixedI32`][fi-1-10], and similar for all other
signed fixed-point numbers.
2021-08-17 01:50:22 -07:00
* The new [`arbitrary`][feat-1-10] optional feature was added to implement the
[`Arbitrary`][a-a-1] trait provided by the [*arbitrary* crate] for all
fixed-point numbers ([issue 37]).
2021-08-17 01:50:22 -07:00
[a-a-1]: https://docs.rs/arbitrary/^1/arbitrary/trait.Arbitrary.html
2021-08-23 12:01:09 -07:00
[feat-1-10]: https://docs.rs/fixed/~1.10/fixed/index.html#optional-features
[fi-1-10]: https://docs.rs/fixed/~1.10/fixed/struct.FixedI32.html
[fu-1-10]: https://docs.rs/fixed/~1.10/fixed/struct.FixedU32.html
[issue 37]: https://gitlab.com/tspiteri/fixed/-/issues/37
2021-08-17 01:50:22 -07:00
2021-05-13 05:50:38 -07:00
Version 1.9.0 (2021-05-13)
2021-04-21 04:01:55 -07:00
==========================
2021-04-24 11:12:00 -07:00
* Fixed-point numbers can now be formatted as hexadecimal with [`Debug`]
2021-04-24 12:01:19 -07:00
similarly to primitive integers, for example formatting with `{:X?}` will
produce upper-case hexadecimal fixed-point numbers.
2021-05-04 14:27:38 -07:00
* The following methods were added to all fixed-point numbers, to the
2021-04-22 15:06:23 -07:00
[`Fixed`][tf-1-9] trait, and to the [`Wrapping`][w-1-9] and
[`Unwrapped`][u-1-9] wrappers:
* [`is_zero`][f-iz-1-9]
2021-05-06 05:59:46 -07:00
* [`dist`][f-d-1-9]
2021-05-04 14:27:38 -07:00
* The following methods were added to all fixed-point numbers and to the
[`Fixed`][tf-1-9] trait:
2021-05-06 05:59:46 -07:00
* [`checked_dist`][f-cd-1-9], [`saturating_dist`][f-sd-1-9],
[`wrapping_dist`][f-wd-1-9], [`unwrapped_dist`][f-ud-1-9],
[`overflowing_dist`][f-od-1-9]
* The [`unsigned_dist`][f-unsd-1-9] method was added to all signed
2021-05-04 14:27:38 -07:00
fixed-point types and to the [`FixedSigned`][tfs-1-9] trait.
* The following associated types and provided methods were added to the
[`Fixed`][tf-1-9] trait:
2021-04-22 16:46:23 -07:00
* [`Signed`][tf-s-1-9], [`Unsigned`][tf-u-1-9]
* [`get_signed`][tf-gs-1-9], [`get_unsigned`][tf-gu-1-9]
* [`get_signed_mut`][tf-gsm-1-9], [`get_unsigned_mut`][tf-gum-1-9]
2021-05-09 02:34:44 -07:00
* The new trait [`FixedEquiv`][fe-1-9] was added.
* The following traits from the [*bytemuck* crate] were implemented for all
fixed-point numbers, added as supertraits to the [`Fixed`][tf-1-9] trait,
and implemented for the [`Wrapping`][w-1-9] and [`Unwrapped`][u-1-9]
wrappers ([issue 31]).
* [`Zeroable`][bm-z-1], [`Pod`][bm-p-1]
* [`TransparentWrapper`][bm-tw-1]
2021-04-21 04:01:55 -07:00
Compatibility notes
-------------------
* Now the [`Debug`] implementation for [`Wrapping`][w-1-9] outputs the value
2021-08-23 12:01:09 -07:00
only without “`Wrapping()`”, and the [`Debug`] implementation for
[`Unwrapped`][u-1-9] outputs the value only without “`Unwrapped()`”.
2021-04-21 04:01:55 -07:00
* The [`LeEqU8`][leu8-1-9], [`LeEqU16`][leu16-1-9], [`LeEqU32`][leu32-1-9],
[`LeEqU64`][leu64-1-9] and [`LeEqU128`][leu128-1-9] 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`][uns-1-9] marker trait as a supertrait, and the types that
implement [`Unsigned`][uns-1-9] are `'static`.
2021-04-24 07:29:16 -07:00
* The [`FixedOptionalFeatures`][fof-1-9] 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.
2021-04-21 04:01:55 -07:00
[bm-p-1]: https://docs.rs/bytemuck/^1/bytemuck/trait.Pod.html
[bm-tw-1]: https://docs.rs/bytemuck/^1/bytemuck/trait.TransparentWrapper.html
[bm-z-1]: https://docs.rs/bytemuck/^1/bytemuck/trait.Zeroable.html
2021-05-13 05:50:38 -07:00
[f-cd-1-9]: https://docs.rs/fixed/~1.9/fixed/struct.FixedI32.html#method.checked_dist
[f-d-1-9]: https://docs.rs/fixed/~1.9/fixed/struct.FixedI32.html#method.dist
[f-iz-1-9]: https://docs.rs/fixed/~1.9/fixed/struct.FixedI32.html#method.is_zero
[f-od-1-9]: https://docs.rs/fixed/~1.9/fixed/struct.FixedI32.html#method.overflowing_dist
[f-sd-1-9]: https://docs.rs/fixed/~1.9/fixed/struct.FixedI32.html#method.saturating_dist
[f-ud-1-9]: https://docs.rs/fixed/~1.9/fixed/struct.FixedI32.html#method.unwrapped_dist
[f-unsd-1-9]: https://docs.rs/fixed/~1.9/fixed/struct.FixedI32.html#method.unsigned_dist
[f-wd-1-9]: https://docs.rs/fixed/~1.9/fixed/struct.FixedI32.html#method.wrapping_dist
[fe-1-9]: https://docs.rs/fixed/~1.9/fixed/traits/trait.FixedEquiv.html
[fof-1-9]: https://docs.rs/fixed/~1.9/fixed/traits/trait.FixedOptionalFeatures.html
[issue 31]: https://gitlab.com/tspiteri/fixed/-/issues/31
2021-05-13 05:50:38 -07:00
[leu128-1-9]: https://docs.rs/fixed/~1.9/fixed/types/extra/trait.LeEqU128.html
[leu16-1-9]: https://docs.rs/fixed/~1.9/fixed/types/extra/trait.LeEqU16.html
[leu32-1-9]: https://docs.rs/fixed/~1.9/fixed/types/extra/trait.LeEqU32.html
[leu64-1-9]: https://docs.rs/fixed/~1.9/fixed/types/extra/trait.LeEqU64.html
[leu8-1-9]: https://docs.rs/fixed/~1.9/fixed/types/extra/trait.LeEqU8.html
[tf-1-9]: https://docs.rs/fixed/~1.9/fixed/traits/trait.Fixed.html
[tf-gs-1-9]: https://docs.rs/fixed/~1.9/fixed/traits/trait.Fixed.html#method.get_signed
[tf-gsm-1-9]: https://docs.rs/fixed/~1.9/fixed/traits/trait.Fixed.html#method.get_signed_mut
[tf-gu-1-9]: https://docs.rs/fixed/~1.9/fixed/traits/trait.Fixed.html#method.get_unsigned
[tf-gum-1-9]: https://docs.rs/fixed/~1.9/fixed/traits/trait.Fixed.html#method.get_unsigned_mut
[tf-s-1-9]: https://docs.rs/fixed/~1.9/fixed/traits/trait.Fixed.html#associatedtype.Signed
[tf-u-1-9]: https://docs.rs/fixed/~1.9/fixed/traits/trait.Fixed.html#associatedtype.Unsigned
[tfs-1-9]: https://docs.rs/fixed/~1.9/fixed/traits/trait.FixedSigned.html
[u-1-9]: https://docs.rs/fixed/~1.9/fixed/struct.Unwrapped.html
[uns-1-9]: https://docs.rs/fixed/~1.9/fixed/types/extra/trait.Unsigned.html
[w-1-9]: https://docs.rs/fixed/~1.9/fixed/struct.Wrapping.html
2021-04-21 04:01:55 -07:00
2021-04-20 13:12:16 -07:00
Version 1.8.0 (2021-04-20)
==========================
2021-04-24 07:29:16 -07:00
* The following constants and method were added to all fixed-point numbers, to
the [`Fixed`][tf-1-8] trait, and to the [`Wrapping`][w-1-8] and
2021-04-02 12:02:31 -07:00
[`Unwrapped`][u-1-8] wrappers:
* [`ZERO`][f-z-1-8], [`DELTA`][f-d-1-8]
2021-04-16 07:14:08 -07:00
* [`mul_acc`][f-ma-1-8]
2021-04-20 03:57:09 -07:00
* The [`ONE`][f-o-1-8] 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`][tf-1-8] trait:
2021-04-16 07:14:08 -07:00
* [`checked_mul_acc`][f-cma-1-8], [`saturating_mul_acc`][f-sma-1-8],
[`wrapping_mul_acc`][f-wma-1-8], [`unwrapped_mul_acc`][f-uma-1-8],
[`overflowing_mul_acc`][f-oma-1-8]
* [`saturating_div_euclid_int`][f-sdei-1-8],
[`saturating_rem_euclid_int`][f-srei-1-8]
2021-04-20 03:57:09 -07:00
* [`unwrapped_rem`][f-ur-1-8], [`unwrapped_rem_euclid`][f-ure-1-8]
* [`unwrapped_rem_int`][f-uri-1-8]
2021-04-07 09:19:43 -07:00
* The following methods are now `const` functions:
* [`checked_rem`][f-cr-1-8]
2021-04-07 09:19:43 -07:00
* [`rem_euclid`][f-re-1-8], [`checked_rem_euclid`][f-cre-1-8]
2021-04-20 03:57:09 -07:00
* [`checked_div_int`][f-cdi-1-8], [`wrapping_div_int`][f-wdi-1-8],
[`unwrapped_div_int`][f-udi-1-8], [`overflowing_div_int`][f-odi-1-8]
2021-04-07 04:33:55 -07:00
* The following methods were added to all fixed-point numbers:
* [`const_not`][f-cn-1-8]
* [`const_bitand`][f-cba-1-8], [`const_bitor`][f-cbo-1-8],
[`const_bitxor`][f-cbx-1-8]
* Many methods were marked with the `must_use` attribute.
2021-04-20 13:12:16 -07:00
[f-cba-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.const_bitand
[f-cbo-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.const_bitor
[f-cbx-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.const_bitxor
[f-cdi-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.checked_div_int
[f-cma-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.checked_mul_acc
[f-cn-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.const_not
[f-cr-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.checked_rem
[f-cre-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.checked_rem_euclid
[f-d-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#associatedconstant.DELTA
[f-ma-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.mul_acc
[f-o-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#associatedconstant.ONE
[f-odi-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.overflowing_div_int
[f-oma-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.overflowing_mul_acc
[f-re-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.rem_euclid
[f-sdei-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.saturating_div_euclid_int
[f-sma-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.saturating_mul_acc
[f-srei-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.saturating_rem_euclid_int
[f-udi-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.unwrapped_div_int
[f-uma-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.unwrapped_mul_acc
[f-ur-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.unwrapped_rem
[f-ure-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.unwrapped_rem_euclid
[f-uri-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.unwrapped_rem_int
[f-wdi-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.wrapping_div_int
[f-wma-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#method.wrapping_mul_acc
[f-z-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.FixedI32.html#associatedconstant.ZERO
[tf-1-8]: https://docs.rs/fixed/~1.8/fixed/traits/trait.Fixed.html
[u-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.Unwrapped.html
[w-1-8]: https://docs.rs/fixed/~1.8/fixed/struct.Wrapping.html
2021-03-25 09:15:07 -07:00
Version 1.7.0 (2021-03-25)
==========================
2021-02-25 09:24:03 -08:00
* The crate now requires rustc version 1.50.0 or later.
* The following methods are now `const` functions:
* [`next_power_of_two`][f-npot-1-7],
[`checked_next_power_of_two`][f-cnpot-1-7],
[`wrapping_next_power_of_two`][f-wnpot-1-7]
2021-04-20 03:57:09 -07:00
* The following constant and methods were added to all fixed-point numbers, to
the [`Fixed`][tf-1-7] trait, and to the [`Wrapping`][w-1-7] and
[`Unwrapped`][u-1-7] wrappers:
2021-03-20 07:41:50 -07:00
* [`IS_SIGNED`][f-is-1-7]
* [`from_be`][f-fb-1-7], [`from_le`][f-fl-1-7]
* [`to_be`][f-tb-1-7], [`to_le`][f-tl-1-7]
2021-03-17 11:11:18 -07:00
* [`swap_bytes`][f-sb-1-7]
* [`reverse_bits`][f-rb-1-7]
* [`mean`][f-m-1-7]
* The following methods were added to the [`Wrapping`][w-1-7] and
[`Unwrapped`][u-1-7] wrappers:
* [`from_be_bytes`][f-fbb-1-7], [`from_le_bytes`][f-flb-1-7],
[`from_ne_bytes`][f-fnb-1-7]
* [`to_be_bytes`][f-tbb-1-7], [`to_le_bytes`][f-tlb-1-7],
[`to_ne_bytes`][f-tnb-1-7]
2021-04-20 03:57:09 -07:00
* The following methods were added to all unsigned fixed-point types, to the
[`FixedUnsigned`][tfu-1-7] trait, and to the [`Wrapping`][w-1-7] and
[`Unwrapped`][u-1-7] wrappers for unsigned numbers:
2021-03-20 14:15:37 -07:00
* [`significant_bits`][f-signi-1-7]
* [`highest_one`][f-ho-1-7]
2021-04-20 03:57:09 -07:00
* The [`signed_bits`][f-signe-1-7] method was added to all signed fixed-point
types, to the [`FixedSigned`][tfs-1-7] trait, and to the [`Wrapping`][w-1-7]
and [`Unwrapped`][u-1-7] wrappers for signed numbers.
* The following constants, which are available in other programming language
standard libraries, were added to the [`consts`][c-1-7] module and as
associated constants to fixed-point types:
* [`SQRT_PI`][c-rp-1-7] (Go), [`FRAC_1_SQRT_PI`][c-1rp-1-7] (C++)
* [`SQRT_3`][c-r3-1-7] (C++), [`FRAC_1_SQRT_3`][c-1r3-1-7] (C++)
* [`SQRT_E`][c-re-1-7] (Go)
* [`SQRT_PHI`][c-rf-1-7] (Go)
* [`GAMMA`][c-g-1-7] (C++)
* [`CATALAN`][c-c-1-7] (Julia)
2021-04-20 03:57:09 -07:00
* [`Sum`] and [`Product`] are now supertraits of the [`Fixed`][tf-1-7] trait.
* The [`F128Bits`][f128-1-7] type was added to support conversions and
comparisons between fixed-point numbers and *binary128* floating-point
numbers.
2021-03-04 04:08:25 -08:00
* The features that previously required the [`az`][feat-dep-1-7] and
2021-04-20 03:57:09 -07:00
[`f16`][feat-dep-1-7] optional features are now always provided. The
[`az`][feat-dep-1-7] and [`f16`][feat-dep-1-7] optional features are now
deprecated and have no effect.
* For the experimental feature [`num-traits`][feat-exp-1-7], the following
traits were implemented for all fixed-point numbers:
* [`OverflowingAdd`][nt-0-2-oa], [`OverflowingSub`][nt-0-2-os],
[`OverflowingMul`][nt-0-2-om]
2021-03-25 09:15:07 -07:00
[c-1-7]: https://docs.rs/fixed/~1.7/fixed/consts/index.html
[c-1r3-1-7]: https://docs.rs/fixed/~1.7/fixed/consts/constant.FRAC_1_SQRT_3.html
[c-1rp-1-7]: https://docs.rs/fixed/~1.7/fixed/consts/constant.FRAC_1_SQRT_PI.html
[c-c-1-7]: https://docs.rs/fixed/~1.7/fixed/consts/constant.CATALAN.html
[c-g-1-7]: https://docs.rs/fixed/~1.7/fixed/consts/constant.GAMMA.html
[c-r3-1-7]: https://docs.rs/fixed/~1.7/fixed/consts/constant.SQRT_3.html
[c-re-1-7]: https://docs.rs/fixed/~1.7/fixed/consts/constant.SQRT_E.html
[c-rf-1-7]: https://docs.rs/fixed/~1.7/fixed/consts/constant.SQRT_PHI.html
[c-rp-1-7]: https://docs.rs/fixed/~1.7/fixed/consts/constant.SQRT_PI.html
[f-cnpot-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedU32.html#method.checked_next_power_of_two
[f-fb-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedI32.html#method.from_be
[f-fbb-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedI32.html#method.from_be_bytes
[f-fl-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedI32.html#method.from_le
[f-flb-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedI32.html#method.from_le_bytes
[f-fnb-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedI32.html#method.from_ne_bytes
[f-ho-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedU32.html#method.highest_one
[f-is-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedI32.html#associatedconstant.IS_SIGNED
[f-m-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedI32.html#method.mean
[f-npot-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedU32.html#method.next_power_of_two
[f-rb-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedI32.html#method.reverse_bits
[f-sb-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedI32.html#method.swap_bytes
[f-signe-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedI32.html#method.signed_bits
[f-signi-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedU32.html#method.significant_bits
[f-tb-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedI32.html#method.to_be
[f-tbb-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedI32.html#method.to_be_bytes
[f-tl-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedI32.html#method.to_le
[f-tlb-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedI32.html#method.to_le_bytes
[f-tnb-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedI32.html#method.to_ne_bytes
[f-wnpot-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.FixedU32.html#method.wrapping_next_power_of_two
[f128-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.F128Bits.html
2021-04-21 04:01:55 -07:00
[feat-dep-1-7]: https://docs.rs/fixed/~1.7/fixed/index.html#deprecated-optional-features
[feat-exp-1-7]: https://docs.rs/fixed/~1.7/fixed/index.html#experimental-optional-features
[nt-0-2-oa]: https://docs.rs/num-traits/^0.2/num_traits/ops/overflowing/trait.OverflowingAdd.html
[nt-0-2-om]: https://docs.rs/num-traits/^0.2/num_traits/ops/overflowing/trait.OverflowingMul.html
[nt-0-2-os]: https://docs.rs/num-traits/^0.2/num_traits/ops/overflowing/trait.OverflowingSub.html
2021-03-25 09:15:07 -07:00
[tf-1-7]: https://docs.rs/fixed/~1.7/fixed/traits/trait.Fixed.html
[tfs-1-7]: https://docs.rs/fixed/~1.7/fixed/traits/trait.FixedSigned.html
[tfu-1-7]: https://docs.rs/fixed/~1.7/fixed/traits/trait.FixedUnsigned.html
[u-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.Unwrapped.html
[w-1-7]: https://docs.rs/fixed/~1.7/fixed/struct.Wrapping.html
2021-02-05 08:36:04 -08:00
Version 1.6.0 (2021-02-05)
2021-02-01 02:18:29 -08:00
==========================
* The crate now requires rustc version 1.47.0 or later.
2021-04-20 03:57:09 -07:00
* The optional [*az* crate] dependency was updated to [version 1.1][az-1-1].
* The [`unsigned_abs`][f-ua-1-6] method was added to all signed fixed-point
types and to the [`FixedSigned`][tfs-1-6] trait.
2021-02-01 02:34:09 -08:00
* The following methods are now `const` functions:
* [`checked_neg`][f-cn-1-6], [`checked_add`][f-cad-1-6],
[`checked_sub`][f-cs-1-6], [`checked_mul_int`][f-cmi-1-6],
[`checked_shl`][f-cshl-1-6], [`checked_shr`][f-cshr-1-6],
[`checked_abs`][f-cab-1-6]
* The [`unwrapped_to_fixed`][f-utf-1-6] method was added to the
[`ToFixed`][f-tf-1-6] trait.
* The [`unwrapped_from_fixed`][f-uff-1-6] method was added to the
[`FromFixed`][f-ff-1-6] trait.
2021-02-01 02:34:09 -08:00
2021-02-03 02:17:52 -08:00
[az-1-1]: https://docs.rs/az/~1.1/az/index.html
2021-02-05 08:36:04 -08:00
[f-cab-1-6]: https://docs.rs/fixed/~1.6/fixed/struct.FixedI32.html#method.checked_abs
[f-cad-1-6]: https://docs.rs/fixed/~1.6/fixed/struct.FixedI32.html#method.checked_add
[f-cmi-1-6]: https://docs.rs/fixed/~1.6/fixed/struct.FixedI32.html#method.checked_mul_int
[f-cn-1-6]: https://docs.rs/fixed/~1.6/fixed/struct.FixedI32.html#method.checked_neg
[f-cs-1-6]: https://docs.rs/fixed/~1.6/fixed/struct.FixedI32.html#method.checked_sub
[f-cshl-1-6]: https://docs.rs/fixed/~1.6/fixed/struct.FixedI32.html#method.checked_shl
[f-cshr-1-6]: https://docs.rs/fixed/~1.6/fixed/struct.FixedI32.html#method.checked_shr
[f-ff-1-6]: https://docs.rs/fixed/~1.6/fixed/traits/trait.FromFixed.html
[f-tf-1-6]: https://docs.rs/fixed/~1.6/fixed/traits/trait.ToFixed.html
[f-ua-1-6]: https://docs.rs/fixed/~1.6/fixed/struct.FixedI32.html#method.unsigned_abs
[f-uff-1-6]: https://docs.rs/fixed/~1.6/fixed/traits/trait.FromFixed.html#method.unwrapped_from_fixed
[f-utf-1-6]: https://docs.rs/fixed/~1.6/fixed/traits/trait.ToFixed.html#method.unwrapped_to_fixed
[tfs-1-6]: https://docs.rs/fixed/~1.6/fixed/traits/trait.FixedSigned.html
2021-02-01 02:18:29 -08:00
2020-11-05 01:48:58 -08:00
Version 1.5.0 (2020-11-05)
2020-10-30 16:29:58 -07:00
==========================
2021-04-20 03:57:09 -07:00
* The [`wide_mul`][f-wm-1-5] method was added to all fixed-point numbers up to
64 bits wide ([issue 25]).
* Unwrapped methods for arithmetic together with the [`Unwrapped`][unw-1-5]
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`][feat-1-5] feature was added. (This was previously an
experimental feature.)
* For the experimental feature [`num-traits`][feat-exp-1-5], some missing
supertraits were added to [`FixedOptionalFeatures`][tfof-1-5].
* Bug fix: multiplication of [`FixedI128`][i128-1-5] was panicking when
multiplying some large negative numbers ([issue 26]).
2020-10-30 16:29:58 -07:00
2021-02-01 03:10:08 -08:00
[i128-1-5]: https://docs.rs/fixed/~1.5/fixed/struct.FixedI128.html
2020-11-05 01:48:58 -08:00
[f-wm-1-5]: https://docs.rs/fixed/~1.5/fixed/struct.FixedI32.html#method.wide_mul
2021-04-21 04:01:55 -07:00
[feat-1-5]: https://docs.rs/fixed/~1.5/fixed/index.html#optional-features
[feat-exp-1-5]: https://docs.rs/fixed/~1.5/fixed/index.html#experimental-optional-features
2020-10-31 07:17:12 -07:00
[issue 25]: https://gitlab.com/tspiteri/fixed/-/issues/25
[issue 26]: https://gitlab.com/tspiteri/fixed/-/issues/26
2020-11-05 01:48:58 -08:00
[tfof-1-5]: https://docs.rs/fixed/~1.5/fixed/traits/trait.FixedOptionalFeatures.html
[unw-1-5]: https://docs.rs/fixed/~1.5/fixed/struct.Unwrapped.html
2020-10-22 02:45:51 -07:00
Version 1.4.0 (2020-10-22)
2020-10-20 03:10:49 -07:00
==========================
* The following methods were added to all fixed-point types, to the
[`Fixed`][tf-1-4] trait, and to the [`Wrapping`][w-1-4] wrapper:
* [`recip`][f-rec-1-4], [`checked_recip`][f-crec-1-4],
2021-04-20 03:57:09 -07:00
[`saturating_recip`][f-srec-1-4], [`wrapping_recip`][f-wrec-1-4],
[`overflowing_recip`][f-orec-1-4]
2021-04-20 03:57:09 -07:00
* For the experimental feature [`num-traits`][feat-exp-1-4], the following
traits were implemented where applicable ([issue 23]):
2020-10-20 07:02:43 -07:00
* [`Num`][nt-0-2-num]
* [`Signed`][nt-0-2-signed], [`Unsigned`][nt-0-2-unsigned]
* [`Inv`][nt-0-2-inv]
* [`MulAdd`][nt-0-2-ma], [`MulAddAssign`][nt-0-2-maa]
* [`FloatConst`][nt-0-2-fc]
* [`ToPrimitive`][nt-0-2-tp], [`FromPrimitive`][nt-0-2-fp]
2021-04-20 03:57:09 -07:00
* For the experimental feature [`serde-str`][feat-exp-1-4], 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.
2020-10-20 03:10:49 -07:00
2020-10-22 02:45:51 -07:00
[f-crec-1-4]: https://docs.rs/fixed/~1.4/fixed/struct.FixedI32.html#method.checked_recip
[f-orec-1-4]: https://docs.rs/fixed/~1.4/fixed/struct.FixedI32.html#method.overflowing_recip
[f-rec-1-4]: https://docs.rs/fixed/~1.4/fixed/struct.FixedI32.html#method.recip
[f-srec-1-4]: https://docs.rs/fixed/~1.4/fixed/struct.FixedI32.html#method.saturating_recip
[f-wrec-1-4]: https://docs.rs/fixed/~1.4/fixed/struct.FixedI32.html#method.wrapping_recip
2021-04-21 04:01:55 -07:00
[feat-exp-1-4]: https://docs.rs/fixed/~1.4/fixed/index.html#experimental-optional-features
2020-10-20 07:02:43 -07:00
[issue 23]: https://gitlab.com/tspiteri/fixed/-/issues/23
[issue 24]: https://gitlab.com/tspiteri/fixed/-/issues/24
[nt-0-2-fc]: https://docs.rs/num-traits/^0.2/num_traits/float/trait.FloatConst.html
[nt-0-2-fp]: https://docs.rs/num-traits/^0.2/num_traits/cast/trait.FromPrimitive.html
[nt-0-2-inv]: https://docs.rs/num-traits/^0.2/num_traits/ops/inv/trait.Inv.html
[nt-0-2-ma]: https://docs.rs/num-traits/^0.2/num_traits/ops/mul_add/trait.MulAdd.html
[nt-0-2-maa]: https://docs.rs/num-traits/^0.2/num_traits/ops/mul_add/trait.MulAddAssign.html
[nt-0-2-num]: https://docs.rs/num-traits/^0.2/num_traits/trait.Num.html
[nt-0-2-signed]: https://docs.rs/num-traits/^0.2/num_traits/sign/trait.Signed.html
[nt-0-2-tp]: https://docs.rs/num-traits/^0.2/num_traits/cast/trait.ToPrimitive.html
[nt-0-2-unsigned]: https://docs.rs/num-traits/^0.2/num_traits/sign/trait.Unsigned.html
2020-10-22 02:45:51 -07:00
[tf-1-4]: https://docs.rs/fixed/~1.4/fixed/traits/trait.Fixed.html
[w-1-4]: https://docs.rs/fixed/~1.4/fixed/struct.Wrapping.html
2020-10-20 03:10:49 -07:00
2020-10-15 09:48:04 -07:00
Version 1.3.0 (2020-10-15)
2020-09-17 07:58:26 -07:00
==========================
2021-04-20 03:57:09 -07:00
* The [`MulAssign`] implementation on fixed-point numbers now accepts an rhs
fixed-point number with a different number of fractional bits from `self`.
2020-09-22 08:20:13 -07:00
* The following methods were added to all fixed-point types, to the
[`Fixed`][tf-1-3] trait, and to the [`Wrapping`][w-1-3] wrapper:
2020-09-22 06:47:13 -07:00
* [`mul_add`][f-ma-1-3], [`checked_mul_add`][f-cma-1-3],
2021-04-20 03:57:09 -07:00
[`saturating_mul_add`][f-sma-1-3], [`wrapping_mul_add`][f-wma-1-3],
2020-09-22 06:47:13 -07:00
[`overflowing_mul_add`][f-oma-1-3]
2021-04-20 03:57:09 -07:00
* The new experimental feature [`unwrapped`][feat-exp-1-3] was added,
providing arithmetic methods that panic on overflow even when debug
assertions are disabled.
* The new experimental feature [`serde-str`][feat-exp-1-3] was added, which
makes serialization use the numbers value in human-readable formats.
2020-09-17 07:58:26 -07:00
2020-10-15 09:48:04 -07:00
[f-cma-1-3]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI32.html#method.checked_mul_add
[f-ma-1-3]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI32.html#method.mul_add
[f-oma-1-3]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI32.html#method.overflowing_mul_add
[f-sma-1-3]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI32.html#method.saturating_mul_add
[f-wma-1-3]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI32.html#method.wrapping_mul_add
2021-04-21 04:01:55 -07:00
[feat-exp-1-3]: https://docs.rs/fixed/~1.3/fixed/index.html#experimental-optional-features
2020-10-15 09:48:04 -07:00
[tf-1-3]: https://docs.rs/fixed/~1.3/fixed/traits/trait.Fixed.html
[w-1-3]: https://docs.rs/fixed/~1.3/fixed/struct.Wrapping.html
2020-09-17 07:58:26 -07:00
2020-09-02 04:50:04 -07:00
Version 1.2.0 (2020-09-02)
2020-08-28 09:27:23 -07:00
==========================
2021-04-20 03:57:09 -07:00
* The [`const_fixed_from_int!`][cffi-1-2] macro was added to make it easy to
define constant fixed-point numbers using integer expressions ([issue 20]).
2020-08-28 09:27:23 -07:00
2020-09-02 04:50:04 -07:00
[cffi-1-2]: https://docs.rs/fixed/~1.2/fixed/macro.const_fixed_from_int.html
[issue 20]: https://gitlab.com/tspiteri/fixed/-/issues/20
2020-08-28 09:27:23 -07:00
2020-07-20 23:42:56 -07:00
Version 1.1.0 (2020-07-21)
==========================
2021-04-20 03:57:09 -07:00
* The new experimental feature [`num-traits`][feat-nt-1-1] was added to
implement some traits, and to also add the relevant traits as supertraits to
the [`FixedOptionalFeatures`][fof-1-1] trait ([issue 18]).
2020-07-20 23:42:56 -07:00
[issue 18]: https://gitlab.com/tspiteri/fixed/-/issues/18
2021-04-21 04:01:55 -07:00
[feat-nt-1-1]: https://docs.rs/fixed/~1.1/fixed/index.html#experimental-optional-features
2020-07-20 23:42:56 -07:00
[fof-1-1]: https://docs.rs/fixed/~1.1/fixed/traits/trait.FixedOptionalFeatures.html
2020-06-04 09:59:55 -07:00
Version 1.0.0 (2020-06-04)
2020-05-01 09:28:17 -07:00
==========================
* The crate now requires rustc version 1.44.0 or later.
* The following methods are now `const` functions:
* [`from_be_bytes`][f-fbb-1-0], [`from_le_bytes`][f-flb-1-0],
[`from_ne_bytes`][f-fnb-1-0]
* [`to_be_bytes`][f-tbb-1-0], [`to_le_bytes`][f-tlb-1-0],
[`to_ne_bytes`][f-tnb-1-0]
* All deprecated items were removed.
2020-06-04 09:59:55 -07:00
[f-fbb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.from_be_bytes
[f-flb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.from_le_bytes
[f-fnb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.from_ne_bytes
[f-tbb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.to_be_bytes
[f-tlb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.to_le_bytes
[f-tnb-1-0]: https://docs.rs/fixed/~1.0/fixed/struct.FixedI32.html#method.to_ne_bytes
2020-05-11 11:13:11 -07:00
Version 0.5.7 (2020-05-11)
==========================
* The `LosslessTryFrom` and `LosslessTryInto` traits were added.
2021-04-20 03:57:09 -07:00
* The following methods were added to all fixed-point types, to the `Fixed`
trait, and to the `Wrapping` wrapper:
2020-05-09 16:09:41 -07:00
* `leading_ones`, `trailing_ones`
2021-04-20 03:57:09 -07:00
* The following method was added to unsigned fixed-point types and to the
`FixedUnsigned` trait:
2020-05-09 16:13:24 -07:00
* `wrapping_next_power_of_two`
2021-04-20 03:57:09 -07:00
* The `PHI` and `FRAC_1_PHI` constants were added to the `consts` module and
as associated constants to fixed-point types.
2020-05-01 09:28:17 -07:00
2020-05-01 09:15:40 -07:00
Version 0.5.6 (2020-05-01)
2020-04-17 17:21:17 -07:00
==========================
2021-04-20 03:57:09 -07:00
* The following methods were added to signed fixed-point types and to the
`FixedSigned` trait:
2020-05-01 09:28:17 -07:00
* `checked_signum`, `saturating_signum`, `wrapping_signum`,
2020-05-01 08:40:53 -07:00
`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.
2020-04-18 09:15:22 -07:00
2020-04-16 14:29:50 -07:00
Version 0.5.5 (2020-04-16)
2020-04-11 08:44:09 -07:00
==========================
2021-04-20 03:57:09 -07:00
* 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:
2020-04-12 18:17:21 -07:00
* `MIN`, `MAX`
2021-04-20 03:57:09 -07:00
* The following associated constants were added to the `Fixed` trait and to
the `Wrapping` wrapper:
2020-04-12 18:17:21 -07:00
* `INT_NBITS`, `FRAC_NBITS`
2021-04-20 03:57:09 -07:00
* The following methods were added to all fixed-point types and to the `Fixed`
trait:
2020-04-12 18:17:21 -07:00
* `int_log2`, `int_log10`
* `checked_int_log2`, `checked_int_log10`
* The following methods were added to the `Wrapping` wrapper:
* `int_log2`, `int_log10`
2021-04-20 03:57:09 -07:00
* The constants in the `consts` module were also added as associated constants
to fixed-point types that can represent them.
2020-04-11 09:31:31 -07:00
* The following methods were deprecated:
* `min_value`, `max_value`
* `int_nbits`, `frac_nbits`
2020-04-11 08:44:09 -07:00
2020-02-21 07:34:27 -08:00
Version 0.5.4 (2020-02-21)
==========================
2021-04-20 03:57:09 -07:00
* Bug fix: `rem_euclid_int` and its checked versions were handling overflow
incorrectly.
2020-02-13 03:18:22 -08:00
Version 0.5.3 (2020-02-13)
==========================
2021-04-20 03:57:09 -07:00
* 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).
2021-04-20 03:57:09 -07:00
* Bug fix: Euclidean division operations by integers were giving an incorrect
answer.
* `Rem` and `RemAssign` were implemented for fixed-point numbers.
2021-04-20 03:57:09 -07:00
* The following methods were added to all fixed-point types and to the `Fixed`
trait:
2020-04-12 18:17:21 -07:00
* `checked_rem`
* `div_euclid`, `rem_euclid`
* `checked_div_euclid`, `checked_rem_euclid`
* `saturating_div_euclid`
* `wrapping_div_euclid`
* `overflowing_div_euclid`
2020-02-12 14:51:31 -08:00
* The following methods were added to the `Wrapping` wrapper:
2020-04-12 18:17:21 -07:00
* `div_euclid`, `rem_euclid`
* `div_euclid_int`, `rem_euclid_int`
* The following methods were deprecated:
* `wrapping_rem_int`, `overflowing_rem_int`
2020-02-02 12:02:14 -08:00
Version 0.5.2 (2020-02-02)
==========================
* `Wrapping` now supports serialization. (Thanks: Shane Pearman)
2019-12-23 09:15:31 -08:00
Version 0.5.1 (2019-12-22)
==========================
2021-04-20 03:57:09 -07:00
* `ParseFixedError` implements `Error` when the new `std` feature is enabled.
2019-12-23 09:15:31 -08:00
2019-12-06 02:46:41 -08:00
Version 0.5.0 (2019-12-06)
==========================
* The crate now requires rustc version 1.39.0 or later.
2021-04-20 03:57:09 -07:00
* The following methods were added to all fixed-point types and to the `Fixed`
trait:
2019-11-24 11:20:46 -08:00
* `from_be_bytes`, `from_le_bytes`, `from_ne_bytes`
2020-04-12 18:17:21 -07:00
* `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.
2019-11-24 09:26:42 -08:00
Incompatible changes
--------------------
* Deprecated methods and modules were removed.
2019-11-24 09:47:06 -08:00
Version 0.4.6 (2019-10-16)
2019-10-10 08:13:36 -07:00
==========================
2021-04-20 03:57:09 -07:00
* Conversions to/from `bf16` are now provided when the `f16` option is
enabled.
2019-10-11 05:55:08 -07:00
* The following methods are now `const` functions: `saturating_neg`,
2021-04-20 03:57:09 -07:00
`saturating_add`, `saturating_sub`, `saturating_mul_int`, `saturating_abs`
2019-10-10 08:13:36 -07:00
* Support for casts using the *az* crate was added.
2019-08-30 13:32:17 -07:00
Version 0.4.5 (2019-08-30)
2019-08-29 01:12:17 -07:00
==========================
2021-04-20 03:57:09 -07:00
* 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.
2019-08-29 01:12:17 -07:00
2019-08-24 04:15:28 -07:00
Version 0.4.4 (2019-08-24)
2019-08-21 04:30:49 -07:00
==========================
2021-04-20 03:57:09 -07:00
* 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`
2019-08-22 04:33:23 -07:00
* The method `round_to_zero` was added.
2021-04-20 03:57:09 -07:00
* The method `round_ties_to_even` and its checked versions were added.
2019-08-21 04:30:49 -07:00
2019-08-20 10:40:53 -07:00
Version 0.4.3 (2019-08-20)
==========================
* The crate now requires rustc version 1.34.0 or later.
2021-04-20 03:57:09 -07:00
* 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`
2019-08-21 13:15:36 -07:00
* `count_ones`, `count_zeros`, `leading_zeros`, `trailing_zeros`
2019-08-17 08:10:55 -07:00
`rotate_left`, `rotate_right`
2021-04-20 03:57:09 -07:00
* `wrapping_neg`, `wrapping_add`, `wrapping_sub`, `wrapping_mul_int`,
`wrapping_shl`, `wrapping_shr`
2019-08-21 13:15:36 -07:00
* `overflowing_neg`, `overflowing_add`, `overflowing_sub`,
2019-08-17 08:10:55 -07:00
`overflowing_mul_int`, `overflowing_shl`, `overflowing_shr`
* `is_positive`, `is_negative`
* The associated constants `INT_NBITS` and `FRAC_NBITS` were added.
2021-04-20 03:57:09 -07:00
* The reexports in the `frac` module and the `LeEqU*` traits were moved into
the new `types::extra` module.
2019-08-16 14:25:19 -07:00
Version 0.4.2 (2019-08-16)
==========================
2021-04-20 03:57:09 -07:00
* 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.
2020-02-12 14:51:31 -08:00
* The new method `from_num` was added to the `Wrapping` wrapper.
2021-04-20 03:57:09 -07:00
* 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 3132) and 0.96875 (3132) are now parsed
correctly as 0.9375 (1516) and 1.0.
2019-08-12 04:20:13 -07:00
Version 0.4.1 (2019-08-12)
==========================
* All fixed-point types now implement `FromStr`.
2021-04-20 03:57:09 -07:00
* The methods `from_str_binary`, `from_str_octal` and `from_str_hex` were
added.
2019-08-08 14:25:05 -07:00
Version 0.4.0 (2019-08-08)
==========================
* The crate now requires rustc version 1.31.0 or later.
2021-04-20 03:57:09 -07:00
* 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.
2019-08-06 09:53:41 -07:00
* The `consts` module was added.
2019-08-08 14:25:05 -07:00
* The `signum` method now wraps instead of panics in release mode.
2019-08-06 09:53:41 -07:00
Incompatible changes
--------------------
2021-04-20 03:57:09 -07:00
* The sealed traits `Int` and `Float` now have no provided methods; the
methods in the old implementation are now provided by `FromFixed` and
`ToFixed`.
2019-08-08 13:47:49 -07:00
* Deprecated methods were removed.
2019-08-08 14:25:05 -07:00
Contributors
------------
* @jean-airoldie
* @tspiteri
2019-06-27 14:54:28 -07:00
Version 0.3.3 (2019-06-27)
==========================
* Conversions to/from `isize` and `usize` were added.
2019-02-27 13:52:15 -08:00
Version 0.3.2 (2019-02-27)
==========================
* The `Wrapping` wrapper was added.
2019-02-06 15:59:41 -08:00
Version 0.3.1 (2019-02-07)
==========================
2021-04-20 03:57:09 -07:00
* Reimplement `From<bool>` for all fixed-point types which can represent the
integer 1. This was inadvertently removed in 0.3.0.
2019-02-03 12:37:17 -08:00
Version 0.3.0 (2019-02-03)
2019-01-29 14:15:38 -08:00
==========================
* Incompatible change: the return type of `to_int` is now generic.
2021-04-20 03:57:09 -07:00
* Incompatible change: the `Int` trait implementation for `bool` was removed.
* The new method `to_fixed` was added.
2021-04-20 03:57:09 -07:00
* 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`,
2021-04-20 03:57:09 -07:00
`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`,
2021-04-20 03:57:09 -07:00
`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`.
2019-01-29 14:15:38 -08:00
2019-01-29 13:08:50 -08:00
Version 0.2.1 (2019-01-29)
2019-01-29 09:34:12 -08:00
==========================
2021-04-20 03:57:09 -07:00
* 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.
2019-01-29 09:34:12 -08:00
2019-01-28 18:35:42 -08:00
Version 0.2.0 (2019-01-29)
==========================
2021-04-20 03:57:09 -07:00
* 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.
2021-04-20 03:57:09 -07:00
* The new methods `from_float`, `checked_from_float`, `saturating_from_float`,
`wrapping_from_float` and `overflowing_from_float` were added.
2019-01-28 18:35:42 -08:00
* The new method `to_float` was added.
2021-04-20 03:57:09 -07:00
* 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`,
2019-01-28 18:35:42 -08:00
`overflowing_floor` and `overflowing_round` were added.
* The methods `to_int_ceil`, `to_int_floor` and `to_int_round` were
deprecated.
2019-01-26 15:39:24 -08:00
Version 0.1.6 (2019-01-27)
==========================
* Optional serde support was added.
2019-01-26 13:02:58 -08:00
Version 0.1.5 (2019-01-26)
==========================
2021-04-20 03:57:09 -07:00
* 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.
2018-11-29 00:55:39 -08:00
Version 0.1.4 (2018-11-29)
2018-11-03 09:23:18 -07:00
==========================
* Division is now implemented for `FixedI128` and `FixedU128`.
2018-08-23 04:32:59 -07:00
Version 0.1.3 (2018-08-23)
2018-08-23 04:12:32 -07:00
==========================
2021-04-20 03:57:09 -07:00
* The `f16` feature was added, and new methods `from_f16` and `to_f16` were
added.
2018-08-23 04:12:32 -07:00
2018-08-15 11:14:36 -07:00
Version 0.1.2 (2018-08-15)
2018-08-12 03:11:28 -07:00
==========================
* The crate can now be used without the standard library `std`.
2018-08-13 15:21:29 -07:00
* New methods `from_f32` and `from_f64` were added.
2021-04-20 03:57:09 -07:00
* New methods `is_positive` and `is_negative` were added to signed fixed-point
numbers.
2018-08-12 03:11:28 -07:00
2018-08-11 12:10:03 -07:00
Version 0.1.1 (2018-08-11)
==========================
2021-04-20 03:57:09 -07:00
* 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.
2021-04-20 03:57:09 -07:00
* 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.
2018-08-10 11:57:59 -07:00
Version 0.1.0 (2018-08-10)
==========================
2021-04-20 03:57:09 -07:00
* `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.
2020-09-22 10:09:41 -07:00
2021-08-17 01:50:22 -07:00
[*arbitrary* crate]: https://crates.io/crates/arbitrary
2021-02-03 02:17:52 -08:00
[*az* crate]: https://crates.io/crates/az
2021-04-21 04:01:55 -07:00
[*bytemuck* crate]: https://crates.io/crates/bytemuck
[*typenum* crate]: https://crates.io/crates/typenum
[`Debug`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html
[`DivAssign`]: https://doc.rust-lang.org/nightly/core/ops/trait.DivAssign.html
[`Div`]: https://doc.rust-lang.org/nightly/core/ops/trait.Div.html
[`MulAssign`]: https://doc.rust-lang.org/nightly/core/ops/trait.MulAssign.html
[`NonZeroI32`]: https://doc.rust-lang.org/nightly/core/num/struct.NonZeroI32.html
[`NonZeroU32`]: https://doc.rust-lang.org/nightly/core/num/struct.NonZeroU32.html
[`Product`]: https://doc.rust-lang.org/nightly/core/iter/trait.Product.html
[`RemAssign`]: https://doc.rust-lang.org/nightly/core/ops/trait.RemAssign.html
[`Rem`]: https://doc.rust-lang.org/nightly/core/ops/trait.Rem.html
[`Sum`]: https://doc.rust-lang.org/nightly/core/iter/trait.Sum.html