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

version 1.3.0

This commit is contained in:
Trevor Spiteri 2020-10-15 18:48:04 +02:00
parent b41bc7b33b
commit a0a0a2a770
5 changed files with 69 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitlab-ci.yml
View File

@ -208,7 +208,7 @@ x86_64-gnulinux-tarpaulin:
image: amd64/rust:1
variables:
TARGET: x86_64
REQ_COVERAGE: "79.6"
REQ_COVERAGE: "79"
cache:
key: $CI_JOB_NAME
paths:

2
Cargo.toml
View File

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

101
README.md
View File

@ -78,7 +78,7 @@ The conversions supported cover the following cases.
## What’s new
### Version 1.3.0 news (unreleased)
### Version 1.3.0 news (2020-10-15)
* The [`MulAssign`] implementation on fixed-point numbers now
accepts an rhs fixed-point number with a different number of
@ -97,14 +97,14 @@ The conversions supported cover the following cases.
human-readable formats.
[`MulAssign`]: https://doc.rust-lang.org/nightly/core/ops/trait.MulAssign.html
[f-cma-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.checked_mul_add
[f-ma-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.mul_add
[f-oma-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.overflowing_mul_add
[f-sma-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.saturating_mul_add
[f-wma-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.wrapping_mul_add
[feat-exp-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/#experimental-optional-features
[tf-ma-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/traits/trait.Fixed.html#tymethod.mul_add
[w-ma-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.Wrapping.html#method.mul_add
[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
[feat-exp-1-3]: https://docs.rs/fixed/~1.3/fixed/#experimental-optional-features
[tf-ma-1-3]: https://docs.rs/fixed/~1.3/fixed/traits/trait.Fixed.html#tymethod.mul_add
[w-ma-1-3]: https://docs.rs/fixed/~1.3/fixed/struct.Wrapping.html#method.mul_add
### Version 1.2.0 news (2020-09-02)
@ -115,17 +115,6 @@ The conversions supported cover the following cases.
[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
### Version 1.1.0 news (2020-07-21)
* 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]).
[issue 18]: https://gitlab.com/tspiteri/fixed/-/issues/18
[feat-nt-1-1]: https://docs.rs/fixed/~1.1/fixed/#experimental-optional-features
[fof-1-1]: https://docs.rs/fixed/~1.1/fixed/traits/trait.FixedOptionalFeatures.html
### Other releases
Details on other releases can be found in [*RELEASES.md*].
@ -194,7 +183,7 @@ it in your crate, add it as a dependency inside [*Cargo.toml*]:
```toml
[dependencies]
fixed = "1.2"
fixed = "1.3"
```
The *fixed* crate requires rustc version 1.44.0 or later.
@ -219,7 +208,7 @@ To enable features, you can add the dependency like this to
```toml
[dependencies.fixed]
version = "1.2"
version = "1.3"
features = ["f16", "serde"]
```
@ -233,16 +222,20 @@ dependencies can be updated to an incompatible newer version.
There are three experimental feature:
1. `num-traits`, disabled by default. This implements some traits
from the [*num-traits* crate] .
from the [*num-traits* crate]. (The plan is to upgrade this to an
optional feature once *num-traits* reaches version 1.0.0.)
2. `unwrapped`, disabled by default. This adds methods for arithmetic
that panic on overflow even when debug assertions are disabled,
similar to how wrapping methods will wrap even when debug
assertions are enabled.
assertions are enabled. (The plan is to always enable this
functionality but remove the experimental feature in version
1.4.0.)
3. `serde-str`, disabled by default. Fixed-point numbers are
serialized as strings showing the value when using human-readable
formats. This feature requires the `serde` and the `std` optional
features. **Warning:** numbers serialized when this feature is
enabled cannot be deserialized when this feature is disabled.
features. (The plan is to upgrade this to an optional feature in
version 1.4.0.) **Warning:** numbers serialized when this feature
is enabled cannot be deserialized when this feature is disabled.
## License
@ -274,40 +267,40 @@ additional terms or conditions.
[`Binary`]: https://doc.rust-lang.org/nightly/core/fmt/trait.Binary.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
[`FixedI128`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI128.html
[`FixedI16`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI16.html
[`FixedI32`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI32.html
[`FixedI64`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI64.html
[`FixedI8`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI8.html
[`FixedU128`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedU128.html
[`FixedU16`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedU16.html
[`FixedU32`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedU32.html
[`FixedU64`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedU64.html
[`FixedU8`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedU8.html
[`FromFixed`]: https://docs.rs/fixed/~1.2/fixed/traits/trait.FromFixed.html
[`FixedI128`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI128.html
[`FixedI16`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI16.html
[`FixedI32`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI32.html
[`FixedI64`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI64.html
[`FixedI8`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI8.html
[`FixedU128`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedU128.html
[`FixedU16`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedU16.html
[`FixedU32`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedU32.html
[`FixedU64`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedU64.html
[`FixedU8`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedU8.html
[`FromFixed`]: https://docs.rs/fixed/~1.3/fixed/traits/trait.FromFixed.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
[`I20F12`]: https://docs.rs/fixed/~1.2/fixed/types/type.I20F12.html
[`I4F12`]: https://docs.rs/fixed/~1.2/fixed/types/type.I4F12.html
[`I4F4`]: https://docs.rs/fixed/~1.2/fixed/types/type.I4F4.html
[`I20F12`]: https://docs.rs/fixed/~1.3/fixed/types/type.I20F12.html
[`I4F12`]: https://docs.rs/fixed/~1.3/fixed/types/type.I4F12.html
[`I4F4`]: https://docs.rs/fixed/~1.3/fixed/types/type.I4F4.html
[`Into`]: https://doc.rust-lang.org/nightly/core/convert/trait.Into.html
[`LosslessTryFrom`]: https://docs.rs/fixed/~1.2/fixed/traits/trait.LosslessTryFrom.html
[`LosslessTryInto`]: https://docs.rs/fixed/~1.2/fixed/traits/trait.LosslessTryInto.html
[`LossyFrom`]: https://docs.rs/fixed/~1.2/fixed/traits/trait.LossyFrom.html
[`LossyInto`]: https://docs.rs/fixed/~1.2/fixed/traits/trait.LossyInto.html
[`LosslessTryFrom`]: https://docs.rs/fixed/~1.3/fixed/traits/trait.LosslessTryFrom.html
[`LosslessTryInto`]: https://docs.rs/fixed/~1.3/fixed/traits/trait.LosslessTryInto.html
[`LossyFrom`]: https://docs.rs/fixed/~1.3/fixed/traits/trait.LossyFrom.html
[`LossyInto`]: https://docs.rs/fixed/~1.3/fixed/traits/trait.LossyInto.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
[`ParseFixedError`]: https://docs.rs/fixed/~1.2/fixed/struct.ParseFixedError.html
[`ToFixed`]: https://docs.rs/fixed/~1.2/fixed/traits/trait.ToFixed.html
[`U12`]: https://docs.rs/fixed/~1.2/fixed/types/extra/type.U12.html
[`U20F12`]: https://docs.rs/fixed/~1.2/fixed/types/type.U20F12.html
[`ParseFixedError`]: https://docs.rs/fixed/~1.3/fixed/struct.ParseFixedError.html
[`ToFixed`]: https://docs.rs/fixed/~1.3/fixed/traits/trait.ToFixed.html
[`U12`]: https://docs.rs/fixed/~1.3/fixed/types/extra/type.U12.html
[`U20F12`]: https://docs.rs/fixed/~1.3/fixed/types/type.U20F12.html
[`UpperHex`]: https://doc.rust-lang.org/nightly/core/fmt/trait.UpperHex.html
[`bf16`]: https://docs.rs/half/^1/half/struct.bf16.html
[`checked_from_num`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI32.html#method.checked_from_num
[`checked_from_num`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI32.html#method.checked_from_num
[`f16`]: https://docs.rs/half/^1/half/struct.f16.html
[`from_num`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI32.html#method.from_num
[`from_str_binary`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI32.html#method.from_str_binary
[`from_str_hex`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI32.html#method.from_str_hex
[`from_str_octal`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI32.html#method.from_str_octal
[`to_num`]: https://docs.rs/fixed/~1.2/fixed/struct.FixedI32.html#method.to_num
[`from_num`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI32.html#method.from_num
[`from_str_binary`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI32.html#method.from_str_binary
[`from_str_hex`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI32.html#method.from_str_hex
[`from_str_octal`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI32.html#method.from_str_octal
[`to_num`]: https://docs.rs/fixed/~1.3/fixed/struct.FixedI32.html#method.to_num
[const generics]: https://github.com/rust-lang/rust/issues/44580

18
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
as-is, without any warranty. -->
Version 1.3.0 (unreleased)
Version 1.3.0 (2020-10-15)
==========================
* The [`MulAssign`] implementation on fixed-point numbers now
@ -24,14 +24,14 @@ Version 1.3.0 (unreleased)
added, which makes serialization use the number’s value in
human-readable formats.
[f-cma-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.checked_mul_add
[f-ma-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.mul_add
[f-oma-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.overflowing_mul_add
[f-sma-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.saturating_mul_add
[f-wma-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.FixedI32.html#method.wrapping_mul_add
[feat-exp-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/#experimental-optional-features
[tf-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/traits/trait.Fixed.html
[w-1-3]: https://tspiteri.gitlab.io/fixed/dev/fixed/struct.Wrapping.html
[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
[feat-exp-1-3]: https://docs.rs/fixed/~1.3/fixed/#experimental-optional-features
[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
Version 1.2.0 (2020-09-02)
==========================

18
src/lib.rs
View File

@ -147,7 +147,7 @@ it in your crate, add it as a dependency inside [*Cargo.toml*]:
```toml
[dependencies]
fixed = "1.2"
fixed = "1.3"
```
The *fixed* crate requires rustc version 1.44.0 or later.
@ -172,7 +172,7 @@ To enable features, you can add the dependency like this to
```toml
[dependencies.fixed]
version = "1.2"
version = "1.3"
features = ["f16", "serde"]
```
@ -186,16 +186,20 @@ dependencies can be updated to an incompatible newer version.
There are three experimental feature:
1. `num-traits`, disabled by default. This implements some traits
from the [*num-traits* crate] .
from the [*num-traits* crate]. (The plan is to upgrade this to an
optional feature once *num-traits* reaches version 1.0.0.)
2. `unwrapped`, disabled by default. This adds methods for arithmetic
that panic on overflow even when debug assertions are disabled,
similar to how wrapping methods will wrap even when debug
assertions are enabled.
assertions are enabled. (The plan is to always enable this
functionality but remove the experimental feature in version
1.4.0.)
3. `serde-str`, disabled by default. Fixed-point numbers are
serialized as strings showing the value when using human-readable
formats. This feature requires the `serde` and the `std` optional
features. **Warning:** numbers serialized when this feature is
enabled cannot be deserialized when this feature is disabled.
features. (The plan is to upgrade this to an optional feature in
version 1.4.0.) **Warning:** numbers serialized when this feature
is enabled cannot be deserialized when this feature is disabled.
## License
@ -267,7 +271,7 @@ additional terms or conditions.
*/
#![cfg_attr(not(feature = "std"), no_std)]
#![warn(missing_docs)]
#![doc(html_root_url = "https://docs.rs/fixed/~1.2")]
#![doc(html_root_url = "https://docs.rs/fixed/~1.3")]
#![doc(test(attr(deny(warnings))))]
#![cfg_attr(feature = "fail-on-warnings", deny(warnings))]