usr/src/man/man3m/ilogb.3m

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
  46 .\"
  47 .TH ILOGB 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  48 .SH NAME
  49 ilogb, ilogbf, ilogbl \- return an unbiased exponent
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  54 #include <math.h>
  55
  56 \fBint\fR \fBilogb\fR(\fBdouble\fR \fIx\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 \fBint\fR \fBilogbf\fR(\fBfloat\fR \fIx\fR);
  62 .fi
  63
  64 .LP
  65 .nf
  66 \fBint\fR \fBilogbl\fR(\fBlong double\fR \fIx\fR);
  67 .fi
  68
  69 .LP
  70 .nf
  71 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  72 #include <math.h>
  73
  74 \fBint\fR \fBilogb\fR(\fBdouble\fR \fIx\fR);
  75 .fi
  76
  77 .LP
  78 .nf
  79 \fBint\fR \fBilogbf\fR(\fBfloat\fR \fIx\fR);
  80 .fi
  81
  82 .LP
  83 .nf
  84 \fBint\fR \fBilogbl\fR(\fBlong double\fR \fIx\fR);
  85 .fi
  86
  87 .SH DESCRIPTION
  88 .sp
  89 .LP
  90 These functions return the exponent part of their argument \fIx\fR.  Formally,
  91 the return value is the integral part of  \fBlog\fR(r)| \fIx\fR | as a signed
  92 integral value, for non-zero \fIx\fR, where \fIr\fR is the radix of the
  93 machine's floating point arithmetic, which is the value of \fBFLT_RADIX\fR
  94 defined in <\fBfloat.h\fR>.
  95 .SH RETURN VALUES
  96 .sp
  97 .LP
  98 Upon successful completion, these functions return the exponent part of \fIx\fR
  99 as a signed integer value. They are equivalent to calling the corresponding
 100 \fBlogb\fR(3M) function and casting the returned value to type \fBint\fR.
 101 .sp
 102 .LP
 103 If \fIx\fR is 0, the value \fBFP_ILOGB0\fR is returned. For SUSv3-conforming
 104 applications compiled with the \fBc99\fR compiler driver (see
 105 \fBstandards\fR(5)), a domain error occurs.
 106 .sp
 107 .LP
 108 If \fIx\fR is \(+-Inf, the value \fBINT_MAX\fR is returned. For
 109 SUSv3-conforming applications compiled with the \fBc99\fR compiler driver, a
 110 domain error occurs.
 111 .sp
 112 .LP
 113 If \fIx\fR is NaN, the value \fBFP_ILOGBNAN\fR is returned. For
 114 SUSv3-conforming applications compiled with the \fBc99\fR compiler driver, a
 115 domain error occurs.
 116 .SH ERRORS
 117 .sp
 118 .LP
 119 These functions will fail if:
 120 .sp
 121 .ne 2
 122 .mk
 123 .na
 124 \fBDomain Error\fR
 125 .ad
 126 .RS 16n
 127 .rt
 128 The \fIx\fR argument is zero, NaN, or \(+-Inf.
 129 .sp
 130 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
 131 non-zero, then the invalid floating-point exception is raised.
 132 .RE
 133
 134 .SH ATTRIBUTES
 135 .sp
 136 .LP
 137 See \fBattributes\fR(5) for descriptions of the following attributes:
 138 .sp
 139
 140 .sp
 141 .TS
 142 tab(    ) box;
 143 cw(2.75i) |cw(2.75i)
 144 lw(2.75i) |lw(2.75i)
 145 .
 146 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 147 _
 148 Interface Stability     Standard
 149 _
 150 MT-Level        MT-Safe
 151 .TE
 152
 153 .SH SEE ALSO
 154 .sp
 155 .LP
 156 \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M), \fBlimits.h\fR(3HEAD),
 157 \fBlogb\fR(3M), \fBmath.h\fR(3HEAD), \fBscalb\fR(3M), \fBattributes\fR(5),
 158 \fBstandards\fR(5)