xref: /freebsd/lib/msun/man/ieee_test.3 (revision 952d112864d8008aa87278a30a539d888a8493cd)
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$
34.\"
35.Dd March 10, 1994
36.Dt IEEE_TEST 3
37.Os
38.Sh NAME
39.Nm logb ,
40.Nm logbf ,
41.Nm scalb ,
42.Nm scalbf ,
43.Nm significand ,
44.Nm significandf
45.Nd IEEE test functions
46.Sh SYNOPSIS
47.Fd #include <math.h>
48.Ft double
49.Fn logb "double x"
50.Ft float
51.Fn logbf "float x"
52.Ft double
53.Fn scalb "double x" "double n"
54.Ft float
55.Fn scalbf "float x" "float n"
56.Ft double
57.Fn significand "double x"
58.Ft float
59.Fn significandf "float x"
60.Sh DESCRIPTION
61These functions allow users to test conformance to
62.St -ieee754 .
63Their use is not otherwise recommended.
64.Pp
65.Fn logb x
66and
67.Fn logbf x
68return
69.Fa x Ns 's exponent
70.Fa n ,
71a signed integer converted to double\-precision floating\-point.
72.Fn logb \*(Pm\*(If
73= +\*(If;
74.Fn logb 0
75= -\*(If with a division by zero exception.
76.Pp
77.Fn scalbn x n
78and
79.Fn scalbnf x n
80return
81.Fa x Ns \(**(2** Ns Fa n )
82computed by exponent manipulation.
83.Pp
84.Fn significand x
85and
86.Fn significandf x
87return
88.Fa sig ,
89where
90.Fa x
91:=
92.Fa sig No \(** 2** Ns Fa n
93with 1 \(<=
94.Fa sig
95< 2.
96.Fn significand x
97and
98.Fn significandf x
99are not defined when
100.Fa x
101is 0, \*(Pm\*(If, or \*(Na.
102.Sh SEE ALSO
103.Xr ieee 3 ,
104.Xr math 3
105
106.Sh STANDARDS
107.St -ieee754
108