lib/msun/man/fmod.3

   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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     from: @(#)fmod.3        5.1 (Berkeley) 5/2/91
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 19, 2008
  32 .Dt FMOD 3
  33 .Os
  34 .Sh NAME
  35 .Nm fmod ,
  36 .Nm fmodf ,
  37 .Nm fmodl
  38 .Nd floating-point remainder functions
  39 .Sh LIBRARY
  40 .Lb libm
  41 .Sh SYNOPSIS
  42 .In math.h
  43 .Ft double
  44 .Fn fmod "double x" "double y"
  45 .Ft float
  46 .Fn fmodf "float x" "float y"
  47 .Ft long double
  48 .Fn fmodl "long double x" "long double y"
  49 .Sh DESCRIPTION
  50 The
  51 .Fn fmod ,
  52 .Fn fmodf ,
  53 and
  54 .Fn fmodl
  55 functions compute the floating-point remainder of
  56 .Fa x Ns / Fa y .
  57 .Sh RETURN VALUES
  58 If
  59 .Fa y
  60 is non-zero, the
  61 .Fn fmod ,
  62 .Fn fmodf ,
  63 and
  64 .Fn fmodl
  65 functions return the value
  66 .Sm off
  67 .Fa x - Em i * Fa y ,
  68 .Sm on
  69 for some integer
  70 .Em i ,
  71 such that the result has the same sign as
  72 .Fa x
  73 and magnitude less than the magnitude of
  74 .Fa y .
  75 If
  76 .Fa y
  77 is zero, a \*(Na is produced.
  78 .Sh SEE ALSO
  79 .Xr math 3
  80 .Sh STANDARDS
  81 The
  82 .Fn fmod ,
  83 .Fn fmodf ,
  84 and
  85 .Fn fmodl
  86 functions conform to
  87 .St -isoC-99 .