share/man/man3m/remquo.3m

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