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 2013-08-06 "" "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 .\" .I errno
 120 .\" is set to
 121 .\" .BR EDOM .
 122 An invalid floating-point exception
 123 .RB ( FE_INVALID )
 124 is raised.
 125 .IP
 126 These functions do not set
 127 .IR errno
 128 for this case.
 129 .\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6794
 130 .TP
 131 Domain error: \fIx\fP is an infinity
 132 .\" .I errno
 133 .\" is set to
 134 .\" .BR EDOM .
 135 .\" An invalid floating-point exception
 136 .\" .RB ( FE_INVALID )
 137 .\" is raised.
 138 .IP
 139 These functions do not set
 140 .IR errno
 141 or raise an exception for this case.
 142 .\" FIXME . Is it intentional that these functions do not set errno,
 143 .\" or raise an exception?
 144 .\" log(), log2(), log10() do set errno
 145 .\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6794
 146 .SH ATTRIBUTES
 147 .SS Multithreading (see pthreads(7))
 148 The
 149 .BR ilogb (),
 150 .BR ilogbf (),
 151 and
 152 .BR ilogbl ()
 153 functions are thread-safe.
 154 .SH CONFORMING TO
 155 C99, POSIX.1-2001.
 156 .SH SEE ALSO
 157 .BR log (3),
 158 .BR logb (3),
 159 .BR significand (3)
 160 .SH COLOPHON
 161 This page is part of release 3.68 of the Linux
 162 .I man-pages
 163 project.
 164 A description of the project,
 165 information about reporting bugs,
 166 and the latest version of this page,
 167 can be found at
 168 \%http://www.kernel.org/doc/man\-pages/.