summaryrefslogtreecommitdiffstats
path: root/doc/mathfunc.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2011-07-17 15:00:43 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2011-07-17 15:00:43 (GMT)
commit9f51e32c984e0ad2e812d241e588c492c4179cf8 (patch)
treec3920dbd3e235492a7b453af9a7f5cf5f080c734 /doc/mathfunc.n
parentff87b46b5269cbd4def059244e47ec2db336e166 (diff)
downloadtcl-9f51e32c984e0ad2e812d241e588c492c4179cf8.zip
tcl-9f51e32c984e0ad2e812d241e588c492c4179cf8.tar.gz
tcl-9f51e32c984e0ad2e812d241e588c492c4179cf8.tar.bz2
Documentation improvements (small; some revision to parsing script) to improve
the quality of HTML doc builds.
Diffstat (limited to 'doc/mathfunc.n')
-rw-r--r--doc/mathfunc.n11
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/mathfunc.n b/doc/mathfunc.n
index 0977220..3da6d5a 100644
--- a/doc/mathfunc.n
+++ b/doc/mathfunc.n
@@ -195,16 +195,19 @@ Returns the floating-point remainder of the division of \fIx\fR by
.TP
\fBhypot \fIx y\fR
.
-Computes the length of the hypotenuse of a right-angled triangle
-.QW "\fBsqrt\fR [\fBexpr\fR {\fIx\fB*\fIx\fB+\fIy\fB*\fIy\fR}]".
+Computes the length of the hypotenuse of a right-angled triangle,
+approximately
+.QW "\fBsqrt\fR [\fBexpr\fR {\fIx\fB*\fIx\fB+\fIy\fB*\fIy\fR}]"
+except for being more numerically stable when the two arguments have
+substantially different magnitudes.
.TP
\fBint \fIarg\fR
.
The argument may be any numeric value. The integer part of \fIarg\fR
is determined, and then the low order bits of that integer value up
to the machine word size are returned as an integer value. For reference,
-the number of bytes in the machine word are stored in
-\fBtcl_platform(wordSize)\fR.
+the number of bytes in the machine word are stored in the \fBwordSize\fR
+element of the \fBtcl_platform\fR array.
.TP
\fBisqrt \fIarg\fR
.