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.6

This commit is contained in:
Trevor Spiteri 2020-05-01 18:15:40 +02:00
parent 86b542e7f3
commit 079a13ca1b
4 changed files with 48 additions and 89 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.5" version = "0.5.6"
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"

127
README.md
View File

@ -74,7 +74,13 @@ The conversions supported cover the following cases.
## What’s new ## What’s new
### Version 0.5.6 news (unreleased) ### Version 0.5.6 news (2020-05-01)
**This release is meant to be the last release before version 1.0.0:**
The plan is that the only differences between 0.5.6 and 1.0.0 will be
dependency updates and the removal of deprecated items.
Other news in this release:
* The following method were added to signed fixed-point types and to * The following method were added to signed fixed-point types and to
the [`FixedSigned`][tfs-0-5-6] trait: the [`FixedSigned`][tfs-0-5-6] trait:
@ -87,61 +93,14 @@ The conversions supported cover the following cases.
* Casts deprecated in version 0.3.1 of the *az* crate were marked as * Casts deprecated in version 0.3.1 of the *az* crate were marked as
deprecated. deprecated.
[f-csig-0-5-6]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.checked_signum [f-csig-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI32.html#method.checked_signum
[f-osig-0-5-6]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.overflowing_signum [f-osig-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI32.html#method.overflowing_signum
[f-ssig-0-5-6]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.saturating_signum [f-ssig-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI32.html#method.saturating_signum
[f-wsig-0-5-6]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.wrapping_signum [f-wsig-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI32.html#method.wrapping_signum
[lf-0-5-6]: https://tspiteri.gitlab.io/fixed/dev/fixed/traits/trait.LossyFrom.html [lf-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/traits/trait.LossyFrom.html
[li-0-5-6]: https://tspiteri.gitlab.io/fixed/dev/fixed/traits/trait.LossyInto.html [li-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/traits/trait.LossyInto.html
[pre-0-5-6]: https://tspiteri.gitlab.io/fixed/dev/fixed/prelude/index.html [pre-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/prelude/index.html
[tfs-0-5-6]: https://tspiteri.gitlab.io/fixed/dev/fixed/traits/trait.FixedSigned.html [tfs-0-5-6]: https://docs.rs/fixed/0.5.6/fixed/traits/trait.FixedSigned.html
### Version 0.5.5 news (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`][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:
* [`min_value`], [`max_value`]
* [`int_nbits`][`int_nbits()`], [`frac_nbits`][`frac_nbits()`]
### Version 0.5.4 news (2020-02-21)
* Bug fix: [`rem_euclid_int`] and its checked versions were handling
overflow incorrectly.
[`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
[`INT_NBITS`]: https://docs.rs/fixed/0.5.5/fixed/traits/trait.Fixed.html#associatedconstant.INT_NBITS
[`MAX`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#associatedconstant.MAX
[`MIN`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#associatedconstant.MIN
[`Wrapping`]: https://docs.rs/fixed/0.5.5/fixed/struct.Wrapping.html
[`checked_int_log10`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.checked_int_log10
[`checked_int_log2`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.checked_int_log2
[`consts`]: https://docs.rs/fixed/0.5.5/fixed/consts/index.html
[`frac_nbits()`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.frac_nbits
[`int_log10`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.int_log10
[`int_log2`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.int_log2
[`int_nbits()`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.int_nbits
[`max_value`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.max_value
[`min_value`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.min_value
[`rem_euclid_int`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.rem_euclid_int
[wril10]: https://docs.rs/fixed/0.5.5/fixed/struct.Wrapping.html#method.int_log10
[wril2]: https://docs.rs/fixed/0.5.5/fixed/struct.Wrapping.html#method.int_log2
### Other releases ### Other releases
@ -211,7 +170,7 @@ it in your crate, add it as a dependency inside [*Cargo.toml*]:
```toml ```toml
[dependencies] [dependencies]
fixed = "0.5.5" fixed = "0.5.6"
``` ```
The *fixed* crate requires rustc version 1.39.0 or later. The *fixed* crate requires rustc version 1.39.0 or later.
@ -236,7 +195,7 @@ To enable features, you can add the dependency like this to
```toml ```toml
[dependencies.fixed] [dependencies.fixed]
version = "0.5.5" version = "0.5.6"
features = ["f16", "serde"] features = ["f16", "serde"]
``` ```
@ -269,38 +228,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.5/fixed/struct.FixedI128.html [`FixedI128`]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI128.html
[`FixedI16`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI16.html [`FixedI16`]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI16.html
[`FixedI32`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html [`FixedI32`]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI32.html
[`FixedI64`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI64.html [`FixedI64`]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI64.html
[`FixedI8`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI8.html [`FixedI8`]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI8.html
[`FixedU128`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedU128.html [`FixedU128`]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedU128.html
[`FixedU16`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedU16.html [`FixedU16`]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedU16.html
[`FixedU32`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedU32.html [`FixedU32`]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedU32.html
[`FixedU64`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedU64.html [`FixedU64`]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedU64.html
[`FixedU8`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedU8.html [`FixedU8`]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedU8.html
[`FromFixed`]: https://docs.rs/fixed/0.5.5/fixed/traits/trait.FromFixed.html [`FromFixed`]: https://docs.rs/fixed/0.5.6/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.5/fixed/types/type.I20F12.html [`I20F12`]: https://docs.rs/fixed/0.5.6/fixed/types/type.I20F12.html
[`I4F12`]: https://docs.rs/fixed/0.5.5/fixed/types/type.I4F12.html [`I4F12`]: https://docs.rs/fixed/0.5.6/fixed/types/type.I4F12.html
[`I4F4`]: https://docs.rs/fixed/0.5.5/fixed/types/type.I4F4.html [`I4F4`]: https://docs.rs/fixed/0.5.6/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.5/fixed/traits/trait.LossyFrom.html [`LossyFrom`]: https://docs.rs/fixed/0.5.6/fixed/traits/trait.LossyFrom.html
[`LossyInto`]: https://docs.rs/fixed/0.5.5/fixed/traits/trait.LossyInto.html [`LossyInto`]: https://docs.rs/fixed/0.5.6/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.5/fixed/struct.ParseFixedError.html [`ParseFixedError`]: https://docs.rs/fixed/0.5.6/fixed/struct.ParseFixedError.html
[`ToFixed`]: https://docs.rs/fixed/0.5.5/fixed/traits/trait.ToFixed.html [`ToFixed`]: https://docs.rs/fixed/0.5.6/fixed/traits/trait.ToFixed.html
[`U12`]: https://docs.rs/fixed/0.5.5/fixed/types/extra/type.U12.html [`U12`]: https://docs.rs/fixed/0.5.6/fixed/types/extra/type.U12.html
[`U20F12`]: https://docs.rs/fixed/0.5.5/fixed/types/type.U20F12.html [`U20F12`]: https://docs.rs/fixed/0.5.6/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.5/fixed/struct.FixedI32.html#method.checked_from_num [`checked_from_num`]: https://docs.rs/fixed/0.5.6/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.5/fixed/struct.FixedI32.html#method.from_num [`from_num`]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI32.html#method.from_num
[`from_str_binary`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.from_str_binary [`from_str_binary`]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI32.html#method.from_str_binary
[`from_str_hex`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.from_str_hex [`from_str_hex`]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI32.html#method.from_str_hex
[`from_str_octal`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.from_str_octal [`from_str_octal`]: https://docs.rs/fixed/0.5.6/fixed/struct.FixedI32.html#method.from_str_octal
[`to_num`]: https://docs.rs/fixed/0.5.5/fixed/struct.FixedI32.html#method.to_num [`to_num`]: https://docs.rs/fixed/0.5.6/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

2
RELEASES.md
View File

@ -5,7 +5,7 @@ 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.6 (unreleased) Version 0.5.6 (2020-05-01)
========================== ==========================
* The following method were added to signed fixed-point types and to * The following method were added to signed fixed-point types and to

6
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.5" fixed = "0.5.6"
``` ```
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.5" version = "0.5.6"
features = ["f16", "serde"] features = ["f16", "serde"]
``` ```
@ -239,7 +239,7 @@ 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.5")] #![doc(html_root_url = "https://docs.rs/fixed/0.5.6")]
#![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))]