lib/libm/man/ieee.3

   1 .\" Copyright (c) 1985, 1991 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. 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: @(#)ieee.3        6.4 (Berkeley) 5/6/91
  29 .\"     $NetBSD: ieee.3,v 1.18 2003/05/20 10:15:16 wiz Exp $
  30 .\"
  31 .Dd February 25, 1994
  32 .Dt IEEE 3
  33 .Os
  34 .Sh NAME
  35 .Nm copysign ,
  36 .Nm copysignf ,
  37 .Nm finite ,
  38 .Nm finitef ,
  39 .Nm ilogb ,
  40 .Nm ilogbf ,
  41 .Nm nextafter ,
  42 .Nm nextafterf ,
  43 .Nm remainder ,
  44 .Nm remainderf ,
  45 .Nm scalbn ,
  46 .Nm scalbnf
  47 .Nd functions for IEEE arithmetic
  48 .Sh LIBRARY
  49 .Lb libm
  50 .Sh SYNOPSIS
  51 .In math.h
  52 .Ft double
  53 .Fn copysign "double x" "double y"
  54 .Ft float
  55 .Fn copysignf "float x" "float y"
  56 .Ft int
  57 .Fn finite "double x"
  58 .Ft int
  59 .Fn finitef "float x"
  60 .Ft int
  61 .Fn ilogb "double x"
  62 .Ft int
  63 .Fn ilogbf "float x"
  64 .Ft double
  65 .Fn nextafter "double x" "double y"
  66 .Ft float
  67 .Fn nextafterf "float x" "float y"
  68 .Ft double
  69 .Fn remainder "double x" "double y"
  70 .Ft float
  71 .Fn remainderf "float x" "float y"
  72 .Ft double
  73 .Fn scalbn "double x" "int n"
  74 .Ft float
  75 .Fn scalbnf "float x" "int n"
  76 .Sh DESCRIPTION
  77 These functions are required or recommended by
  78 .St -ieee754 .
  79 .Pp
  80 .Fn copysign
  81 returns
  82 .Fa x
  83 with its sign changed to
  84 .Fa y Ns 's .
  85 .Pp
  86 .Fn finite
  87 returns the value 1 just when
  88 \-\*(If \*(Lt
  89 .Fa x
  90 \*(Lt +\*(If;
  91 otherwise a
  92 zero is returned
  93 (when
  94 .Pf \\*(Ba Ns Fa x Ns \\*(Ba
  95 = \*(If or
  96 .Fa x
  97 is \*(Na).
  98 .Pp
  99 .Fn ilogb
 100 returns
 101 .Fa x Ns 's exponent
 102 .Fa n ,
 103 in integer format.
 104 .Fn ilogb \*(Pm\*(If
 105 returns
 106 .Dv INT_MAX
 107 and
 108 .Fn ilogb 0
 109 returns
 110 .Dv INT_MIN .
 111 .Pp
 112 .Fn nextafter
 113 returns the next machine representable number from
 114 .Fa x
 115 in direction
 116 .Fa y .
 117 .Pp
 118 .Fn remainder
 119 returns the remainder
 120 .Fa r
 121 :=
 122 .Fa x
 123 \-
 124 .Fa n\(**y
 125 where
 126 .Fa n
 127 is the integer nearest the exact value of
 128 .Bk -words
 129 .Fa x Ns / Ns Fa y ;
 130 .Ek
 131 moreover if
 132 .Pf \\*(Ba Fa n
 133 \-
 134 .Sm off
 135 .Fa x No / Fa y No \\*(Ba
 136 .Sm on
 137 =
 138 1/2
 139 then
 140 .Fa n
 141 is even.
 142 Consequently the remainder is computed exactly and
 143 .Sm off
 144 .Pf \\*(Ba Fa r No \\*(Ba
 145 .Sm on
 146 \*(Le
 147 .Sm off
 148 .Pf \\*(Ba Fa y No \\*(Ba/2 .
 149 .Sm on
 150 But
 151 .Fn remainder x 0
 152 and
 153 .Fn remainder \*(If 0
 154 are invalid operations that produce a \*(Na.
 155 .Pp
 156 .Fn scalbn
 157 returns
 158 .Fa x Ns \(**(2** Ns Fa n )
 159 computed by exponent manipulation.
 160 .Sh SEE ALSO
 161 .Xr math 3
 162 .Sh STANDARDS
 163 .St -ieee754
 164 .Sh HISTORY
 165 The
 166 .Nm ieee
 167 functions appeared in
 168 .Bx 4.3 .