man3/ilogb.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 ILOGB 3 2021-03-22 "" "Linux Programmer's Manual"
  30 .SH NAME
  31 ilogb, ilogbf, ilogbl \- get integer exponent of a floating-point value
  32 .SH SYNOPSIS
  33 .nf
  34 .B #include <math.h>
  35 .PP
  36 .BI "int ilogb(double " x );
  37 .BI "int ilogbf(float " x );
  38 .BI "int ilogbl(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 ilogb ():
  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 ilogbf (),
  58 .BR ilogbl ():
  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 return the exponent part of their argument
  66 as a signed integer.
  67 When no error occurs, these functions
  68 are equivalent to the corresponding
  69 .BR logb (3)
  70 functions, cast to
  71 .IR int .
  72 .SH RETURN VALUE
  73 On success, these functions return the exponent of
  74 .IR x ,
  75 as a signed integer.
  76 .PP
  77 If
  78 .I x
  79 is zero, then a domain error occurs, and the functions return
  80 .\" the POSIX.1 spec for logb() says logb() gives pole error for this
  81 .\" case, but for ilogb() it says domain error.
  82 .BR FP_ILOGB0 .
  83 .\" glibc: The numeric value is either `INT_MIN' or `-INT_MAX'.
  84 .PP
  85 If
  86 .I x
  87 is a NaN, then a domain error occurs, and the functions return
  88 .BR FP_ILOGBNAN .
  89 .\" glibc: The numeric value is either `INT_MIN' or `INT_MAX'.
  90 .\" On i386, FP_ILOGB0 and FP_ILOGBNAN have the same value.
  91 .PP
  92 If
  93 .I x
  94 is negative infinity or positive infinity, then
  95 a domain error occurs, and the functions return
  96 .BR INT_MAX .
  97 .\"
  98 .\" POSIX.1-2001 also says:
  99 .\" If the correct value is greater than {INT_MAX}, {INT_MAX}
 100 .\" shall be returned and a domain error shall occur.
 101 .\"
 102 .\" If the correct value is less than {INT_MIN}, {INT_MIN}
 103 .\" shall be returned and a domain error shall occur.
 104 .SH ERRORS
 105 See
 106 .BR math_error (7)
 107 for information on how to determine whether an error has occurred
 108 when calling these functions.
 109 .PP
 110 The following errors can occur:
 111 .TP
 112 Domain error: \fIx\fP is 0 or a NaN
 113 An invalid floating-point exception
 114 .RB ( FE_INVALID )
 115 is raised, and
 116 .I errno
 117 is set to
 118 .BR EDOM
 119 (but see BUGS).
 120 .TP
 121 Domain error: \fIx\fP is an infinity
 122 An invalid floating-point exception
 123 .RB ( FE_INVALID )
 124 is raised, and
 125 .I errno
 126 is set to
 127 .BR EDOM
 128 (but see BUGS).
 129 .SH ATTRIBUTES
 130 For an explanation of the terms used in this section, see
 131 .BR attributes (7).
 132 .ad l
 133 .nh
 134 .TS
 135 allbox;
 136 lbx lb lb
 137 l l l.
 138 Interface       Attribute       Value
 139 T{
 140 .BR ilogb (),
 141 .BR ilogbf (),
 142 .BR ilogbl ()
 143 T}      Thread safety   MT-Safe
 144 .TE
 145 .hy
 146 .ad
 147 .sp 1
 148 .SH CONFORMING TO
 149 C99, POSIX.1-2001, POSIX.1-2008.
 150 .SH BUGS
 151 .\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6794
 152 Before version 2.16, the following bugs existed in the
 153 glibc implementation of these functions:
 154 .IP * 3
 155 The domain error case where
 156 .I x
 157 is 0 or a NaN did not cause
 158 .I errno
 159 to be set or (on some architectures) raise a floating-point exception.
 160 .IP * 3
 161 The domain error case where
 162 .I x
 163 is an infinity did not cause
 164 .I errno
 165 to be set or raise a floating-point exception.
 166 .SH SEE ALSO
 167 .BR log (3),
 168 .BR logb (3),
 169 .BR significand (3)