From: Richard M. Stallman <rms@gnu.org>
Date: Sun, 12 Aug 2001 21:16:24 +0000 (+0000)
Subject: Add examples for floor, ceiling, truncate, round.
X-Git-Tag: emacs-pretest-21.0.105~209
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b7a2fc9b5bcaf4d52a8ee7f9f657796430faec6e;p=emacs.git

Add examples for floor, ceiling, truncate, round.
---

diff --git a/lispref/numbers.texi b/lispref/numbers.texi
index eaa2250a3fd..b9ab94cfc81 100644
--- a/lispref/numbers.texi
+++ b/lispref/numbers.texi
@@ -360,21 +360,56 @@ also, and return such arguments unchanged.
 @defun truncate number
 This returns @var{number}, converted to an integer by rounding towards
 zero.
+
+@example
+(truncate 1.2)
+     @result{} 1
+(truncate 1.7)
+     @result{} 1
+(truncate -1.2)
+     @result{} -1
+(truncate -1.7)
+     @result{} -1
+@end example
 @end defun
 
 @defun floor number &optional divisor
 This returns @var{number}, converted to an integer by rounding downward
 (towards negative infinity).
 
-If @var{divisor} is specified, @var{number} is divided by @var{divisor}
-before the floor is taken; this uses the kind of division operation that
-corresponds to @code{mod}, rounding downward.  An @code{arith-error}
-results if @var{divisor} is 0.
+If @var{divisor} is specified, @code{floor} divides @var{number} by
+@var{divisor} and then converts to an integer; this uses the kind of
+division operation that corresponds to @code{mod}, rounding downward.
+An @code{arith-error} results if @var{divisor} is 0.
+
+@example
+(floor 1.2)
+     @result{} 1
+(floor 1.7)
+     @result{} 1
+(floor -1.2)
+     @result{} -2
+(floor -1.7)
+     @result{} -2
+(floor 5.99 3)
+     @result{} 1
+@end example
 @end defun
 
 @defun ceiling number
 This returns @var{number}, converted to an integer by rounding upward
 (towards positive infinity).
+
+@example
+(ceiling 1.2)
+     @result{} 2
+(ceiling 1.7)
+     @result{} 2
+(ceiling -1.2)
+     @result{} -1
+(ceiling -1.7)
+     @result{} -1
+@end example
 @end defun
 
 @defun round number
@@ -382,6 +417,17 @@ This returns @var{number}, converted to an integer by rounding towards the
 nearest integer.  Rounding a value equidistant between two integers
 may choose the integer closer to zero, or it may prefer an even integer,
 depending on your machine.
+
+@example
+(round 1.2)
+     @result{} 1
+(round 1.7)
+     @result{} 2
+(round -1.2)
+     @result{} -1
+(round -1.7)
+     @result{} -2
+@end example
 @end defun
 
 @node Arithmetic Operations