mirror of https://github.com/mkerrisk/man-pages
138 lines
2.9 KiB
Groff
138 lines
2.9 KiB
Groff
.\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
|
|
.\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
|
|
.\" <mtk.manpages@gmail.com>
|
|
.\"
|
|
.\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
|
|
.\" Distributed under GPL
|
|
.\" %%%LICENSE_END
|
|
.\"
|
|
.\" based on glibc infopages
|
|
.\" polished, aeb
|
|
.\"
|
|
.TH REMQUO 3 2014-05-10 "GNU" "Linux Programmer's Manual"
|
|
.SH NAME
|
|
remquo, remquof, remquol \- remainder and part of quotient
|
|
.SH SYNOPSIS
|
|
.nf
|
|
.B #include <math.h>
|
|
.sp
|
|
.BI "double remquo(double " x ", double " y ", int *" quo );
|
|
.br
|
|
.BI "float remquof(float " x ", float " y ", int *" quo );
|
|
.br
|
|
.BI "long double remquol(long double " x ", long double " y ", int *" quo );
|
|
.fi
|
|
.sp
|
|
Link with \fI\-lm\fP.
|
|
.sp
|
|
.in -4n
|
|
Feature Test Macro Requirements for glibc (see
|
|
.BR feature_test_macros (7)):
|
|
.in
|
|
.sp
|
|
.ad l
|
|
.BR remquo (),
|
|
.BR remquof (),
|
|
.BR remquol ():
|
|
.RS 4
|
|
_XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
|
|
_POSIX_C_SOURCE\ >=\ 200112L;
|
|
.br
|
|
or
|
|
.I cc\ -std=c99
|
|
.RE
|
|
.ad
|
|
.SH DESCRIPTION
|
|
These functions compute the remainder and part of the quotient
|
|
upon division of
|
|
.I x
|
|
by
|
|
.IR y .
|
|
A few bits of the quotient are stored via the
|
|
.I quo
|
|
pointer.
|
|
The remainder is returned as the function result.
|
|
|
|
The value of the remainder is the same as that computed by the
|
|
.BR remainder (3)
|
|
function.
|
|
|
|
The value stored via the
|
|
.I quo
|
|
pointer has the sign of
|
|
.IR "x\ /\ y"
|
|
and agrees with the quotient in at least the low order 3 bits.
|
|
|
|
For example, \fIremquo(29.0,\ 3.0)\fP returns \-1.0 and might store 2.
|
|
Note that the actual quotient might not fit in an integer.
|
|
.\" A possible application of this function might be the computation
|
|
.\" of sin(x). Compute remquo(x, pi/2, &quo) or so.
|
|
.\"
|
|
.\" glibc, UnixWare: return 3 bits
|
|
.\" MacOS 10: return 7 bits
|
|
.SH RETURN VALUE
|
|
On success, these functions return the same value as
|
|
the analogous functions described in
|
|
.BR remainder (3).
|
|
|
|
If
|
|
.I x
|
|
or
|
|
.I y
|
|
is a NaN, a NaN is returned.
|
|
|
|
If
|
|
.I x
|
|
is an infinity,
|
|
and
|
|
.I y
|
|
is not a NaN,
|
|
a domain error occurs, and
|
|
a NaN is returned.
|
|
|
|
If
|
|
.I y
|
|
is zero,
|
|
and
|
|
.I x
|
|
is not a NaN,
|
|
a domain error occurs, and
|
|
a NaN is returned.
|
|
.SH ERRORS
|
|
See
|
|
.BR math_error (7)
|
|
for information on how to determine whether an error has occurred
|
|
when calling these functions.
|
|
.PP
|
|
The following errors can occur:
|
|
.TP
|
|
Domain error: \fIx\fP is an infinity or \fIy\fP is 0, \
|
|
and the other argument is not a NaN
|
|
.\" .I errno
|
|
.\" is set to
|
|
.\" .BR EDOM .
|
|
An invalid floating-point exception
|
|
.RB ( FE_INVALID )
|
|
is raised.
|
|
.PP
|
|
These functions do not set
|
|
.IR errno .
|
|
.\" FIXME . Is it intentional that these functions do not set errno?
|
|
.\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6802
|
|
.SH VERSIONS
|
|
These functions first appeared in glibc in version 2.1.
|
|
.SH ATTRIBUTES
|
|
.SS Multithreading (see pthreads(7))
|
|
The
|
|
.BR remquo (),
|
|
.BR remquof (),
|
|
and
|
|
.BR remquol ()
|
|
functions are thread-safe.
|
|
.SH CONFORMING TO
|
|
C99, POSIX.1-2001.
|
|
.SH SEE ALSO
|
|
.BR fmod (3),
|
|
.BR logb (3),
|
|
.BR remainder (3)
|