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

tweak wording on version 2 plan

This commit is contained in:
Trevor Spiteri 2020-05-02 21:22:46 +02:00
parent eb51b85db5
commit 48a763c01f
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -22,9 +22,9 @@ integer. When `Frac` = <i>n</i>, the value <i>x</i> lies in the range
−0.5 ≤ <i>x</i> < 0.5 for signed numbers, and in the range −0.5 ≤ <i>x</i> < 0.5 for signed numbers, and in the range
0 ≤ <i>x</i> < 1 for unsigned numbers. 0 ≤ <i>x</i> < 1 for unsigned numbers.
Currently the [*typenum* crate] is used for the fractional bit count In version 1 the [*typenum* crate] is used for the fractional bit
`Frac`; it is planned to move to [const generics] in version 2 when count `Frac`; the plan is to to have a major version 2 with [const
they are supported by the Rust compiler. generics] when they are supported by the Rust compiler.
The main features are The main features are

14
src/lib.rs
View File

@ -31,9 +31,9 @@ integer. When `Frac` = <i>n</i>, the value <i>x</i> lies in the range
−0.5 ≤ <i>x</i> < 0.5 for signed numbers, and in the range −0.5 ≤ <i>x</i> < 0.5 for signed numbers, and in the range
0 ≤ <i>x</i> < 1 for unsigned numbers. 0 ≤ <i>x</i> < 1 for unsigned numbers.
Currently the [*typenum* crate] is used for the fractional bit count In version 1 the [*typenum* crate] is used for the fractional bit
`Frac`; it is planned to move to [const generics] in version 2 when count `Frac`; the plan is to to have a major version 2 with [const
they are supported by the Rust compiler. generics] when they are supported by the Rust compiler.
The main features are The main features are
@ -353,9 +353,9 @@ macro_rules! fixed {
$description, $description,
" number with `Frac` fractional bits. " number with `Frac` fractional bits.
Currently `Frac` is an [`Unsigned`] as provided by the `Frac` is an [`Unsigned`] as provided by the [*typenum* crate]; the
[typenum crate]; it is planned to move to [const generics] in version plan is to move to [const generics] in version 2 when they are
2 when they are supported by the Rust compiler. supported by the Rust compiler.
# Examples # Examples
@ -371,9 +371,9 @@ assert_eq!(two_point_75, 2.75);
assert_eq!(two_point_75.to_string(), \"2.8\"); assert_eq!(two_point_75.to_string(), \"2.8\");
``` ```
[*typenum* crate]: https://crates.io/crates/typenum
[`Unsigned`]: https://docs.rs/typenum/^1.3/typenum/marker_traits/trait.Unsigned.html [`Unsigned`]: https://docs.rs/typenum/^1.3/typenum/marker_traits/trait.Unsigned.html
[const generics]: https://github.com/rust-lang/rust/issues/44580 [const generics]: https://github.com/rust-lang/rust/issues/44580
[typenum crate]: https://crates.io/crates/typenum
"; ";
#[repr(transparent)] #[repr(transparent)]
pub struct $Fixed<Frac> { pub struct $Fixed<Frac> {