From c8548d99117f5bf52e3cae38a30cb518e2d2bbfd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johanna=20S=C3=B6rng=C3=A5rd?= Date: Fri, 27 Dec 2024 13:03:14 +0100 Subject: [PATCH] Note the different inputs in the comment. --- src/dwm1c.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/dwm1c.rs b/src/dwm1c.rs index 660f170..2eb532c 100644 --- a/src/dwm1c.rs +++ b/src/dwm1c.rs @@ -7,7 +7,8 @@ use crate::{ // This is an implementation of the approximation of the secondary // branch of the Lambert W function // with 50 bits of accuracy from Fukushima's paper. -// It returns f64::NAN if the input is negative, NAN, or larger than or equal to 0. +// It returns f64::NAN if the `zc` input is negative, +// or if the `z` input is NAN, or larger than or equal to 0. // It returns f64::INFINITY if the input is positive infinity. /// zc = z + 1/e