original/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 2014-12-31 "" "Linux Programmer's Manual"
  30 .SH NAME
  31 ilogb, ilogbf, ilogbl \- get integer exponent of a floating-point value
  32 .SH SYNOPSIS
  33 .B #include <math.h>
  34 .sp
  35 .BI "int ilogb(double " x );
  36 .br
  37 .BI "int ilogbf(float " x );
  38 .br
  39 .BI "int ilogbl(long double " x );
  40 .sp
  41 Link with \fI\-lm\fP.
  42 .sp
  43 .in -4n
  44 Feature Test Macro Requirements for glibc (see
  45 .BR feature_test_macros (7)):
  46 .in
  47 .sp
  48 .ad l
  49 .BR ilogb ():
  50 .RS 4
  51 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  52 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED ||
  53 _ISOC99_SOURCE ||
  54 _POSIX_C_SOURCE\ >=\ 200112L;
  55 .br
  56 or
  57 .I cc\ -std=c99
  58 .RE
  59 .br
  60 .BR ilogbf (),
  61 .BR ilogbl ():
  62 .RS 4
  63 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  64 _POSIX_C_SOURCE\ >=\ 200112L;
  65 .br
  66 or
  67 .I cc\ -std=c99
  68 .RE
  69 .ad b
  70 .SH DESCRIPTION
  71 These functions return the exponent part of their argument
  72 as a signed integer.
  73 When no error occurs, these functions
  74 are equivalent to the corresponding
  75 .BR logb (3)
  76 functions, cast to
  77 .IR int .
  78 .SH RETURN VALUE
  79 On success, these functions return the exponent of
  80 .IR x ,
  81 as a signed integer.
  82
  83 If
  84 .I x
  85 is zero, then a domain error occurs, and the functions return
  86 .\" the POSIX.1 spec for logb() says logb() gives pole error for this
  87 .\" case, but for ilogb() it says domain error.
  88 .BR FP_ILOGB0 .
  89 .\" glibc: The numeric value is either `INT_MIN' or `-INT_MAX'.
  90
  91 If
  92 .I x
  93 is a NaN, then a domain error occurs, and the functions return
  94 .BR FP_ILOGBNAN .
  95 .\" glibc: The numeric value is either `INT_MIN' or `INT_MAX'.
  96 .\" On i386, FP_ILOGB0 and FP_ILOGBNAN have the same value.
  97
  98 If
  99 .I x
 100 is negative infinity or positive infinity, then
 101 a domain error occurs, and the functions return
 102 .BR INT_MAX .
 103 .\"
 104 .\" POSIX.1-2001 also says:
 105 .\" If the correct value is greater than {INT_MAX}, {INT_MAX}
 106 .\" shall be returned and a domain error shall occur.
 107 .\"
 108 .\" If the correct value is less than {INT_MIN}, {INT_MIN}
 109 .\" shall be returned and a domain error shall occur.
 110 .SH ERRORS
 111 See
 112 .BR math_error (7)
 113 for information on how to determine whether an error has occurred
 114 when calling these functions.
 115 .PP
 116 The following errors can occur:
 117 .TP
 118 Domain error: \fIx\fP is 0 or a NaN
 119 An invalid floating-point exception
 120 .RB ( FE_INVALID )
 121 is raised, and
 122 .I errno
 123 is set to
 124 .BR EDOM
 125 (but see BUGS).
 126 .IP
 127 .TP
 128 Domain error: \fIx\fP is an infinity
 129 An invalid floating-point exception
 130 .RB ( FE_INVALID )
 131 is raised, and
 132 .I errno
 133 is set to
 134 .BR EDOM
 135 (but see BUGS).
 136 .SH ATTRIBUTES
 137 .SS Multithreading (see pthreads(7))
 138 The
 139 .BR ilogb (),
 140 .BR ilogbf (),
 141 and
 142 .BR ilogbl ()
 143 functions are thread-safe.
 144 .SH CONFORMING TO
 145 C99, POSIX.1-2001.
 146 .SH BUGS
 147 .\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6794
 148 Before version 2.16, the following bugs existed in the
 149 glibc implementation of these functions:
 150 .IP * 3
 151 The domain error case where
 152 .I x
 153 is 0 or a NaN did not cause
 154 .I errno
 155 to be set or (on some achitectures) raise a floating-point exception.
 156 .IP * 3
 157 The domain error case where
 158 .I x
 159 is an infinity did not cause
 160 .I errno
 161 to be set or raise a floating-point exception.
 162 .SH SEE ALSO
 163 .BR log (3),
 164 .BR logb (3),
 165 .BR significand (3)
 166 .SH COLOPHON
 167 This page is part of release 3.79 of the Linux
 168 .I man-pages
 169 project.
 170 A description of the project,
 171 information about reporting bugs,
 172 and the latest version of this page,
 173 can be found at
 174 \%http://www.kernel.org/doc/man\-pages/.