doc tweaks
This commit is contained in:
parent
fa1cecc104
commit
3cd0053e62
|
@ -849,7 +849,10 @@ that is ≤ `self`.
|
||||||
use fixed::{types::extra::U4, ", $s_fixed, "};
|
use fixed::{types::extra::U4, ", $s_fixed, "};
|
||||||
type Fix = ", $s_fixed, "<U4>;
|
type Fix = ", $s_fixed, "<U4>;
|
||||||
assert_eq!(Fix::from_bits(0b11_0010).highest_one(), Fix::from_bits(0b10_0000));
|
assert_eq!(Fix::from_bits(0b11_0010).highest_one(), Fix::from_bits(0b10_0000));
|
||||||
assert_eq!(Fix::from_num(3.125).highest_one(), Fix::from_num(2));
|
assert_eq!(Fix::from_num(0.3).highest_one(), Fix::from_num(0.25));
|
||||||
|
assert_eq!(Fix::from_num(4).highest_one(), Fix::from_num(4));
|
||||||
|
assert_eq!(Fix::from_num(6.5).highest_one(), Fix::from_num(4));
|
||||||
|
assert_eq!(Fix::from_num(0).highest_one(), Fix::from_num(0));
|
||||||
```
|
```
|
||||||
";
|
";
|
||||||
#[inline]
|
#[inline]
|
||||||
|
@ -880,12 +883,10 @@ future it panics; if this is not desirable use
|
||||||
```rust
|
```rust
|
||||||
use fixed::{types::extra::U4, ", $s_fixed, "};
|
use fixed::{types::extra::U4, ", $s_fixed, "};
|
||||||
type Fix = ", $s_fixed, "<U4>;
|
type Fix = ", $s_fixed, "<U4>;
|
||||||
// 3/8 is 0.0110
|
assert_eq!(Fix::from_bits(0b11_0010).next_power_of_two(), Fix::from_bits(0b100_0000));
|
||||||
let three_eights = Fix::from_bits(0b0110);
|
assert_eq!(Fix::from_num(0.3).next_power_of_two(), Fix::from_num(0.5));
|
||||||
// 1/2 is 0.1000
|
assert_eq!(Fix::from_num(4).next_power_of_two(), Fix::from_num(4));
|
||||||
let half = Fix::from_bits(0b1000);
|
assert_eq!(Fix::from_num(6.5).next_power_of_two(), Fix::from_num(8));
|
||||||
assert_eq!(three_eights.next_power_of_two(), half);
|
|
||||||
assert_eq!(half.next_power_of_two(), half);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
[`checked_next_power_of_two`]: #method.checked_next_power_of_two
|
[`checked_next_power_of_two`]: #method.checked_next_power_of_two
|
||||||
|
|
|
@ -1182,10 +1182,13 @@ impl<F: FixedUnsigned> Unwrapped<F> {
|
||||||
/// # Examples
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use fixed::{types::U4F4, Unwrapped};
|
/// use fixed::{types::U16F16, Unwrapped};
|
||||||
/// type T = Unwrapped<U4F4>;
|
/// type T = Unwrapped<U16F16>;
|
||||||
/// assert_eq!(T::from_bits(0b11_0010).highest_one(), T::from_bits(0b10_0000));
|
/// assert_eq!(T::from_bits(0b11_0010).highest_one(), T::from_bits(0b10_0000));
|
||||||
/// assert_eq!(T::from_num(3.125).highest_one(), T::from_num(2));
|
/// assert_eq!(T::from_num(0.3).highest_one(), T::from_num(0.25));
|
||||||
|
/// assert_eq!(T::from_num(4).highest_one(), T::from_num(4));
|
||||||
|
/// assert_eq!(T::from_num(6.5).highest_one(), T::from_num(4));
|
||||||
|
/// assert_eq!(T::from_num(0).highest_one(), T::from_num(0));
|
||||||
/// ```
|
/// ```
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn highest_one(self) -> Unwrapped<F> {
|
pub fn highest_one(self) -> Unwrapped<F> {
|
||||||
|
@ -1202,10 +1205,11 @@ impl<F: FixedUnsigned> Unwrapped<F> {
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use fixed::{types::U16F16, Unwrapped};
|
/// use fixed::{types::U16F16, Unwrapped};
|
||||||
/// let half = Unwrapped(U16F16::from_num(0.5));
|
/// type T = Unwrapped<U16F16>;
|
||||||
/// assert_eq!(Unwrapped(U16F16::from_num(0.3)).next_power_of_two(), half);
|
/// assert_eq!(T::from_bits(0b11_0010).next_power_of_two(), T::from_bits(0b100_0000));
|
||||||
/// let four = Unwrapped(U16F16::from_num(4));
|
/// assert_eq!(T::from_num(0.3).next_power_of_two(), T::from_num(0.5));
|
||||||
/// assert_eq!(Unwrapped(U16F16::from_num(4)).next_power_of_two(), four);
|
/// assert_eq!(T::from_num(4).next_power_of_two(), T::from_num(4));
|
||||||
|
/// assert_eq!(T::from_num(6.5).next_power_of_two(), T::from_num(8));
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// The following panics because of overflow.
|
/// The following panics because of overflow.
|
||||||
|
|
|
@ -1099,10 +1099,13 @@ impl<F: FixedUnsigned> Wrapping<F> {
|
||||||
/// # Examples
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use fixed::{types::U4F4, Wrapping};
|
/// use fixed::{types::U16F16, Wrapping};
|
||||||
/// type T = Wrapping<U4F4>;
|
/// type T = Wrapping<U16F16>;
|
||||||
/// assert_eq!(T::from_bits(0b11_0010).highest_one(), T::from_bits(0b10_0000));
|
/// assert_eq!(T::from_bits(0b11_0010).highest_one(), T::from_bits(0b10_0000));
|
||||||
/// assert_eq!(T::from_num(3.125).highest_one(), T::from_num(2));
|
/// assert_eq!(T::from_num(0.3).highest_one(), T::from_num(0.25));
|
||||||
|
/// assert_eq!(T::from_num(4).highest_one(), T::from_num(4));
|
||||||
|
/// assert_eq!(T::from_num(6.5).highest_one(), T::from_num(4));
|
||||||
|
/// assert_eq!(T::from_num(0).highest_one(), T::from_num(0));
|
||||||
/// ```
|
/// ```
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn highest_one(self) -> Wrapping<F> {
|
pub fn highest_one(self) -> Wrapping<F> {
|
||||||
|
@ -1117,12 +1120,13 @@ impl<F: FixedUnsigned> Wrapping<F> {
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use fixed::{types::U16F16, Wrapping};
|
/// use fixed::{types::U16F16, Wrapping};
|
||||||
/// let half = Wrapping(U16F16::from_num(0.5));
|
/// type T = Wrapping<U16F16>;
|
||||||
/// assert_eq!(Wrapping(U16F16::from_num(0.3)).next_power_of_two(), half);
|
/// assert_eq!(T::from_bits(0b11_0010).next_power_of_two(), T::from_bits(0b100_0000));
|
||||||
/// let four = Wrapping(U16F16::from_num(4));
|
/// assert_eq!(T::from_num(0.3).next_power_of_two(), T::from_num(0.5));
|
||||||
/// assert_eq!(Wrapping(U16F16::from_num(4)).next_power_of_two(), four);
|
/// assert_eq!(T::from_num(4).next_power_of_two(), T::from_num(4));
|
||||||
/// let zero = Wrapping(U16F16::from_num(0));
|
/// assert_eq!(T::from_num(6.5).next_power_of_two(), T::from_num(8));
|
||||||
/// assert_eq!(Wrapping(U16F16::MAX).next_power_of_two(), zero);
|
/// // if the next power of two is too large, it is wrapped to zero
|
||||||
|
/// assert_eq!(T::MAX.next_power_of_two(), T::from_num(0));
|
||||||
/// ```
|
/// ```
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn next_power_of_two(self) -> Wrapping<F> {
|
pub fn next_power_of_two(self) -> Wrapping<F> {
|
||||||
|
|
Loading…
Reference in New Issue