Skip to content

Commit

Permalink
make exp_m1 examples more representative of use
Browse files Browse the repository at this point in the history
With this commit, the examples for exp_m1 would fail if x.exp() - 1.0
is used instead of x.exp_m1().
  • Loading branch information
tspiteri committed Sep 23, 2020
1 parent f6d5920 commit 37ce212
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
9 changes: 5 additions & 4 deletions library/std/src/f32.rs
Original file line number Diff line number Diff line change
Expand Up @@ -719,12 +719,13 @@ impl f32 {
/// # Examples
///
/// ```
/// let x = 6.0f32;
/// let x = 1e-8_f32;
///
/// // e^(ln(6)) - 1
/// let abs_difference = (x.ln().exp_m1() - 5.0).abs();
/// // for very small x, e^x is approximately 1 + x + x^2 / 2
/// let approx = x + x * x / 2.0;
/// let abs_difference = (x.exp_m1() - approx).abs();
///
/// assert!(abs_difference <= f32::EPSILON);
/// assert!(abs_difference < 1e-10);
/// ```
#[must_use = "method returns a new number and does not mutate the original value"]
#[stable(feature = "rust1", since = "1.0.0")]
Expand Down
9 changes: 5 additions & 4 deletions library/std/src/f64.rs
Original file line number Diff line number Diff line change
Expand Up @@ -721,12 +721,13 @@ impl f64 {
/// # Examples
///
/// ```
/// let x = 7.0_f64;
/// let x = 1e-16_f64;
///
/// // e^(ln(7)) - 1
/// let abs_difference = (x.ln().exp_m1() - 6.0).abs();
/// // for very small x, e^x is approximately 1 + x + x^2 / 2
/// let approx = x + x * x / 2.0;
/// let abs_difference = (x.exp_m1() - approx).abs();
///
/// assert!(abs_difference < 1e-10);
/// assert!(abs_difference < 1e-20);
/// ```
#[must_use = "method returns a new number and does not mutate the original value"]
#[stable(feature = "rust1", since = "1.0.0")]
Expand Down

0 comments on commit 37ce212

Please sign in to comment.