From 9a2c4447835ccc014b593e242872457a95f4c6ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johanna=20S=C3=B6rng=C3=A5rd?= Date: Sat, 5 Oct 2024 14:58:25 +0200 Subject: [PATCH] Add comment about trait impl domain domain --- src/lib.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 0aecd55..701f05e 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -385,6 +385,8 @@ impl LambertW for f32 { /// /// Evaluated with the approximation with 24-bits of accuracy from the paper, but on 32-bit floats. /// + /// Arguments smaller than -1/e (≈ -0.36787944) result in [`NAN`](f32::NAN). + /// /// Delegates to the [`lambert_w0f`] function. /// /// # Example @@ -406,6 +408,8 @@ impl LambertW for f32 { /// /// Evaluated with the approximation with 24-bits of accuracy from the paper, but on 32-bit floats. /// + /// Arguments smaller than -1/e (≈ -0.36787944) or larger than 0 result in [`NAN`](f32::NAN). + /// /// Delegates to the [`lambert_wm1f`] function. /// /// # Example @@ -427,6 +431,8 @@ impl LambertW for f64 { type Output = Self; /// The principal branch of the Lambert W function evaluated to 50 bits of accuracy. /// + /// Arguments smaller than -1/e (≈ -0.36787944117144233) result in [`NAN`](f64::NAN). + /// /// Delegates to the [`lambert_w0`] function. /// /// # Example @@ -446,6 +452,8 @@ impl LambertW for f64 { } /// The secondary branch of the Lambert W function evaluated to 50 bits of accuracy. /// + /// Arguments smaller than -1/e (≈ -0.36787944117144233) or larger than 0 result in [`NAN`](f64::NAN). + /// /// Delegates to the [`lambert_wm1`] function. /// /// # Example