]> sourceware.org Git - glibc.git/commitdiff
Describe remainder as primary and drem as alternative in the manual
authorGabriel F. T. Gomes <gftg@linux.vnet.ibm.com>
Tue, 20 Jun 2017 18:00:16 +0000 (15:00 -0300)
committerGabriel F. T. Gomes <gftg@linux.vnet.ibm.com>
Thu, 22 Jun 2017 16:08:17 +0000 (13:08 -0300)
In preparation for the documentation of _FloatN and _FloatNx variants of
the remainder function, this patch changes the descriptions of remainder
and drem, so that remainder is described as primary and drem as an
alternative name for the same functionality.

* manual/arith.texi (Remainder Functions): Describe remainder as
primary and drem as an alternative name.  Change the comment on
remainder to ISO, since it is defined in ISO C99.

ChangeLog
manual/arith.texi

index d01eda76ffb26cedfbbb4f0097fbd4c3a8487ece..a9a99f0a8e9e364744a41c98d70799c1031d74e9 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2017-06-22  Gabriel F. T. Gomes  <gftg@linux.vnet.ibm.com>
+
+       * manual/arith.texi (Remainder Functions): Describe remainder as
+       primary and drem as an alternative name.  Change the comment on
+       remainder to ISO, since it is defined in ISO C99.
+
 2017-06-22  Gabriel F. T. Gomes  <gftg@linux.vnet.ibm.com>
 
        * stdlib/tst-strtod.h (MMFUNC): New macro to provide an addition
index dd6020cf4f2f9db2e95a98e72ea5748fb8dd88fc..e403cb51cd717ff601d6456822bc265eac586d3c 100644 (file)
@@ -1591,31 +1591,31 @@ less than the magnitude of the @var{denominator}.
 If @var{denominator} is zero, @code{fmod} signals a domain error.
 @end deftypefun
 
-@deftypefun double drem (double @var{numerator}, double @var{denominator})
-@deftypefunx float dremf (float @var{numerator}, float @var{denominator})
-@deftypefunx {long double} dreml (long double @var{numerator}, long double @var{denominator})
-@standards{BSD, math.h}
+@deftypefun double remainder (double @var{numerator}, double @var{denominator})
+@deftypefunx float remainderf (float @var{numerator}, float @var{denominator})
+@deftypefunx {long double} remainderl (long double @var{numerator}, long double @var{denominator})
+@standards{ISO, math.h}
 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
 These functions are like @code{fmod} except that they round the
 internal quotient @var{n} to the nearest integer instead of towards zero
-to an integer.  For example, @code{drem (6.5, 2.3)} returns @code{-0.4},
-which is @code{6.5} minus @code{6.9}.
+to an integer.  For example, @code{remainder (6.5, 2.3)} returns
+@code{-0.4}, which is @code{6.5} minus @code{6.9}.
 
 The absolute value of the result is less than or equal to half the
 absolute value of the @var{denominator}.  The difference between
-@code{fmod (@var{numerator}, @var{denominator})} and @code{drem
+@code{fmod (@var{numerator}, @var{denominator})} and @code{remainder
 (@var{numerator}, @var{denominator})} is always either
 @var{denominator}, minus @var{denominator}, or zero.
 
-If @var{denominator} is zero, @code{drem} signals a domain error.
+If @var{denominator} is zero, @code{remainder} signals a domain error.
 @end deftypefun
 
-@deftypefun double remainder (double @var{numerator}, double @var{denominator})
-@deftypefunx float remainderf (float @var{numerator}, float @var{denominator})
-@deftypefunx {long double} remainderl (long double @var{numerator}, long double @var{denominator})
+@deftypefun double drem (double @var{numerator}, double @var{denominator})
+@deftypefunx float dremf (float @var{numerator}, float @var{denominator})
+@deftypefunx {long double} dreml (long double @var{numerator}, long double @var{denominator})
 @standards{BSD, math.h}
 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
-This function is another name for @code{drem}.
+This function is another name for @code{remainder}.
 @end deftypefun
 
 @node FP Bit Twiddling
This page took 0.147808 seconds and 5 git commands to generate.