The [fixed crate] provides fixed-point numbers.
FixedI8] and [FixedU8] are eight-bit fixed-point numbers.FixedI16] and [FixedU16] are 16-bit fixed-point numbers.FixedI32] and [FixedU32] are 32-bit fixed-point numbers.FixedI64] and [FixedU64] are 64-bit fixed-point numbers.FixedI128] and [FixedU128] are 128-bit fixed-point numbers.These types can have Frac fractional bits, where
0 ≤ Frac ≤ n and n is the total number of bits. When
Frac = 0, the fixed-point number behaves like an n-bit
integer. When Frac = n, the value x lies in the range
−0.5 ≤ x < 0.5 for signed numbers, and in the range
0 ≤ x < 1 for unsigned numbers.
Currently the [typenum crate] is used for the fractional bit count
Frac; it is planned to move to [const generics] when they are
supported by the Rust compiler.
The main features are
This crate does not provide general analytic functions.
sqrt or
pow.sin or
cos.log or exp.The conversions supported cover the following cases.
From] and [Into]. These
never fail (infallible) and do not lose any bits (lossless).LossyFrom] and
[LossyInto] traits. The source can have more fractional bits
than the destination.FromFixed] and [ToFixed]
traits, or using the [from_num] and [to_num] methods and
[their checked versions][checked_from_num].FromStr], and from binary, octal and hexadecimal strings using
the [from_str_binary], [from_str_octal] and [from_str_hex]
methods. The result is rounded to the nearest, with ties rounded
to even.Display],
[Binary], [Octal], [LowerHex] and [UpperHex]. The output
is rounded to the nearest, with ties rounded to even.ParseFixedError] implements [Error] when the new std
feature is enabled.Fixed] trait:
from_be_bytes], [from_le_bytes], [from_ne_bytes]to_be_bytes], [to_le_bytes], [to_ne_bytes]div_euclid_int], [rem_euclid_int]checked_div_euclid_int], [checked_rem_euclid_int]wrapping_div_euclid_int], [wrapping_rem_euclid_int]overflowing_div_euclid_int], [overflowing_rem_euclid_int]bf16] are now provided when the f16
option is enabled.const functions:
[saturating_neg], [saturating_add], [saturating_sub],
[saturating_mul_int], [saturating_abs]Details on other releases can be found in [RELEASES.md].
```rust use fixed::types::I20F12;
// 19/3 = 6 1/3
let sixandthird = I20F12::fromnum(19) / 3;
// four decimal digits for 12 binary digits
asserteq!(sixandthird.tostring(), "6.3333");
// find the ceil and convert to i32
asserteq!(sixandthird.ceil().tonum::
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][. The unsigned
counterpart would be [FixedI32]<[U12][U12]>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.
```rust use fixed::types::{I4F4, I4F12};
// −8 ≤ I4F4 < 8 with steps of 1/16 (~0.06) let a = I4F4::fromnum(1); // multiplication and division by integers are possible let ans1 = a / 5 * 17; // 1 / 5 × 17 = 3 2/5 (3.4), but we get 3 3/16 (~3.2) asserteq!(ans1, I4F4::frombits((3 << 4) + 3)); asserteq!(ans1.to_string(), "3.2");
// −8 ≤ I4F12 < 8 with steps of 1/4096 (~0.0002) let widera = I4F12::from(a); let widerans = widera / 5 * 17; let ans2 = I4F4::fromnum(widerans); // now the answer is the much closer 3 6/16 (~3.4) asserteq!(ans2, I4F4::frombits((3 << 4) + 6)); asserteq!(ans2.to_string(), "3.4"); ```
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.2). 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.4).
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_num] instead.
The fixed crate is available on crates.io. To use it in your crate, add it as a dependency inside [Cargo.toml]:
toml
[dependencies]
fixed = "0.5.1"
The fixed crate requires rustc version 1.39.0 or later.
The fixed crate has four optional feature:
az, disabled by default. This implements the cast traits
provided by the [az crate].f16, disabled by default. This provides conversion to/from
[f16] and [bf16]. This features requires the [half crate].serde, disabled by default. This provides serialization support
for the fixed-point types. This feature requires the
[serde crate].std, disabled by default. This is for features that are not
possible under no_std: currently the implementation of the
[Error] trait for [ParseFixedError].To enable features, you can add the dependency like this to [Cargo.toml]:
toml
[dependencies.fixed]
version = "0.5.1"
features = ["f16", "serde"]
This crate is free software: you can redistribute it and/or modify it under the terms of either
at your option.
Unless you explicitly state otherwise, any contribution intentionally 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 additional terms or conditions.