Skip to content

Commit

Permalink
Rollup merge of #77099 - tspiteri:exp_m1-examples, r=m-ou-se
Browse files Browse the repository at this point in the history
make exp_m1 and ln_1p examples more representative of use

With this PR, the examples for `exp_m1` would fail if `x.exp() - 1.0` is used instead of `x.exp_m1()`, and the examples for `ln_1p` would fail if `(x + 1.0).ln()` is used instead of `x.ln_1p()`.
  • Loading branch information
m-ou-se authored Oct 31, 2020
2 parents 76b8b00 + 50d3ddc commit 4ebd553
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 16 deletions.
18 changes: 10 additions & 8 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 All @@ -739,12 +740,13 @@ impl f32 {
/// # Examples
///
/// ```
/// let x = std::f32::consts::E - 1.0;
/// let x = 1e-8_f32;
///
/// // ln(1 + (e - 1)) == ln(e) == 1
/// let abs_difference = (x.ln_1p() - 1.0).abs();
/// // for very small x, ln(1 + x) is approximately x - x^2 / 2
/// let approx = x - x * x / 2.0;
/// let abs_difference = (x.ln_1p() - 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
18 changes: 10 additions & 8 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 All @@ -741,12 +742,13 @@ impl f64 {
/// # Examples
///
/// ```
/// let x = std::f64::consts::E - 1.0;
/// let x = 1e-16_f64;
///
/// // ln(1 + (e - 1)) == ln(e) == 1
/// let abs_difference = (x.ln_1p() - 1.0).abs();
/// // for very small x, ln(1 + x) is approximately x - x^2 / 2
/// let approx = x - x * x / 2.0;
/// let abs_difference = (x.ln_1p() - 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 4ebd553

Please sign in to comment.