blockworks-foundation
/
fixed
mirror of https://github.com/blockworks-foundation/fixed.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

version 0.5.5

This commit is contained in:
Trevor Spiteri 2020-04-16 23:29:50 +02:00
parent 289f4b1697
commit 97d4e1a326
5 changed files with 61 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Cargo.toml
View File

@ -7,7 +7,7 @@
[package] [package]
name = "fixed" name = "fixed"
version = "0.5.4" version = "0.5.5"
authors = ["Trevor Spiteri <tspiteri@ieee.org>"] authors = ["Trevor Spiteri <tspiteri@ieee.org>"]
description = "Fixed-point numbers" description = "Fixed-point numbers"
documentation = "https://docs.rs/fixed" documentation = "https://docs.rs/fixed"

150
README.md
View File

@ -74,11 +74,11 @@ The conversions supported cover the following cases.
## What’s new ## What’s new
### Version 0.5.5 news (unreleased) ### Version 0.5.5 news (2020-04-16)
* Bug fix: comparison between a signed fixed-point number of type * Bug fix: an incorrect result could be given when comparing a
`FixedI` and a number that would overflow when converting to signed fixed-point number of type `FixedI` to a number that would
`FixedI` by exactly one bit was giving an incorrect result. overflow by exactly one bit when converting to `FixedI`.
* The following associated constants were added to all fixed-point * The following associated constants were added to all fixed-point
types, to the [`Fixed`] trait, and to the [`Wrapping`] wrapper: types, to the [`Fixed`] trait, and to the [`Wrapping`] wrapper:
* [`MIN`], [`MAX`] * [`MIN`], [`MAX`]
@ -89,11 +89,10 @@ The conversions supported cover the following cases.
the [`Fixed`] trait: the [`Fixed`] trait:
* [`int_log2`], [`int_log10`] * [`int_log2`], [`int_log10`]
* [`checked_int_log2`], [`checked_int_log10`] * [`checked_int_log2`], [`checked_int_log10`]
* The constants inside the [`consts`] module are now also available
as associated constants when they are representable by a
fixed-point number.
* The following methods were added to the [`Wrapping`] wrapper: * The following methods were added to the [`Wrapping`] wrapper:
* [`int_log2`][wril2], [`int_log10`][wril10] * [`int_log2`][wril2], [`int_log10`][wril10]
* 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: * The following methods were deprecated:
* [`min_value`], [`max_value`] * [`min_value`], [`max_value`]
* [`int_nbits`][`int_nbits()`], [`frac_nbits`][`frac_nbits()`] * [`int_nbits`][`int_nbits()`], [`frac_nbits`][`frac_nbits()`]
@ -103,70 +102,23 @@ The conversions supported cover the following cases.
* Bug fix: [`rem_euclid_int`] and its checked versions were handling * Bug fix: [`rem_euclid_int`] and its checked versions were handling
overflow incorrectly. overflow incorrectly.
### Version 0.5.3 news (2020-02-13) [`FRAC_NBITS`]: https://docs.rs/fixed/0.5.5/fixed/traits/trait.Fixed.html#associatedconstant.FRAC_NBITS
[`Fixed`]: https://docs.rs/fixed/0.5.5/fixed/traits/trait.Fixed.html
* Bug fix: [`round_to_zero`] was returning incorrect results for [`INT_NBITS`]: https://docs.rs/fixed/0.5.5/fixed/traits/trait.Fixed.html#associatedconstant.INT_NBITS
negative whole number operands. [`MAX`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#associatedconstant.MAX
* Bug fix: all remainder operations with a fixed-point LHS and an [`MIN`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#associatedconstant.MIN
integer RHS were giving an incorrect answer ([issue 13]). [`Wrapping`]: https://docs.rs/fixed/0.5.5/fixed/struct.Wrapping.html
* Bug fix: Euclidean division operations by integers were giving an [`checked_int_log10`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.checked_int_log10
incorrect answer. [`checked_int_log2`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.checked_int_log2
* [`Rem`] and [`RemAssign`] were implemented for fixed-point [`frac_nbits()`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.frac_nbits
numbers. [`int_log10`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.int_log10
* The following methods were added to all fixed-point types and to [`int_log2`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.int_log2
the [`Fixed`] trait: [`int_nbits()`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.int_nbits
* [`checked_rem`] [`max_value`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.max_value
* [`div_euclid`], [`rem_euclid`] [`min_value`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.min_value
* [`checked_div_euclid`], [`checked_rem_euclid`] [`rem_euclid_int`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.rem_euclid_int
* [`saturating_div_euclid`] [wril10]: https://docs.rs/fixed/0.5.5/fixed/struct.Wrapping.html#method.int_log10
* [`wrapping_div_euclid`] [wril2]: https://docs.rs/fixed/0.5.5/fixed/struct.Wrapping.html#method.int_log2
* [`overflowing_div_euclid`]
* The following methods were added to the [`Wrapping`] wrapper:
* [`div_euclid`][wde], [`rem_euclid`][wre]
* [`div_euclid_int`][wdei], [`rem_euclid_int`][wrei]
* The following methods were deprecated:
* [`wrapping_rem_int`], [`overflowing_rem_int`]
### Version 0.5.2 news (2020-02-02)
* [`Wrapping`] now supports serialization. (Thanks: Shane Pearman)
[`FRAC_NBITS`]: https://docs.rs/fixed/0.5.4/fixed/traits/trait.Fixed.html#associatedconstant.FRAC_NBITS
[`Fixed`]: https://docs.rs/fixed/0.5.4/fixed/traits/trait.Fixed.html
[`INT_NBITS`]: https://docs.rs/fixed/0.5.4/fixed/traits/trait.Fixed.html#associatedconstant.INT_NBITS
[`MAX`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#associatedconstant.MAX
[`MIN`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#associatedconstant.MIN
[`RemAssign`]: https://doc.rust-lang.org/nightly/core/ops/trait.RemAssign.html
[`Rem`]: https://doc.rust-lang.org/nightly/core/ops/trait.Rem.html
[`Wrapping`]: https://docs.rs/fixed/0.5.4/fixed/struct.Wrapping.html
[`checked_div_euclid`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.checked_div_euclid
[`checked_int_log10`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.checked_int_log10
[`checked_int_log2`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.checked_int_log2
[`checked_rem_euclid`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.checked_rem_euclid
[`checked_rem`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.checked_rem
[`consts`]: https://docs.rs/fixed/0.5.4/fixed/consts/index.html
[`div_euclid`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.div_euclid
[`frac_nbits()`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.frac_nbits
[`int_log10`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.int_log10
[`int_log2`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.int_log2
[`int_nbits()`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.int_nbits
[`max_value`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.max_value
[`min_value`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.min_value
[`overflowing_div_euclid`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.overflowing_div_euclid
[`overflowing_rem_int`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.overflowing_rem_int
[`rem_euclid_int`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.rem_euclid_int
[`rem_euclid`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.rem_euclid
[`round_to_zero`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.round_to_zero
[`saturating_div_euclid`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.saturating_div_euclid
[`wrapping_div_euclid`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.wrapping_div_euclid
[`wrapping_rem_int`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.wrapping_rem_int
[issue 13]: https://gitlab.com/tspiteri/fixed/issues/13
[wde]: https://docs.rs/fixed/0.5.4/fixed/struct.Wrapping.html#method.div_euclid
[wdei]: https://docs.rs/fixed/0.5.4/fixed/struct.Wrapping.html#method.div_euclid_int
[wre]: https://docs.rs/fixed/0.5.4/fixed/struct.Wrapping.html#method.rem_euclid
[wrei]: https://docs.rs/fixed/0.5.4/fixed/struct.Wrapping.html#method.rem_euclid_int
[wril10]: https://docs.rs/fixed/0.5.4/fixed/struct.Wrapping.html#method.int_log10
[wril2]: https://docs.rs/fixed/0.5.4/fixed/struct.Wrapping.html#method.int_log2
### Other releases ### Other releases
@ -236,7 +188,7 @@ it in your crate, add it as a dependency inside [*Cargo.toml*]:
```toml ```toml
[dependencies] [dependencies]
fixed = "0.5.4" fixed = "0.5.5"
``` ```
The *fixed* crate requires rustc version 1.39.0 or later. The *fixed* crate requires rustc version 1.39.0 or later.
@ -261,7 +213,7 @@ To enable features, you can add the dependency like this to
```toml ```toml
[dependencies.fixed] [dependencies.fixed]
version = "0.5.4" version = "0.5.5"
features = ["f16", "serde"] features = ["f16", "serde"]
``` ```
@ -294,38 +246,38 @@ additional terms or conditions.
[`Binary`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Binary.html [`Binary`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Binary.html
[`Display`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html [`Display`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html
[`Error`]: https://doc.rust-lang.org/nightly/std/error/trait.Error.html [`Error`]: https://doc.rust-lang.org/nightly/std/error/trait.Error.html
[`FixedI128`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI128.html [`FixedI128`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI128.html
[`FixedI16`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI16.html [`FixedI16`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI16.html
[`FixedI32`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html [`FixedI32`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html
[`FixedI64`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI64.html [`FixedI64`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI64.html
[`FixedI8`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI8.html [`FixedI8`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI8.html
[`FixedU128`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedU128.html [`FixedU128`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedU128.html
[`FixedU16`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedU16.html [`FixedU16`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedU16.html
[`FixedU32`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedU32.html [`FixedU32`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedU32.html
[`FixedU64`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedU64.html [`FixedU64`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedU64.html
[`FixedU8`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedU8.html [`FixedU8`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedU8.html
[`FromFixed`]: https://docs.rs/fixed/0.5.4/fixed/traits/trait.FromFixed.html [`FromFixed`]: https://docs.rs/fixed/0.5.5/fixed/traits/trait.FromFixed.html
[`FromStr`]: https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html [`FromStr`]: https://doc.rust-lang.org/nightly/core/str/trait.FromStr.html
[`From`]: https://doc.rust-lang.org/nightly/core/convert/trait.From.html [`From`]: https://doc.rust-lang.org/nightly/core/convert/trait.From.html
[`I20F12`]: https://docs.rs/fixed/0.5.4/fixed/types/type.I20F12.html [`I20F12`]: https://docs.rs/fixed/0.5.5/fixed/types/type.I20F12.html
[`I4F12`]: https://docs.rs/fixed/0.5.4/fixed/types/type.I4F12.html [`I4F12`]: https://docs.rs/fixed/0.5.5/fixed/types/type.I4F12.html
[`I4F4`]: https://docs.rs/fixed/0.5.4/fixed/types/type.I4F4.html [`I4F4`]: https://docs.rs/fixed/0.5.5/fixed/types/type.I4F4.html
[`Into`]: https://doc.rust-lang.org/nightly/core/convert/trait.Into.html [`Into`]: https://doc.rust-lang.org/nightly/core/convert/trait.Into.html
[`LossyFrom`]: https://docs.rs/fixed/0.5.4/fixed/traits/trait.LossyFrom.html [`LossyFrom`]: https://docs.rs/fixed/0.5.5/fixed/traits/trait.LossyFrom.html
[`LossyInto`]: https://docs.rs/fixed/0.5.4/fixed/traits/trait.LossyInto.html [`LossyInto`]: https://docs.rs/fixed/0.5.5/fixed/traits/trait.LossyInto.html
[`LowerHex`]: https://doc.rust-lang.org/nightly/core/fmt/trait.LowerHex.html [`LowerHex`]: https://doc.rust-lang.org/nightly/core/fmt/trait.LowerHex.html
[`Octal`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Octal.html [`Octal`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Octal.html
[`ParseFixedError`]: https://docs.rs/fixed/0.5.4/fixed/struct.ParseFixedError.html [`ParseFixedError`]: https://docs.rs/fixed/0.5.5/fixed/struct.ParseFixedError.html
[`ToFixed`]: https://docs.rs/fixed/0.5.4/fixed/traits/trait.ToFixed.html [`ToFixed`]: https://docs.rs/fixed/0.5.5/fixed/traits/trait.ToFixed.html
[`U12`]: https://docs.rs/fixed/0.5.4/fixed/types/extra/type.U12.html [`U12`]: https://docs.rs/fixed/0.5.5/fixed/types/extra/type.U12.html
[`U20F12`]: https://docs.rs/fixed/0.5.4/fixed/types/type.U20F12.html [`U20F12`]: https://docs.rs/fixed/0.5.5/fixed/types/type.U20F12.html
[`UpperHex`]: https://doc.rust-lang.org/nightly/core/fmt/trait.UpperHex.html [`UpperHex`]: https://doc.rust-lang.org/nightly/core/fmt/trait.UpperHex.html
[`bf16`]: https://docs.rs/half/^1/half/struct.bf16.html [`bf16`]: https://docs.rs/half/^1/half/struct.bf16.html
[`checked_from_num`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.checked_from_num [`checked_from_num`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.checked_from_num
[`f16`]: https://docs.rs/half/^1/half/struct.f16.html [`f16`]: https://docs.rs/half/^1/half/struct.f16.html
[`from_num`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.from_num [`from_num`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.from_num
[`from_str_binary`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.from_str_binary [`from_str_binary`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.from_str_binary
[`from_str_hex`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.from_str_hex [`from_str_hex`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.from_str_hex
[`from_str_octal`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.from_str_octal [`from_str_octal`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.from_str_octal
[`to_num`]: https://docs.rs/fixed/0.5.4/fixed/struct.FixedI32.html#method.to_num [`to_num`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.to_num
[const generics]: https://github.com/rust-lang/rust/issues/44580 [const generics]: https://github.com/rust-lang/rust/issues/44580

13
RELEASES.md
View File

@ -5,27 +5,26 @@ modification, are permitted in any medium without royalty provided the
copyright notice and this notice are preserved. This file is offered copyright notice and this notice are preserved. This file is offered
as-is, without any warranty. --> as-is, without any warranty. -->
Version 0.5.5 (unreleased) Version 0.5.5 (2020-04-16)
========================== ==========================
* Bug fix: comparison between a signed fixed-point number of type * Bug fix: an incorrect result could be given when comparing a
`FixedI` and a number that would overflow when converting to signed fixed-point number of type `FixedI` to a number that would
`FixedI` by exactly one bit was giving an incorrect result. overflow by exactly one bit when converting to `FixedI`.
* The following associated constants were added to all fixed-point * The following associated constants were added to all fixed-point
types, to the `Fixed` trait, and to the `Wrapping` wrapper: types, to the `Fixed` trait, and to the `Wrapping` wrapper:
* `MIN`, `MAX` * `MIN`, `MAX`
* The following associated constants were added to the `Fixed` trait * The following associated constants were added to the `Fixed` trait
and to the `Wrapping` wrapper: and to the `Wrapping` wrapper:
* `INT_NBITS`, `FRAC_NBITS` * `INT_NBITS`, `FRAC_NBITS`
* The constants inside the `consts` module are now also available as
associated constants when they are representable by a fixed-point
number.
* The following methods were added to all fixed-point types and to * The following methods were added to all fixed-point types and to
the `Fixed` trait: the `Fixed` trait:
* `int_log2`, `int_log10` * `int_log2`, `int_log10`
* `checked_int_log2`, `checked_int_log10` * `checked_int_log2`, `checked_int_log10`
* The following methods were added to the `Wrapping` wrapper: * The following methods were added to the `Wrapping` wrapper:
* `int_log2`, `int_log10` * `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: * The following methods were deprecated:
* `min_value`, `max_value` * `min_value`, `max_value`
* `int_nbits`, `frac_nbits` * `int_nbits`, `frac_nbits`

1
src/float_helper.rs
View File

@ -66,7 +66,6 @@ macro_rules! sealed_float {
} }
#[inline] #[inline]
#[allow(clippy::cast_lossless)]
fn parts(self) -> (bool, i32, $Bits) { fn parts(self) -> (bool, i32, $Bits) {
let bits = self.to_bits(); let bits = self.to_bits();
let neg = bits & Self::SIGN_MASK != 0; let neg = bits & Self::SIGN_MASK != 0;

7
src/lib.rs
View File

@ -143,7 +143,7 @@ it in your crate, add it as a dependency inside [*Cargo.toml*]:
```toml ```toml
[dependencies] [dependencies]
fixed = "0.5.4" fixed = "0.5.5"
``` ```
The *fixed* crate requires rustc version 1.39.0 or later. The *fixed* crate requires rustc version 1.39.0 or later.
@ -168,7 +168,7 @@ To enable features, you can add the dependency like this to
```toml ```toml
[dependencies.fixed] [dependencies.fixed]
version = "0.5.4" version = "0.5.5"
features = ["f16", "serde"] features = ["f16", "serde"]
``` ```
@ -239,10 +239,9 @@ additional terms or conditions.
*/ */
#![cfg_attr(not(feature = "std"), no_std)] #![cfg_attr(not(feature = "std"), no_std)]
#![warn(missing_docs)] #![warn(missing_docs)]
#![doc(html_root_url = "https://docs.rs/fixed/0.5.4")] #![doc(html_root_url = "https://docs.rs/fixed/0.5.5")]
#![doc(test(attr(deny(warnings))))] #![doc(test(attr(deny(warnings))))]
#![cfg_attr(feature = "fail-on-warnings", deny(warnings))] #![cfg_attr(feature = "fail-on-warnings", deny(warnings))]
#![allow(clippy::type_repetition_in_bounds)]
#[cfg(all(not(feature = "std"), test))] #[cfg(all(not(feature = "std"), test))]
extern crate std; extern crate std;