Skip to content

Commit

Permalink
Merge pull request #326 from mtilda/mtilda/patch/fix-example-for-floa…
Browse files Browse the repository at this point in the history
…t-integer-decoder

Clarify example for trait method `float::Float::integer_decode`
  • Loading branch information
cuviper committed Jun 27, 2024
2 parents 7ec3d41 + e8c766f commit b1f3bda
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/float.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1866,16 +1866,16 @@ pub trait Float: Num + Copy + NumCast + PartialOrd + Neg<Output = Self> {
/// ```
/// use num_traits::Float;
///
/// let num = 2.0f32;
/// let num = 42_f32;
///
/// // (8388608, -22, 1)
/// // (11010048, -18, 1)
/// let (mantissa, exponent, sign) = Float::integer_decode(num);
/// let sign_f = sign as f32;
/// let mantissa_f = mantissa as f32;
/// let exponent_f = num.powf(exponent as f32);
/// let exponent_f = exponent as f32;
///
/// // 1 * 8388608 * 2^(-22) == 2
/// let abs_difference = (sign_f * mantissa_f * exponent_f - num).abs();
/// // 1 * 11010048 * 2^(-18) == 42
/// let abs_difference = (sign_f * mantissa_f * exponent_f.exp2() - num).abs();
///
/// assert!(abs_difference < 1e-10);
/// ```
Expand Down

0 comments on commit b1f3bda

Please sign in to comment.