xref: /openbsd-src/lib/libm/man/logb.3 (revision 9f1be2b6be65d2ab47863ae5d56ddbe2b8094a6e)

.\"	$OpenBSD: logb.3,v 1.10 2016/04/26 19:49:22 tb Exp $
.\" Copyright (c) 1985, 1991 Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     from: @(#)ieee.3	6.4 (Berkeley) 5/6/91
.\"
.Dd $Mdocdate: April 26 2016 $
.Dt LOGB 3
.Os
.Sh NAME
.Nm logb ,
.Nm logbf ,
.Nm logbl ,
.Nm scalb ,
.Nm scalbf ,
.Nm scalbl ,
.Nm significand ,
.Nm significandf
.Nd IEEE test functions
.Sh SYNOPSIS
.In math.h
.Ft double
.Fn logb "double x"
.Ft float
.Fn logbf "float x"
.Ft long double
.Fn logbl "long double x"
.Ft double
.Fn scalb "double x" "double n"
.Ft float
.Fn scalbf "float x" "float n"
.Ft long double
.Fn scalbl "long double x" "long double n"
.Ft double
.Fn significand "double x"
.Ft float
.Fn significandf "float x"
.Sh DESCRIPTION
These functions allow users to test conformance to
.St -ieee754 .
Their use is not otherwise recommended.
.Pp
.Fn logb x
returns
.Fa x Ns 's exponent
.Fa n ,
a signed integer converted to double\-precision floating\-point.
.Fn logb \(+-infinity
= +infinity;
.Fn logb 0
= -infinity with a division by zero exception.
.Fn logbf
is the single precision form of
.Fn logb .
.Fn logbl
is the extended precision form of
.Fn logb .
.Pp
.Fn scalb x n
returns
.Fa x Ns *(2** Ns Fa n )
computed by exponent manipulation.
.Fn scalbf
is the single precision form of
.Fn scalb .
.Fn scalbl
is the extended precision form of
.Fn scalb .
.Pp
.Fn significand x
returns
.Fa sig ,
where
.Fa x
:=
.Fa sig No * 2** Ns Fa n
with 1 \(<=
.Fa sig
< 2.
.Fn significand x
is not defined when
.Fa x
is 0, \(+-infinity, or NaN.
.Fn significandf
is the single precision for of
.Fn significand .
.Sh SEE ALSO
.Xr fpclassify 3 ,
.Xr ilogb 3 ,
.Xr scalbn 3
.Sh STANDARDS
.St -ieee754