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

link to fixed-macro in doc

This commit is contained in:
Trevor Spiteri 2020-10-19 10:37:29 +02:00
parent a0a0a2a770
commit 27914b9a03
2 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -176,6 +176,20 @@ number of fractional bits. Converting from [`I4F12`] to [`I4F4`]
cannot use [`From`] as we have less fractional bits, so we use
[`from_num`] instead.
## Writing fixed-point constants and values literally
The [*fixed-macro* crate] provides a convenient macro to write down
fixed-point constants literally in the code.
```rust
use fixed::types::I16F16;
use fixed_macro::fixed;
const NUM1: I16F16 = fixed!(12.75: I16F16);
let num2 = NUM1 + fixed!(13.125: I16F16);
assert_eq!(num2, 25.875);
```
## Using the *fixed* crate
The *fixed* crate is available on [crates.io][*fixed* crate]. To use
@ -257,6 +271,7 @@ additional terms or conditions.
[*Cargo.toml*]: https://doc.rust-lang.org/cargo/guide/dependencies.html
[*az* crate]: https://crates.io/crates/az
[*fixed* crate]: https://crates.io/crates/fixed
[*fixed-macro* crate]: https://crates.io/crates/fixed-macro
[*fixed-sqrt* crate]: https://crates.io/crates/fixed-sqrt
[*half* crate]: https://crates.io/crates/half
[*num-traits* crate]: https://crates.io/crates/num-traits

15
src/lib.rs
View File

@ -140,6 +140,20 @@ number of fractional bits. Converting from [`I4F12`] to [`I4F4`]
cannot use [`From`] as we have less fractional bits, so we use
[`from_num`] instead.
## Writing fixed-point constants and values literally
The [*fixed-macro* crate] provides a convenient macro to write down
fixed-point constants literally in the code.
```ignore
use fixed::types::I16F16;
use fixed_macro::fixed;
const NUM1: I16F16 = fixed!(12.75: I16F16);
let num2 = NUM1 + fixed!(13.125: I16F16);
assert_eq!(num2, 25.875);
```
## Using the *fixed* crate
The *fixed* crate is available on [crates.io][*fixed* crate]. To use
@ -221,6 +235,7 @@ additional terms or conditions.
[*Cargo.toml*]: https://doc.rust-lang.org/cargo/guide/dependencies.html
[*az* crate]: https://crates.io/crates/az
[*fixed* crate]: https://crates.io/crates/fixed
[*fixed-macro* crate]: https://crates.io/crates/fixed-macro
[*fixed-sqrt* crate]: https://crates.io/crates/fixed-sqrt
[*half* crate]: https://crates.io/crates/half
[*num-traits* crate]: https://crates.io/crates/num-traits