xref: /freebsd/lib/msun/man/ieee_test.3 (revision 17ee9d00bc1ae1e598c38f25826f861e4bc6c3ce)
1.\" Copyright (c) 1985, 1991 Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     from: @(#)ieee.3	6.4 (Berkeley) 5/6/91
33.\"	$Id: ieee_test.3,v 1.1 1994/03/11 17:19:01 jtc Exp $
34.\"
35.Dd March 10, 1994
36.Dt IEEE_TEST 3
37.Os
38.Sh NAME
39.Nm logb ,
40.Nm scalb ,
41.Nm significand
42.Nd IEEE test functions
43.Sh SYNOPSIS
44.Fd #include <math.h>
45.Ft double
46.Fn logb "double x"
47.Ft double
48.Fn scalb "double x" "double n"
49.Ft double
50.Fn significand "double x"
51.Sh DESCRIPTION
52These functions allow users to test conformance to
53.St -ieee754 .
54Their use is not otherwise recommended.
55.Pp
56.Fn logb x
57returns
58.Fa x Ns 's exponent
59.Fa n ,
60a signed integer converted to double\-precision floating\-point.
61.Fn logb \*(Pm\*(If
62= +\*(If;
63.Fn logb 0
64= -\*(If with a division by zero exception.
65.Pp
66.Fn scalbn x n
67returns
68.Fa x Ns \(**(2** Ns Fa n )
69computed by exponent manipulation.
70.Pp
71.Fn significand x
72returns
73.Fa sig ,
74where
75.Fa x
76:=
77.Fa sig No \(** 2** Ns Fa n
78with 1 \(<=
79.Fa sig
80< 2.
81.Fn significand x
82is not defined when
83.Fa x
84is 0, \*(Pm\*(If, or \*(Na.
85.Sh SEE ALSO
86.Xr ieee 3 ,
87.Xr math 3
88
89.Sh STANDARDS
90.St -ieee754
91