lib/libm/man/ilogb.3

   1 .\" All rights reserved.
   2 .\"
   3 .\" Redistribution and use in source and binary forms, with or without
   4 .\" modification, are permitted provided that the following conditions
   5 .\" are met:
   6 .\" 1. Redistributions of source code must retain the above copyright
   7 .\"    notice, this list of conditions and the following disclaimer.
   8 .\" 2. Redistributions in binary form must reproduce the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer in the
  10 .\"    documentation and/or other materials provided with the distribution.
  11 .\" 4. Neither the name of the University nor the names of its contributors
  12 .\"    may be used to endorse or promote products derived from this software
  13 .\"    without specific prior written permission.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\"     from: @(#)ieee.3        6.4 (Berkeley) 5/6/91
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd December 21, 2011
  31 .Dt ILOGB 3
  32 .Os
  33 .Sh NAME
  34 .Nm ilogb ,
  35 .Nm ilogbf ,
  36 .Nm ilogbl ,
  37 .Nm logb ,
  38 .Nm logbf ,
  39 .Nm logbl
  40 .Nd extract exponent
  41 .Sh LIBRARY
  42 .Lb libm
  43 .Sh SYNOPSIS
  44 .In math.h
  45 .Ft int
  46 .Fn ilogb "double x"
  47 .Ft int
  48 .Fn ilogbf "float x"
  49 .Ft int
  50 .Fn ilogbl "long double x"
  51 .Ft double
  52 .Fn logb "double x"
  53 .Ft float
  54 .Fn logbf "float x"
  55 .Ft long double
  56 .Fn logbl "long double x"
  57 .Sh DESCRIPTION
  58 .Fn ilogb ,
  59 .Fn ilogbf
  60 and
  61 .Fn ilogbl
  62 return
  63 .Fa x Ns 's exponent
  64 in integer format.
  65 .Fn ilogb \*(Pm\*(If
  66 returns
  67 .Dv INT_MAX ,
  68 .Fn ilogb \*(Pm\*(Na
  69 returns
  70 .Dv FP_ILOGBNAN ,
  71 and
  72 .Fn ilogb 0
  73 returns
  74 .Dv FP_ILOGB0 .
  75 .Pp
  76 .Fn logb x ,
  77 .Fn logbf x ,
  78 and
  79 .Fn logbl x
  80 return
  81 .Fa x Ns 's exponent
  82 in floating\-point format with the same precision as
  83 .Fa x .
  84 .Fn logb \*(Pm\*(If
  85 returns +\*(If, and
  86 .Fn logb 0
  87 returns -\*(If with a division by zero exception.
  88 .Sh SEE ALSO
  89 .Xr frexp 3 ,
  90 .Xr math 3 ,
  91 .Xr scalbn 3
  92 .Sh STANDARDS
  93 The
  94 .Fn ilogb ,
  95 .Fn ilogbf ,
  96 .Fn ilogbl ,
  97 .Fn logb ,
  98 .Fn logbf ,
  99 and
 100 .Fn logbl
 101 routines conform to
 102 .St -isoC-99 .
 103 The latter three
 104 implement the logb function recommended by
 105 .St -ieee754 .
 106 .Sh HISTORY
 107 .Bl -tag -width "Function " -compact
 108 .It Em Function
 109 .Em "First Appeared In"
 110 .It Fn logb
 111 .Bx 4.3
 112 .It Fn ilogb
 113 .Fx 1.1.5
 114 .It Fn ilogbf
 115 .Fx 2.0
 116 .It Fn logbf
 117 .Fx 2.0
 118 .It Fn ilogbl
 119 .Dx 2.13
 120 .It Fn logbl
 121 .Dx 2.13
 122 .El