diff options
| -rw-r--r-- | ChangeLog | 6 | ||||
| -rw-r--r-- | doc/expr.n | 34 |
2 files changed, 24 insertions, 16 deletions
@@ -1,3 +1,9 @@ +2001-12-03 Donal K. Fellows <fellowsd@cs.man.ac.uk> + + * doc/expr.n: Various documentation improvements in relation to + the function calls. Includes fix for Bug #487704 submitted by + Devin Eyre. + 2001-12-03 David Gravereaux <davygrvy@pobox.com> * win/makefile.vc: Some install target bugs repaired along with @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: expr.n,v 1.5 2000/09/07 14:27:47 poenitz Exp $ +'\" RCS: @(#) $Id: expr.n,v 1.6 2001/12/03 10:42:47 dkf Exp $ '\" .so man.macros .TH expr n 8.4 Tcl "Tcl Built-In Commands" @@ -205,19 +205,21 @@ Returns the absolute value of \fIarg\fR. \fIArg\fR may be either integer or floating-point, and the result is returned in the same form. .TP \fBacos(\fIarg\fB)\fR -Returns the arc cosine of \fIarg\fR, in the range [0,pi] -radians. \fIArg\fR should be in the range [-1,1]. +Returns the arc cosine of \fIarg\fR, in the range [\fI0\fR,\fIpi\fR] +radians. \fIArg\fR should be in the range [\fI-1\fR,\fI1\fR]. .TP \fBasin(\fIarg\fB)\fR -Returns the arc sine of \fIarg\fR, in the range [-pi/2,pi/2] radians. -\fIArg\fR should be in the range [-1,1]. +Returns the arc sine of \fIarg\fR, in the range [\fI-pi/2\fR,\fIpi/2\fR] +radians. \fIArg\fR should be in the range [\fI-1\fR,\fI1\fR]. .TP \fBatan(\fIarg\fB)\fR -Returns the arc tangent of \fIarg\fR, in the range [-pi/2,pi/2] radians. +Returns the arc tangent of \fIarg\fR, in the range [\fI-pi/2\fR,\fIpi/2\fR] +radians. .TP -\fBatan2(\fIx, y\fB)\fR -Returns the arc tangent of \fIy\fR/\fIx\fR, in the range [-pi,pi] -radians. \fIx\fR and \fIy\fR cannot both be 0. +\fBatan2(\fIy, x\fB)\fR +Returns the arc tangent of \fIy\fR/\fIx\fR, in the range [\fI-pi\fR,\fIpi\fR] +radians. \fIx\fR and \fIy\fR cannot both be 0. If \fIx\fR is greater +than \fI0\fR, this is equivalent to \fBatan(\fIy/x\fB)\fR. .TP \fBceil(\fIarg\fB)\fR Returns the smallest integer value not less than \fIarg\fR. @@ -234,8 +236,8 @@ If \fIarg\fR is a floating value, returns \fIarg\fR, otherwise converts \fIarg\fR to floating and returns the converted value. .TP \fBexp(\fIarg\fB)\fR -Returns the exponential of \fIarg\fR, defined as e**\fIarg\fR. If the -result would cause an overflow, an error is returned. +Returns the exponential of \fIarg\fR, defined as \fIe\fR**\fIarg\fR. +If the result would cause an overflow, an error is returned. .TP \fBfloor(\fIarg\fB)\fR Returns the largest integral value not greater than \fIarg\fR. @@ -246,7 +248,7 @@ Returns the floating-point remainder of the division of \fIx\fR by .TP \fBhypot(\fIx, y\fB)\fR Computes the length of the hypotenuse of a right-angled triangle -(\fIx\fR*\fIx\fR+\fIy\fR*\fIy\fR). +\fBsqrt(\fIx\fR*\fIx\fR+\fIy\fR*\fIy\fB)\fR. .TP \fBint(\fIarg\fB)\fR If \fIarg\fR is an integer value, returns \fIarg\fR, otherwise converts @@ -265,10 +267,10 @@ Computes the value of \fIx\fR raised to the power \fIy\fR. If \fIx\fR is negative, \fIy\fR must be an integer value. .TP \fBrand()\fR -Returns a floating point number from zero to just less than one or, -in mathematical terms, the range [0,1). The seed comes from the -internal clock of the machine or may be set manual with the srand -function. +Returns a floating point number from zero to just less than one or, in +mathematical terms, the range [\fI0\fR,\fI1\fR). The seed comes from +the internal clock of the machine or may be set manual with the +\fBsrand\fR function. .TP \fBround(\fIarg\fB)\fR If \fIarg\fR is an integer value, returns \fIarg\fR, otherwise converts |