xref: /illumos-gate/usr/src/man/man3m/ilogb.3m (revision bdc560ab289d67ddebad9a2146fd36c2662d88b1)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.

ILOGB 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
NAME
ilogb, ilogbf, ilogbl - return an unbiased exponent
SYNOPSIS

c99 [ flag... ] file... -lm [ library... ]
#include <math.h>

int ilogb(double x);

int ilogbf(float x);

int ilogbl(long double x);

cc [ flag... ] file... -lm [ library... ]
#include <math.h>

int ilogb(double x);

int ilogbf(float x);

int ilogbl(long double x);
DESCRIPTION

These functions return the exponent part of their argument x. Formally, the return value is the integral part of log(r)| x | as a signed integral value, for non-zero x, where r is the radix of the machine's floating point arithmetic, which is the value of FLT_RADIX defined in <float.h>.

RETURN VALUES

Upon successful completion, these functions return the exponent part of x as a signed integer value. They are equivalent to calling the corresponding logb(3M) function and casting the returned value to type int.

If x is 0, the value FP_ILOGB0 is returned. For SUSv3-conforming applications compiled with the c99 compiler driver (see standards(5)), a domain error occurs.

If x is \(+-Inf, the value INT_MAX is returned. For SUSv3-conforming applications compiled with the c99 compiler driver, a domain error occurs.

If x is NaN, the value FP_ILOGBNAN is returned. For SUSv3-conforming applications compiled with the c99 compiler driver, a domain error occurs.

ERRORS

These functions will fail if:

Domain Error

The x argument is zero, NaN, or \(+-Inf. If the integer expression (math_errhandling & MATH_ERREXCEPT) is non-zero, then the invalid floating-point exception is raised.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level MT-Safe
SEE ALSO

feclearexcept(3M), fetestexcept(3M), limits.h(3HEAD), logb(3M), math.h(3HEAD), scalb(3M), attributes(5), standards(5)