Document copysign.
authorTaylor R Campbell <campbell@mumble.net>
Sun, 30 Jun 2019 19:06:04 +0000 (19:06 +0000)
committerTaylor R Campbell <campbell@mumble.net>
Sun, 30 Jun 2019 23:30:53 +0000 (23:30 +0000)
doc/ref-manual/numbers.texi

index 6cf04083c86cc3bbb5730ab09ed70f6ab1208237..1b592d274ecdd8e8cbee36c0c3128c84ed9b7c80 100644 (file)
@@ -1298,6 +1298,20 @@ inexact numbers are representable as exact numbers.
 The procedure @code{inexact->exact} has been deprecated by @urseven{}.
 @end deffn
 
+@deffn procedure copysign x1 x2
+Returns a real number with the magnitude of @var{x1} and the sign of
+@var{x2}.
+
+@example
+@group
+(copysign 123 -1)              @result{} -123
+(copysign 0. -1)               @result{} -0.
+(copysign -0. 0.)              @result{} 0.
+(copysign -nan.123 0.)         @result{} +nan.123
+@end group
+@end example
+@end deffn
+
 @node Numerical input and output, Fixnum and Flonum Operations, Numerical operations, Numbers
 @section Numerical input and output
 @cindex numerical input and output