summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorKevin B Kenny <kennykb@acm.org>2006-12-01 19:59:59 (GMT)
committerKevin B Kenny <kennykb@acm.org>2006-12-01 19:59:59 (GMT)
commit339ca1b05809a2057811f8afa91f753e7482dc0f (patch)
tree583e2aa907472a929b1df844211858394e6f224a /doc
parent987906704f34c52aac4787e16dcbbc9d41ddbd48 (diff)
downloadtcl-339ca1b05809a2057811f8afa91f753e7482dc0f.zip
tcl-339ca1b05809a2057811f8afa91f753e7482dc0f.tar.gz
tcl-339ca1b05809a2057811f8afa91f753e7482dc0f.tar.bz2
TIP#299 IMPLEMENTATION
Diffstat (limited to 'doc')
-rw-r--r--doc/mathfunc.n20
1 files changed, 14 insertions, 6 deletions
diff --git a/doc/mathfunc.n b/doc/mathfunc.n
index f115cf0..fdc92c7 100644
--- a/doc/mathfunc.n
+++ b/doc/mathfunc.n
@@ -6,7 +6,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: mathfunc.n,v 1.11 2006/07/28 10:38:00 das Exp $
+'\" RCS: @(#) $Id: mathfunc.n,v 1.12 2006/12/01 19:59:59 kennykb Exp $
'\"
.so man.macros
.TH mathfunc n 8.5 Tcl "Tcl Mathematical Functions"
@@ -51,6 +51,8 @@ package require \fBTcl 8.5\fR
.br
\fB::tcl::mathfunc::int\fR \fIarg\fR
.br
+\fB::tcl::mathfunc::isqrt\fR \fIarg \F
+.br
\fB::tcl::mathfunc::log\fR \fIarg\fR
.br
\fB::tcl::mathfunc::log10\fR \fIarg\fR
@@ -99,10 +101,10 @@ of which work solely with floating-point numbers unless otherwise noted:
\fBatan2\fR \fBbool\fR \fBceil\fR \fBcos\fR
\fBcosh\fR \fBdouble\fR \fBentier\fR \fBexp\fR
\fBfloor\fR \fBfmod\fR \fBhypot\fR \fBint\fR
-\fBlog\fR \fBlog10\fR \fBmax\fR \fBmin\fR
-\fBpow\fR \fBrand\fR \fBround\fR \fBsin\fR
-\fBsinh\fR \fBsqrt\fR \fBsrand\fR \fBtan\fR
-\fBtanh\fR \fBwide\fR
+\fBisqrt\fR \fBlog\fR \fBlog10\fR \fBmax\fR
+\fBmin\fR \fBpow\fR \fBrand\fR \fBround\fR
+\fBsin\fR \fBsinh\fR \fBsqrt\fR \fBsrand\fR
+\fBtan\fR \fBtanh\fR \fBwide\fR
.DE
.PP
.TP
@@ -185,6 +187,12 @@ 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.
.TP
+\fBisqrt(\fIarg\fB)\fR
+Computes the integer part of the square root of \fIarg\fR. \fIArg\fR must be
+a positive value, either an integer or a floating point number.
+Unlike \fBsqrt\fR, which is limited to the precision of a floating point
+number, \fIisqrt\fR will return a result of arbitrary precision.
+.TP
\fBlog(\fIarg\fB)\fR
Returns the natural logarithm of \fIarg\fR. \fIArg\fR must be a
positive value.
@@ -261,4 +269,4 @@ Copyright (c) 1993 The Regents of the University of California.
.br
Copyright (c) 1994-2000 Sun Microsystems Incorporated.
.br
-Copyright (c) 2005 by Kevin B. Kenny <kennykb@acm.org>. All rights reserved.
+Copyright (c) 2005, 2006 by Kevin B. Kenny <kennykb@acm.org>.