Describe remainder as primary and drem as alternative in the manual

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.
This commit is contained in:
Gabriel F. T. Gomes 2017-06-20 15:00:16 -03:00
parent 5ae2266943
commit 5070551cbf
2 changed files with 26 additions and 20 deletions

View File

@ -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> 2017-06-22 Gabriel F. T. Gomes <gftg@linux.vnet.ibm.com>
* stdlib/tst-strtod.h (MMFUNC): New macro to provide an addition * stdlib/tst-strtod.h (MMFUNC): New macro to provide an addition

View File

@ -1591,31 +1591,31 @@ less than the magnitude of the @var{denominator}.
If @var{denominator} is zero, @code{fmod} signals a domain error. If @var{denominator} is zero, @code{fmod} signals a domain error.
@end deftypefun @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})
@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{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{remainder
(@var{numerator}, @var{denominator})} is always either
@var{denominator}, minus @var{denominator}, or zero.
If @var{denominator} is zero, @code{remainder} signals a domain error.
@end deftypefun
@deftypefun double drem (double @var{numerator}, double @var{denominator}) @deftypefun double drem (double @var{numerator}, double @var{denominator})
@deftypefunx float dremf (float @var{numerator}, float @var{denominator}) @deftypefunx float dremf (float @var{numerator}, float @var{denominator})
@deftypefunx {long double} dreml (long double @var{numerator}, long double @var{denominator}) @deftypefunx {long double} dreml (long double @var{numerator}, long double @var{denominator})
@standards{BSD, math.h} @standards{BSD, math.h}
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}} @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
These functions are like @code{fmod} except that they round the This function is another name for @code{remainder}.
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}.
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
(@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.
@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})
@standards{BSD, math.h}
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
This function is another name for @code{drem}.
@end deftypefun @end deftypefun
@node FP Bit Twiddling @node FP Bit Twiddling