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 fmod 3M "12 Jul 2006" "SunOS 5.11" "Mathematical Library Functions"
  13 .SH NAME
  14 fmod, fmodf, fmodl \- floating-point remainder value 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 \fBfmod\fR(\fBdouble\fR \fIx\fR, \fBdouble\fR \fIy\fR);
  22 .fi
  23 
  24 .LP
  25 .nf
  26 \fBfloat\fR \fBfmodf\fR(\fBfloat\fR \fIx\fR, \fBfloat\fR \fIy\fR);
  27 .fi
  28 
  29 .LP
  30 .nf
  31 \fBlong double\fR \fBfmodl\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 of the division of \fIx\fR
  38 by \fIy\fR.
  39 .SH RETURN VALUES
  40 .sp
  41 .LP
  42 These functions return the value \fIx\fR \(mi \fIi\fR * \fIy\fR, for some
  43 integer \fIi\fR such that, if \fIy\fR is non-zero, the result has the same sign
  44 as \fIx\fR and magnitude less than the magnitude of \fIy\fR.
  45 .sp
  46 .LP
  47 If \fIx\fR or \fIy\fR is NaN, a NaN is returned.
  48 .sp
  49 .LP
  50 If \fIy\fR is 0, a domain error occurs and a NaN is returned.
  51 .sp
  52 .LP
  53 If \fIx\fR is infinite, a domain error occurs and a NaN is returned.
  54 .sp
  55 .LP
  56 If \fIx\fR is \(+-0 and \fIy\fR is not 0, \(+-0 is returned.
  57 .sp
  58 .LP
  59 If \fIx\fR is not infinite and \fIy\fR is \(+-Inf, \fIx\fR is returned.
  60 .SH ERRORS
  61 .sp
  62 .LP
  63 These functions will fail if:
  64 .sp
  65 .ne 2
  66 .mk
  67 .na
  68 \fBDomain Error\fR
  69 .ad
  70 .RS 16n
  71 .rt  
  72 The \fIx\fR argument is infinite or \fIy\fR is 0.
  73 .sp
  74 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
  75 non-zero, the invalid floating-point exception is raised.
  76 .RE
  77 
  78 .SH USAGE
  79 .sp
  80 .LP
  81 An application wanting to check for exceptions should call
  82 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
  83 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
  84 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
  85 raised. An application should either examine the return value or check the
  86 floating point exception flags to detect exceptions.
  87 .SH ATTRIBUTES
  88 .sp
  89 .LP
  90 See \fBattributes\fR(5) for descriptions of the following attributes:
  91 .sp
  92 
  93 .sp
  94 .TS
  95 tab() box;
  96 cw(2.75i) |cw(2.75i) 
  97 lw(2.75i) |lw(2.75i) 
  98 .
  99 ATTRIBUTE TYPEATTRIBUTE VALUE
 100 _
 101 Interface StabilityStandard
 102 _
 103 MT-LevelMT-Safe
 104 .TE
 105 
 106 .SH SEE ALSO
 107 .sp
 108 .LP
 109 \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M), \fBisnan\fR(3M),
 110 \fBmath.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)