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