share/man/man3m/remainder.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) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
  46 .\"
  47 .TH REMAINDER 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  48 .SH NAME
  49 remainder, remainderf, remainderl \- remainder function
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  54 #include <math.h>
  55
  56 \fBdouble\fR \fBremainder\fR(\fBdouble\fR \fIx\fR, \fBdouble\fR \fIy\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 \fBfloat\fR \fBremainderf\fR(\fBfloat\fR \fIx\fR, \fBfloat\fR \fIy\fR);
  62 .fi
  63
  64 .LP
  65 .nf
  66 \fBlong double\fR \fBremainderl\fR(\fBlong double\fR \fIx\fR, \fBlong double\fR \fIy\fR);
  67 .fi
  68
  69 .SH DESCRIPTION
  70 .sp
  71 .LP
  72 These functions return the floating point remainder \fIr\fR = \fIx\fR \(mi
  73 \fIn\fR\fIy\fR when \fIy\fR is non-zero. The value \fIn\fR is the integral
  74 value nearest the exact value \fIx\fR/\fIy\fR. When |\fIn\fR \(mi
  75 \fIx\fR/\fIy\fR\|| = \(12, the value \fIn\fR is chosen to be even.
  76 .sp
  77 .LP
  78 The behavior of \fBremainder()\fR is independent of the rounding mode.
  79 .SH RETURN VALUES
  80 .sp
  81 .LP
  82 Upon successful completion, these functions return the floating point remainder
  83 \fIr\fR = \fIx\fR \(mi \fIn\fR\fIy\fR when \fIy\fR is non-zero.
  84 .sp
  85 .LP
  86 If \fIx\fR or \fIy\fR is NaN, a NaN is returned.
  87 .sp
  88 .LP
  89 If \fIx\fR is infinite or \fIy\fR is 0 and the other is non-NaN, a domain error
  90 occurs and a NaN is returned.
  91 .SH ERRORS
  92 .sp
  93 .LP
  94 These functions will fail if:
  95 .sp
  96 .ne 2
  97 .mk
  98 .na
  99 \fBDomain Error\fR
 100 .ad
 101 .RS 16n
 102 .rt
 103 The \fIx\fR argument is \(+-Inf, or the \fIy\fR argument is \(+-0 and the other
 104 argument is non-NaN.
 105 .sp
 106 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
 107 non-zero, then the invalid floating-point exception is raised.
 108 .sp
 109 The \fBremainder()\fR function sets \fBerrno\fR to \fBEDOM\fR if \fIy\fR
 110 argument is 0 or the \fIx\fR argument is positive or negative infinity.
 111 .RE
 112
 113 .SH USAGE
 114 .sp
 115 .LP
 116 An application wanting to check for error situations can set \fBerrno\fR to 0
 117 before calling \fBremainder()\fR. On return, if \fBerrno\fR is non-zero, an
 118 error has occurred. The \fBremainderf()\fR and \fBremainderl()\fR functions do
 119 not set \fBerrno\fR.
 120 .SH ATTRIBUTES
 121 .sp
 122 .LP
 123 See \fBattributes\fR(5) for descriptions of the following attributes:
 124 .sp
 125
 126 .sp
 127 .TS
 128 tab(    ) box;
 129 cw(2.75i) |cw(2.75i)
 130 lw(2.75i) |lw(2.75i)
 131 .
 132 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 133 _
 134 Interface Stability     Standard
 135 _
 136 MT-Level        MT-Safe
 137 .TE
 138
 139 .SH SEE ALSO
 140 .sp
 141 .LP
 142 \fBabs\fR(3C), \fBdiv\fR(3C), \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M),
 143 \fBattributes\fR(5), \fBstandards\fR(5)