Skip to content

Commit

Permalink
doc: clarify that atol = absolute tolerance and rtol = relative toler…
Browse files Browse the repository at this point in the history
…ance (#47819)
  • Loading branch information
cmcaine committed Dec 7, 2022
1 parent 6a8fb81 commit 4c90b2a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions base/floatfuncs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -245,8 +245,8 @@ end
Inexact equality comparison. Two numbers compare equal if their relative distance *or* their
absolute distance is within tolerance bounds: `isapprox` returns `true` if
`norm(x-y) <= max(atol, rtol*max(norm(x), norm(y)))`. The default `atol` is zero and the
default `rtol` depends on the types of `x` and `y`. The keyword argument `nans` determines
`norm(x-y) <= max(atol, rtol*max(norm(x), norm(y)))`. The default `atol` (absolute tolerance) is zero and the
default `rtol` (relative tolerance) depends on the types of `x` and `y`. The keyword argument `nans` determines
whether or not NaN values are considered equal (defaults to false).
For real or complex floating-point values, if an `atol > 0` is not specified, `rtol` defaults to
Expand Down

0 comments on commit 4c90b2a

Please sign in to comment.