diff options
| author | Michael Howell <michael@notriddle.com> | 2023-08-21 10:06:05 -0700 |
|---|---|---|
| committer | Michael Howell <michael@notriddle.com> | 2023-08-21 10:45:47 -0700 |
| commit | 88bd304a1000be95e15c319ca79564e168ba02c3 (patch) | |
| tree | ee47703a0a80f7314d930ae7c28e3e7a0ff5513b /library | |
| parent | fe5f5912579d02c4e6088c89574493dfa988531a (diff) | |
| download | rust-88bd304a1000be95e15c319ca79564e168ba02c3.tar.gz rust-88bd304a1000be95e15c319ca79564e168ba02c3.zip | |
docs: add alias log1p to ln_1p
This is what the function is called in several other languages: * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/log1p * https://numpy.org/doc/stable/reference/generated/numpy.log1p.html * https://learn.microsoft.com/en-us/cpp/c-runtime-library/reference/log1p-log1pf-log1pl2?view=msvc-170 It also confused people at URLO: https://users.rust-lang.org/t/64-bit-trigonometry/98599/27
Diffstat (limited to 'library')
| -rw-r--r-- | library/std/src/f32.rs | 1 | ||||
| -rw-r--r-- | library/std/src/f64.rs | 1 |
2 files changed, 2 insertions, 0 deletions
diff --git a/library/std/src/f32.rs b/library/std/src/f32.rs index a659b552f47..776899dbcfd 100644 --- a/library/std/src/f32.rs +++ b/library/std/src/f32.rs @@ -822,6 +822,7 @@ impl f32 { /// /// assert!(abs_difference < 1e-10); /// ``` + #[doc(alias = "log1p")] #[rustc_allow_incoherent_impl] #[must_use = "method returns a new number and does not mutate the original value"] #[stable(feature = "rust1", since = "1.0.0")] diff --git a/library/std/src/f64.rs b/library/std/src/f64.rs index 721e1fb754e..4f4f5f02471 100644 --- a/library/std/src/f64.rs +++ b/library/std/src/f64.rs @@ -822,6 +822,7 @@ impl f64 { /// /// assert!(abs_difference < 1e-20); /// ``` + #[doc(alias = "log1p")] #[rustc_allow_incoherent_impl] #[must_use = "method returns a new number and does not mutate the original value"] #[stable(feature = "rust1", since = "1.0.0")] |