1 '\" te
   2 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   3 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at 
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  10 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  11 .TH remquo 3M "12 Jul 2006" "SunOS 5.11" "Mathematical Library Functions"
  12 .SH NAME
  13 remquo, remquof, remquol \- remainder functions
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  18 #include <math.h>
  19 
  20 \fBdouble\fR \fBremquo\fR(\fBdouble\fR \fIx\fR, \fBdouble\fR \fIy\fR, \fBint *\fR\fIquo\fR);
  21 .fi
  22 
  23 .LP
  24 .nf
  25 \fBfloat\fR \fBremquof\fR(\fBfloat\fR \fIx\fR, \fBfloat\fR \fIy\fR, \fBint *\fR\fIquo\fR);
  26 .fi
  27 
  28 .LP
  29 .nf
  30 \fBlong double\fR \fBremquol\fR(\fBlong double\fR \fIx\fR, \fBlong double\fR \fIy\fR, \fBint *\fR\fIquo\fR);
  31 .fi
  32 
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 The \fBremquo()\fR, \fBremquof()\fR, and \fBremquol()\fR functions compute the
  37 same remainder as the \fBremainder()\fR, \fBremainderf()\fR, and
  38 \fBremainderl()\fR functions, respectively. See \fBremainder\fR(3M). In the
  39 object pointed to by \fIquo\fR, they store a value whose sign is the sign of
  40 \fIx\fR/\fIy\fR and whose magnitude is congruent modulo 2^\fIn\fR to the
  41 magnitude of the integral quotient of \fIx\fR/\fIy\fR, where \fIn\fR is an
  42 integer greater than or equal to 3.
  43 .SH RETURN VALUES
  44 .sp
  45 .LP
  46 These functions return \fIx\fR REM \fIy\fR.
  47 .sp
  48 .LP
  49 If \fIx\fR or \fIy\fR is NaN, a NaN is returned.
  50 .sp
  51 .LP
  52 If \fIx\fR is \(+-Inf or \fIy\fR is 0 and the other argument is non-NaN, a
  53 domain error occurs and a NaN is returned.
  54 .SH ERRORS
  55 .sp
  56 .LP
  57 These functions will fail if:
  58 .sp
  59 .ne 2
  60 .mk
  61 .na
  62 \fBDomain Error\fR
  63 .ad
  64 .RS 16n
  65 .rt  
  66 The \fIx\fR argument is Inf or the \fIy\fR argument is 0 and the other argument
  67 is non-NaN.
  68 .sp
  69 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
  70 non-zero, then the invalid floating-point exception is raised.
  71 .RE
  72 
  73 .SH USAGE
  74 .sp
  75 .LP
  76 An application wanting to check for exceptions should call
  77 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
  78 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
  79 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
  80 raised. An application should either examine the return value or check the
  81 floating point exception flags to detect exceptions.
  82 .SH ATTRIBUTES
  83 .sp
  84 .LP
  85 See \fBattributes\fR(5) for descriptions of the following attributes:
  86 .sp
  87 
  88 .sp
  89 .TS
  90 tab() box;
  91 cw(2.75i) |cw(2.75i) 
  92 lw(2.75i) |lw(2.75i) 
  93 .
  94 ATTRIBUTE TYPEATTRIBUTE VALUE
  95 _
  96 Interface StabilityStandard
  97 _
  98 MT-LevelMT-Safe
  99 .TE
 100 
 101 .SH SEE ALSO
 102 .sp
 103 .LP
 104 \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M), \fBmath.h\fR(3HEAD),
 105 \fBremainder\fR(3M), \fBattributes\fR(5), \fBstandards\fR(5)