share/man/man3m/remainder.3m

   1 '\" te
   2 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   3 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
   4 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   5 .\" 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
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" 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.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" 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.
  10 .\" 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.
  11 .\" 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]
  12 .TH REMAINDER 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  13 .SH NAME
  14 remainder, remainderf, remainderl \- remainder function
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  19 #include <math.h>
  20
  21 \fBdouble\fR \fBremainder\fR(\fBdouble\fR \fIx\fR, \fBdouble\fR \fIy\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBfloat\fR \fBremainderf\fR(\fBfloat\fR \fIx\fR, \fBfloat\fR \fIy\fR);
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBlong double\fR \fBremainderl\fR(\fBlong double\fR \fIx\fR, \fBlong double\fR \fIy\fR);
  32 .fi
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 These functions return the floating point remainder \fIr\fR = \fIx\fR \(mi
  38 \fIn\fR\fIy\fR when \fIy\fR is non-zero. The value \fIn\fR is the integral
  39 value nearest the exact value \fIx\fR/\fIy\fR. When |\fIn\fR \(mi
  40 \fIx\fR/\fIy\fR\|| = \(12, the value \fIn\fR is chosen to be even.
  41 .sp
  42 .LP
  43 The behavior of \fBremainder()\fR is independent of the rounding mode.
  44 .SH RETURN VALUES
  45 .sp
  46 .LP
  47 Upon successful completion, these functions return the floating point remainder
  48 \fIr\fR = \fIx\fR \(mi \fIn\fR\fIy\fR when \fIy\fR is non-zero.
  49 .sp
  50 .LP
  51 If \fIx\fR or \fIy\fR is NaN, a NaN is returned.
  52 .sp
  53 .LP
  54 If \fIx\fR is infinite or \fIy\fR is 0 and the other is non-NaN, a domain error
  55 occurs and a NaN is returned.
  56 .SH ERRORS
  57 .sp
  58 .LP
  59 These functions will fail if:
  60 .sp
  61 .ne 2
  62 .mk
  63 .na
  64 \fBDomain Error\fR
  65 .ad
  66 .RS 16n
  67 .rt
  68 The \fIx\fR argument is \(+-Inf, or the \fIy\fR argument is \(+-0 and the other
  69 argument is non-NaN.
  70 .sp
  71 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
  72 non-zero, then the invalid floating-point exception is raised.
  73 .sp
  74 The \fBremainder()\fR function sets \fBerrno\fR to \fBEDOM\fR if \fIy\fR
  75 argument is 0 or the \fIx\fR argument is positive or negative infinity.
  76 .RE
  77
  78 .SH USAGE
  79 .sp
  80 .LP
  81 An application wanting to check for error situations can set \fBerrno\fR to 0
  82 before calling \fBremainder()\fR. On return, if \fBerrno\fR is non-zero, an
  83 error has occurred. The \fBremainderf()\fR and \fBremainderl()\fR functions do
  84 not set \fBerrno\fR.
  85 .SH ATTRIBUTES
  86 .sp
  87 .LP
  88 See \fBattributes\fR(5) for descriptions of the following attributes:
  89 .sp
  90
  91 .sp
  92 .TS
  93 tab(    ) box;
  94 cw(2.75i) |cw(2.75i)
  95 lw(2.75i) |lw(2.75i)
  96 .
  97 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  98 _
  99 Interface Stability     Standard
 100 _
 101 MT-Level        MT-Safe
 102 .TE
 103
 104 .SH SEE ALSO
 105 .sp
 106 .LP
 107 \fBabs\fR(3C), \fBdiv\fR(3C), \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M),
 108 \fBattributes\fR(5), \fBstandards\fR(5)