diff options
| author | Alberto Donizetti <alb.donizetti@gmail.com> | 2020-03-20 19:13:07 +0100 |
|---|---|---|
| committer | Robert Griesemer <gri@golang.org> | 2020-03-20 19:24:37 +0000 |
| commit | c5058652fd724cb1ed8ea91a4e76b202d6910482 (patch) | |
| tree | 6090633a6333f9e723a182aada5264a1b0a1dadf | |
| parent | d965bb613086cd780cf73418bcdeaef50a9afc55 (diff) | |
| download | go-c5058652fd724cb1ed8ea91a4e76b202d6910482.tar.xz | |
math/big: document that Sqrt doesn't set Accuracy
Document that the Float.Sqrt method does not set the receiver's
Accuracy field.
Updates #37915
Change-Id: Ief1dcac07eacc0ef02f86bfac9044501477bca1c
Reviewed-on: https://go-review.googlesource.com/c/go/+/224497
Reviewed-by: Robert Griesemer <gri@golang.org>
| -rw-r--r-- | src/math/big/float.go | 4 | ||||
| -rw-r--r-- | src/math/big/sqrt.go | 3 |
2 files changed, 5 insertions, 2 deletions
diff --git a/src/math/big/float.go b/src/math/big/float.go index b3c3295201..da964eef3e 100644 --- a/src/math/big/float.go +++ b/src/math/big/float.go @@ -224,7 +224,9 @@ func (x *Float) Mode() RoundingMode { return x.mode } -// Acc returns the accuracy of x produced by the most recent operation. +// Acc returns the accuracy of x produced by the most recent +// operation, unless explicitly documented otherwise by that +// operation. func (x *Float) Acc() Accuracy { return x.acc } diff --git a/src/math/big/sqrt.go b/src/math/big/sqrt.go index 53403aa41d..ac2094f28e 100644 --- a/src/math/big/sqrt.go +++ b/src/math/big/sqrt.go @@ -14,7 +14,8 @@ var ( // // If z's precision is 0, it is changed to x's precision before the // operation. Rounding is performed according to z's precision and -// rounding mode. +// rounding mode, but z's accuracy is not computed. Specifically, the +// result of z.Acc() is undefined. // // The function panics if z < 0. The value of z is undefined in that // case. |