manual/LDP_man-pages/original/man3/logb.3

   1 .\" Copyright 2004 Andries Brouwer <aeb@cwi.nl>.
   2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .\" Inspired by a page by Walter Harms created 2002-08-10
  26 .\"
  27 .TH LOGB 3 2008-08-05 "" "Linux Programmer's Manual"
  28 .SH NAME
  29 logb, logbf, logbl \- get exponent of a floating-point value
  30 .SH SYNOPSIS
  31 .B #include <math.h>
  32 .sp
  33 .BI "double logb(double " x );
  34 .br
  35 .BI "float logbf(float " x );
  36 .br
  37 .BI "long double logbl(long double " x );
  38 .sp
  39 Link with \fI\-lm\fP.
  40 .sp
  41 .in -4n
  42 Feature Test Macro Requirements for glibc (see
  43 .BR feature_test_macros (7)):
  44 .in
  45 .sp
  46 .ad l
  47 .BR logb ():
  48 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 || _ISOC99_SOURCE; or
  49 .I cc\ -std=c99
  50 .br
  51 .BR logbf (),
  52 .BR logbl ():
  53 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE; or
  54 .I cc\ -std=c99
  55 .ad b
  56 .SH DESCRIPTION
  57 These functions extract the exponent from the
  58 internal floating-point representation of
  59 .I x
  60 and return it as a floating-point value.
  61 The integer constant
  62 .BR FLT_RADIX ,
  63 defined in
  64 .IR <float.h> ,
  65 indicates the radix used for the system's floating-point representation.
  66 If
  67 .B FLT_RADIX
  68 is 2,
  69 .BI logb( x )
  70 is equal to
  71 .BI floor(log2( x ))\fR,
  72 except that it is probably faster.
  73 .LP
  74 If
  75 .I x
  76 is subnormal,
  77 .BR logb ()
  78 returns the exponent
  79 .I x
  80 would have if it were normalized.
  81 .SH RETURN VALUE
  82 On success, these functions return the exponent of
  83 .IR x .
  84
  85 If
  86 .I x
  87 is a NaN,
  88 a NaN is returned.
  89
  90 If
  91 .I x
  92 is zero, then a pole error occurs, and the functions return
  93 .RB - HUGE_VAL ,
  94 .RB - HUGE_VALF ,
  95 or
  96 .RB - HUGE_VALL ,
  97 respectively.
  98
  99 If
 100 .I x
 101 is negative infinity or positive infinity, then
 102 positive infinity is returned.
 103 .SH ERRORS
 104 See
 105 .BR math_error (7)
 106 for information on how to determine whether an error has occurred
 107 when calling these functions.
 108 .PP
 109 The following errors can occur:
 110 .TP
 111 Pole error: \fIx\fP is 0
 112 .\" .I errno
 113 .\" is set to
 114 .\" .BR ERANGE .
 115 A divide-by-zero floating-point exception
 116 .RB ( FE_DIVBYZERO )
 117 is raised.
 118 .PP
 119 These functions do not set
 120 .IR errno .
 121 .\" FIXME . Is it intentional that these functions do not set errno?
 122 .\" log(), log2(), log10() do set errno
 123 .\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6793
 124 .\"
 125 .\" .SH HISTORY
 126 .\" The
 127 .\" .BR logb ()
 128 .\" function occurs in 4.3BSD.
 129 .\" see IEEE.3 in the 4.3BSD manual
 130 .SH "CONFORMING TO"
 131 C99, POSIX.1-2001.
 132 .SH "SEE ALSO"
 133 .BR ilogb (3),
 134 .BR log (3)