fixp 0.1.0

Fixed-point numbers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# fixp: a fixed-point library for rust

This crate contains the `FixedPoint` type, which takes two generic arguments:
The underlying type, and the number of bits to use for the fractional part.
The underlying type can be any primitive rust integer type. The number of
fractional bits can be from 0 up to the number of bits in the underlying type,
inclusive (for a fixed point with no integer part).

You can use the `fixp!` macro to create fixed-point numbers of any type.

```rust
# use fixp::{fixp, FixedPoint};
let dec: FixedPoint<u32, 16> = fixp!("8.25");
let hex = fixp!("0x08.4");
let oct = fixp!("0o10.20");
let bin = fixp!("0b1_000.01");
assert_eq!(dec, hex);
assert_eq!(oct, bin);
assert_eq!(dec, bin);
assert_eq!(f32::from(dec), 8.25);
assert_eq!(f64::from(dec), 8.25);
assert_eq!(FixedPoint::try_from(8.25_f32), Ok(dec));
assert_eq!(FixedPoint::try_from(8.25_f64), Ok(dec));
```