| The Android Open Source Project | a27d2ba | 2008-10-21 07:00:00 -0700 | [diff] [blame^] | 1 | .\" Copyright (c) 1991 The Regents of the University of California. |
| 2 | .\" All rights reserved. |
| 3 | .\" |
| 4 | .\" Redistribution and use in source and binary forms, with or without |
| 5 | .\" modification, are permitted provided that the following conditions |
| 6 | .\" are met: |
| 7 | .\" 1. Redistributions of source code must retain the above copyright |
| 8 | .\" notice, this list of conditions and the following disclaimer. |
| 9 | .\" 2. Redistributions in binary form must reproduce the above copyright |
| 10 | .\" notice, this list of conditions and the following disclaimer in the |
| 11 | .\" documentation and/or other materials provided with the distribution. |
| 12 | .\" 3. All advertising materials mentioning features or use of this software |
| 13 | .\" must display the following acknowledgement: |
| 14 | .\" This product includes software developed by the University of |
| 15 | .\" California, Berkeley and its contributors. |
| 16 | .\" 4. Neither the name of the University nor the names of its contributors |
| 17 | .\" may be used to endorse or promote products derived from this software |
| 18 | .\" without specific prior written permission. |
| 19 | .\" |
| 20 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND |
| 21 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 22 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 23 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE |
| 24 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 25 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| 26 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 27 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| 28 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| 29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| 30 | .\" SUCH DAMAGE. |
| 31 | .\" |
| 32 | .\" from: @(#)fmod.3 5.1 (Berkeley) 5/2/91 |
| 33 | .\" $FreeBSD: src/lib/msun/man/fmod.3,v 1.8 2001/10/13 12:23:23 bde Exp $ |
| 34 | .\" |
| 35 | .Dd May 2, 1991 |
| 36 | .Dt FMOD 3 |
| 37 | .Os |
| 38 | .Sh NAME |
| 39 | .Nm fmod , |
| 40 | .Nm fmodf |
| 41 | .Nd floating-point remainder functions |
| 42 | .Sh LIBRARY |
| 43 | .Lb libm |
| 44 | .Sh SYNOPSIS |
| 45 | .In math.h |
| 46 | .Ft double |
| 47 | .Fn fmod "double x" "double y" |
| 48 | .Ft float |
| 49 | .Fn fmodf "float x" "float y" |
| 50 | .Sh DESCRIPTION |
| 51 | The |
| 52 | .Fn fmod |
| 53 | and the |
| 54 | .Fn fmodf |
| 55 | functions compute the floating-point remainder of |
| 56 | .Fa x Ns / Fa y . |
| 57 | .Sh RETURN VALUES |
| 58 | The |
| 59 | .Fn fmod |
| 60 | and the |
| 61 | .Fn fmodf |
| 62 | functions return the value |
| 63 | .Sm off |
| 64 | .Fa x - Em i * Fa y , |
| 65 | .Sm on |
| 66 | for some integer |
| 67 | .Em i |
| 68 | such that, if |
| 69 | .Fa y |
| 70 | is non-zero, the result has the same sign as |
| 71 | .Fa x |
| 72 | and magnitude less than the magnitude of |
| 73 | .Fa y . |
| 74 | If |
| 75 | .Fa y |
| 76 | is zero, whether a domain error occurs or the |
| 77 | .Fn fmod |
| 78 | and the |
| 79 | .Fn fmodf |
| 80 | function returns zero is implementation-defined. |
| 81 | .Sh SEE ALSO |
| 82 | .Xr math 3 |
| 83 | .Sh STANDARDS |
| 84 | The |
| 85 | .Fn fmod |
| 86 | function conforms to |
| 87 | .St -isoC . |