Skip to content

Commit

Permalink
Note the different inputs in the comment.
Browse files Browse the repository at this point in the history
  • Loading branch information
JSorngard committed Dec 27, 2024
1 parent 52795e5 commit c8548d9
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/dwm1c.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit c8548d9

Please sign in to comment.