2019-01-26 13:02:58 -08:00
|
|
|
|
<!-- Copyright © 2018–2019 Trevor Spiteri -->
|
2018-08-09 11:02:34 -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. -->
|
|
|
|
|
|
|
|
|
|
# Fixed-point numbers
|
|
|
|
|
|
2018-08-10 11:30:03 -07:00
|
|
|
|
The [*fixed* crate] provides fixed-point numbers. Currently it uses
|
|
|
|
|
the [*typenum* crate] for the fractional bit count; it is planned to
|
|
|
|
|
move to [const generics] when they are implemented by the Rust
|
2018-08-10 08:45:08 -07:00
|
|
|
|
compiler.
|
2018-08-09 11:02:34 -07:00
|
|
|
|
|
2018-08-10 11:43:53 -07:00
|
|
|
|
The crate provides the following types:
|
|
|
|
|
|
|
|
|
|
* [`FixedI8`] is a signed eight-bit fixed-point number,
|
|
|
|
|
* [`FixedI16`] is a signed 16-bit fixed-point number,
|
|
|
|
|
* [`FixedI32`] is a signed 32-bit fixed-point number,
|
|
|
|
|
* [`FixedI64`] is a signed 64-bit fixed-point number,
|
|
|
|
|
* [`FixedI128`] is a signed 128-bit fixed-point number,
|
|
|
|
|
* [`FixedU8`] is an unsigned eight-bit fixed-point number,
|
|
|
|
|
* [`FixedU16`] is an unsigned 16-bit fixed-point number,
|
|
|
|
|
* [`FixedU32`] is an unsigned 32-bit fixed-point number,
|
|
|
|
|
* [`FixedU64`] is an unsigned 64-bit fixed-point number, and
|
|
|
|
|
* [`FixedU128`] is an unsigned 128-bit fixed-point number.
|
|
|
|
|
|
|
|
|
|
All fixed-point numbers can have `Frac` fractional bits, where `Frac`
|
|
|
|
|
can have any value from 0 up to and including the size of the number
|
|
|
|
|
in bits. When `Frac` is 0, the fixed-point number behaves like an
|
|
|
|
|
integer. When `Frac` is equal to the number of bits, the value of the
|
|
|
|
|
fixed-point number lies in the range −0.5 ≤ *x* < 0.5 for signed
|
|
|
|
|
fixed-point numbers, and in the range 0 ≤ *x* < 1 for unsigned
|
|
|
|
|
fixed-point numbers.
|
2018-08-10 02:13:42 -07:00
|
|
|
|
|
2019-01-26 12:16:20 -08:00
|
|
|
|
All lossless infallible conversions between fixed-point numbers and
|
2019-01-26 12:44:34 -08:00
|
|
|
|
numeric primitives are implemented. That is, you can use [`From`] or
|
2019-01-26 12:16:20 -08:00
|
|
|
|
[`Into`] for the conversions that always work without losing any bits.
|
|
|
|
|
|
2018-08-10 11:57:59 -07:00
|
|
|
|
## What’s new
|
|
|
|
|
|
2019-02-27 13:52:15 -08:00
|
|
|
|
### Version 0.3.2 news (2019-02-27)
|
|
|
|
|
|
|
|
|
|
* The [`Wrapping`] wrapper was added.
|
|
|
|
|
|
|
|
|
|
[`Wrapping`]: https://docs.rs/fixed/0.3.2/fixed/struct.Wrapping.html
|
|
|
|
|
|
2019-02-06 15:59:41 -08:00
|
|
|
|
### Version 0.3.1 news (2019-02-07)
|
2019-02-04 03:46:42 -08:00
|
|
|
|
|
|
|
|
|
* Reimplement [`From<bool>`][`From`] 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 news (2019-02-03)
|
2019-01-29 14:15:38 -08:00
|
|
|
|
|
2019-02-03 12:37:17 -08:00
|
|
|
|
#### Highlights
|
|
|
|
|
|
2019-02-06 15:59:41 -08:00
|
|
|
|
* Every fixed-point type now supports conversion to/from all
|
2019-02-03 11:25:37 -08:00
|
|
|
|
primitive number types, including checked versions of the
|
2019-02-03 12:37:17 -08:00
|
|
|
|
conversions.
|
|
|
|
|
* Every fixed-point type now supports comparisons with all primitive
|
|
|
|
|
number types.
|
2019-02-04 03:46:42 -08:00
|
|
|
|
|
2019-02-03 12:37:17 -08:00
|
|
|
|
#### Incompatible changes
|
|
|
|
|
|
|
|
|
|
* The method [`to_int`] was changed; now its return type is generic.
|
|
|
|
|
* The [`Int`] trait implementation for [`bool`] was removed.
|
2019-02-04 03:46:42 -08:00
|
|
|
|
|
2019-02-03 12:37:17 -08:00
|
|
|
|
#### Other changes
|
|
|
|
|
|
2019-02-01 11:46:51 -08:00
|
|
|
|
* The new method [`to_fixed`] was added.
|
|
|
|
|
* Checked versions of [`to_fixed`] and [`to_int`] were added.
|
2019-02-01 05:45:17 -08:00
|
|
|
|
* The methods [`from_fixed`][`Int::from_fixed`] and
|
2019-02-03 11:25:37 -08:00
|
|
|
|
[`to_fixed`][`Int::to_fixed`], and their checked versions, were
|
2019-02-01 05:45:17 -08:00
|
|
|
|
added to the [`Int`] trait.
|
2019-02-01 05:53:14 -08:00
|
|
|
|
* The method [`from_fixed`][`Float::from_fixed`], and the method
|
|
|
|
|
[`to_fixed`][`Float::to_fixed`] and its checked versions, were
|
|
|
|
|
added to the [`Float`] trait.
|
2019-02-03 11:36:08 -08:00
|
|
|
|
* The methods [`int_bits`] and [`frac_bits`] were deprecated and
|
|
|
|
|
replaced by the methods [`int_nbits`] and [`frac_nbits`].
|
2019-01-31 17:40:35 -08:00
|
|
|
|
|
2019-02-27 13:52:15 -08:00
|
|
|
|
[`Float::from_fixed`]: https://docs.rs/fixed/0.3.2/fixed/sealed/trait.Float.html#method.from_fixed
|
|
|
|
|
[`Float::to_fixed`]: https://docs.rs/fixed/0.3.2/fixed/sealed/trait.Float.html#method.to_fixed
|
|
|
|
|
[`Float`]: https://docs.rs/fixed/0.3.2/fixed/sealed/trait.Float.html
|
|
|
|
|
[`Int::from_fixed`]: https://docs.rs/fixed/0.3.2/fixed/sealed/trait.Int.html#method.from_fixed
|
|
|
|
|
[`Int::to_fixed`]: https://docs.rs/fixed/0.3.2/fixed/sealed/trait.Int.html#method.to_fixed
|
|
|
|
|
[`Int`]: https://docs.rs/fixed/0.3.2/fixed/sealed/trait.Int.html
|
2019-02-02 14:54:29 -08:00
|
|
|
|
[`bool`]: https://doc.rust-lang.org/nightly/std/convert/trait.From.html
|
2019-02-27 13:52:15 -08:00
|
|
|
|
[`frac_bits`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedI32.html#method.frac_bits
|
|
|
|
|
[`frac_nbits`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedI32.html#method.frac_nbits
|
|
|
|
|
[`int_bits`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedI32.html#method.int_bits
|
|
|
|
|
[`int_nbits`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedI32.html#method.int_nbits
|
|
|
|
|
[`to_fixed`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedI32.html#method.to_fixed
|
|
|
|
|
[`to_int`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedI32.html#method.to_int
|
2019-01-29 14:15:38 -08:00
|
|
|
|
|
2018-08-10 11:57:59 -07:00
|
|
|
|
### Other releases
|
|
|
|
|
|
|
|
|
|
Details on other releases can be found in [*RELEASES.md*].
|
|
|
|
|
|
|
|
|
|
[*RELEASES.md*]: https://gitlab.com/tspiteri/fixed/blob/master/RELEASES.md
|
|
|
|
|
|
2019-01-29 12:55:58 -08:00
|
|
|
|
## Quick examples
|
2018-08-11 08:33:31 -07:00
|
|
|
|
|
|
|
|
|
```rust
|
|
|
|
|
// 20 integer bits, 12 fractional bits
|
2019-01-26 13:22:18 -08:00
|
|
|
|
use fixed::types::I20F12;
|
|
|
|
|
|
2018-08-11 08:49:36 -07:00
|
|
|
|
// 19/3 = 6 1/3
|
2019-01-28 18:04:02 -08:00
|
|
|
|
let six_and_third = I20F12::from_int(19) / 3;
|
2018-08-11 08:33:31 -07:00
|
|
|
|
// four decimal digits for 12 binary digits
|
2018-08-11 08:49:36 -07:00
|
|
|
|
assert_eq!(six_and_third.to_string(), "6.3333");
|
2019-01-31 16:13:53 -08:00
|
|
|
|
// find the ceil and convert to i32
|
|
|
|
|
assert_eq!(six_and_third.ceil().to_int::<i32>(), 7);
|
2019-02-03 12:37:17 -08:00
|
|
|
|
// we can also compare directly to integers
|
|
|
|
|
assert_eq!(six_and_third.ceil(), 7);
|
2018-08-11 08:33:31 -07:00
|
|
|
|
```
|
|
|
|
|
|
2019-01-26 13:22:18 -08:00
|
|
|
|
The type [`I20F12`] is a 32-bit fixed-point signed number with 20
|
|
|
|
|
integer bits and 12 fractional bits. It is an alias to
|
|
|
|
|
[`FixedI32<frac::U12>`][`FixedI32`]. The unsigned counterpart would be
|
|
|
|
|
[`U20F12`]. Aliases are provided for all combinations of integer and
|
|
|
|
|
fractional bits adding up to a total of eight, 16, 32, 64 or 128 bits.
|
|
|
|
|
|
2019-01-29 12:55:58 -08:00
|
|
|
|
```rust
|
|
|
|
|
// −8 ≤ I4F4 < 8 with steps of 1/16 (about 0.06)
|
|
|
|
|
use fixed::types::I4F4;
|
|
|
|
|
let a = I4F4::from_int(1);
|
|
|
|
|
// multiplication and division by integers is possible
|
|
|
|
|
let ans1 = a / 5 * 17;
|
|
|
|
|
// 1 / 5 × 17 = 3 2/5 (3.4), but we get 3 3/16 (3.19)
|
|
|
|
|
assert_eq!(ans1, I4F4::from_bits((3 << 4) + 3));
|
|
|
|
|
assert_eq!(ans1.to_string(), "3.19");
|
|
|
|
|
|
|
|
|
|
// −8 ≤ I4F12 < 8 with steps of 1/4096 (about 0.0002)
|
|
|
|
|
use fixed::types::I4F12;
|
|
|
|
|
let wider_a = I4F12::from(a);
|
|
|
|
|
let wider_ans = wider_a / 5 * 17;
|
|
|
|
|
let ans2 = I4F4::from_fixed(wider_ans);
|
|
|
|
|
// now the answer is the much closer 3 6/16 (3.38)
|
|
|
|
|
assert_eq!(ans2, I4F4::from_bits((3 << 4) + 6));
|
|
|
|
|
assert_eq!(ans2.to_string(), "3.38");
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The second example shows some precision and conversion issues. The low
|
|
|
|
|
precision of `a` means that `a / 5` is 3⁄16 instead of 1⁄5, leading to
|
|
|
|
|
an inaccurate result `ans1` = 3 3⁄16 (3.19). With a higher precision,
|
|
|
|
|
we get `wider_a / 5` equal to 819⁄4096, leading to a more accurate
|
|
|
|
|
intermediate result `wider_ans` = 3 1635⁄4096. When we convert back to
|
|
|
|
|
four fractional bits, we get `ans2` = 3 6⁄16 (3.38).
|
|
|
|
|
|
|
|
|
|
Note that we can convert from [`I4F4`] to [`I4F12`] using [`From`], as
|
|
|
|
|
the target type has the same number of integer bits and a larger
|
|
|
|
|
number of fractional bits. Converting from [`I4F12`] to [`I4F4`]
|
|
|
|
|
cannot use [`From`] as we have less fractional bits, so we use
|
|
|
|
|
[`from_fixed`] instead.
|
|
|
|
|
|
2018-08-10 11:30:03 -07:00
|
|
|
|
## Using the *fixed* crate
|
|
|
|
|
|
|
|
|
|
The *fixed* crate is available on [crates.io][*fixed* crate]. To use
|
|
|
|
|
it in your crate, add it as a dependency inside [*Cargo.toml*]:
|
2018-08-10 02:13:42 -07:00
|
|
|
|
|
|
|
|
|
```toml
|
|
|
|
|
[dependencies]
|
2019-02-27 13:52:15 -08:00
|
|
|
|
fixed = "0.3.2"
|
2018-08-10 02:13:42 -07:00
|
|
|
|
```
|
|
|
|
|
|
2019-01-26 13:02:58 -08:00
|
|
|
|
If you are using the 2015 Rust edition, you also need to declare it by
|
|
|
|
|
adding this to your crate root (usually *lib.rs* or *main.rs*):
|
2018-08-10 02:13:42 -07:00
|
|
|
|
|
|
|
|
|
```rust
|
|
|
|
|
extern crate fixed;
|
|
|
|
|
```
|
|
|
|
|
|
2018-08-13 03:10:53 -07:00
|
|
|
|
The *fixed* crate requires rustc version 1.28.0 or later.
|
|
|
|
|
|
2018-08-23 04:12:32 -07:00
|
|
|
|
## Optional features
|
|
|
|
|
|
2019-01-26 15:39:24 -08:00
|
|
|
|
The *fixed* crate has two optional feature:
|
2018-08-23 04:12:32 -07:00
|
|
|
|
|
|
|
|
|
1. `f16`, disabled by default. This provides conversion to/from
|
|
|
|
|
[`f16`]. This features requires the [*half* crate].
|
2019-01-26 15:39:24 -08:00
|
|
|
|
2. `serde`, disabled by default. This provides serialization support
|
|
|
|
|
for the fixed-point types. This feature requires the
|
2019-01-29 12:55:58 -08:00
|
|
|
|
[*serde* crate].
|
2018-08-23 04:12:32 -07:00
|
|
|
|
|
2019-01-26 15:39:24 -08:00
|
|
|
|
To enable features, you can add the dependency like this to
|
2018-08-23 04:12:32 -07:00
|
|
|
|
[*Cargo.toml*]:
|
|
|
|
|
|
|
|
|
|
```toml
|
|
|
|
|
[dependencies.fixed]
|
2019-02-27 13:52:15 -08:00
|
|
|
|
version = "0.3.2"
|
2019-01-26 15:39:24 -08:00
|
|
|
|
features = ["f16", "serde"]
|
2018-08-23 04:12:32 -07:00
|
|
|
|
```
|
|
|
|
|
|
2018-08-10 02:13:42 -07:00
|
|
|
|
## License
|
|
|
|
|
|
2018-08-10 02:34:17 -07:00
|
|
|
|
This crate is free software: you can redistribute it and/or modify it
|
|
|
|
|
under the terms of either
|
2018-08-10 02:13:42 -07:00
|
|
|
|
|
2018-08-10 11:30:03 -07:00
|
|
|
|
* the [Apache License, Version 2.0][LICENSE-APACHE] or
|
|
|
|
|
* the [MIT License][LICENSE-MIT]
|
2018-08-10 02:13:42 -07:00
|
|
|
|
|
|
|
|
|
at your option.
|
|
|
|
|
|
|
|
|
|
### Contribution
|
|
|
|
|
|
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally
|
2018-08-10 11:30:03 -07:00
|
|
|
|
submitted for inclusion in the work by you, as defined in the Apache
|
|
|
|
|
License, Version 2.0, shall be dual licensed as above, without any
|
2018-08-10 02:13:42 -07:00
|
|
|
|
additional terms or conditions.
|
|
|
|
|
|
|
|
|
|
[*Cargo.toml*]: https://doc.rust-lang.org/cargo/guide/dependencies.html
|
2018-08-10 11:30:03 -07:00
|
|
|
|
[*fixed* crate]: https://crates.io/crates/fixed
|
2018-08-23 04:12:32 -07:00
|
|
|
|
[*half* crate]: https://crates.io/crates/half
|
2019-01-26 15:39:24 -08:00
|
|
|
|
[*serde* crate]: https://crates.io/crates/serde
|
2018-08-10 11:30:03 -07:00
|
|
|
|
[*typenum* crate]: https://crates.io/crates/typenum
|
2018-08-10 02:13:42 -07:00
|
|
|
|
[LICENSE-APACHE]: https://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
[LICENSE-MIT]: https://opensource.org/licenses/MIT
|
2019-02-27 13:52:15 -08:00
|
|
|
|
[`FixedI128`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedI128.html
|
|
|
|
|
[`FixedI16`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedI16.html
|
|
|
|
|
[`FixedI32`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedI32.html
|
|
|
|
|
[`FixedI64`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedI64.html
|
|
|
|
|
[`FixedI8`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedI8.html
|
|
|
|
|
[`FixedU128`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedU128.html
|
|
|
|
|
[`FixedU16`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedU16.html
|
|
|
|
|
[`FixedU32`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedU32.html
|
|
|
|
|
[`FixedU64`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedU64.html
|
|
|
|
|
[`FixedU8`]: https://docs.rs/fixed/0.3.2/fixed/struct.FixedU8.html
|
2019-01-26 12:16:20 -08:00
|
|
|
|
[`From`]: https://doc.rust-lang.org/nightly/std/convert/trait.From.html
|
2019-02-27 13:52:15 -08:00
|
|
|
|
[`I20F12`]: https://docs.rs/fixed/0.3.2/fixed/types/type.I20F12.html
|
|
|
|
|
[`I4F12`]: https://docs.rs/fixed/0.3.2/fixed/types/type.I4F12.html
|
|
|
|
|
[`I4F4`]: https://docs.rs/fixed/0.3.2/fixed/types/type.I4F4.html
|
2019-01-26 12:16:20 -08:00
|
|
|
|
[`Into`]: https://doc.rust-lang.org/nightly/std/convert/trait.Into.html
|
2019-02-27 13:52:15 -08:00
|
|
|
|
[`U20F12`]: https://docs.rs/fixed/0.3.2/fixed/types/type.U20F12.html
|
2018-08-23 04:12:32 -07:00
|
|
|
|
[`f16`]: https://docs.rs/half/^1/half/struct.f16.html
|
2019-01-29 12:55:58 -08:00
|
|
|
|
[`from_fixed`]: struct.FixedI8.html#method.from_fixed
|
2018-08-09 11:02:34 -07:00
|
|
|
|
[const generics]: https://github.com/rust-lang/rust/issues/44580
|