xref: /freebsd/lib/msun/man/ieee_test.3 (revision 6137b5f7b8c183ee8806d79b3f1d8e5e3ddb3df3)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd November 6, 2005
29.Dt IEEE_TEST 3
30.Os
31.Sh NAME
32.Nm scalb ,
33.Nm scalbf ,
34.Nm significand ,
35.Nm significandf
36.Nd IEEE test functions
37.Sh LIBRARY
38.Lb libm
39.Sh SYNOPSIS
40.In math.h
41.Ft double
42.Fn scalb "double x" "double n"
43.Ft float
44.Fn scalbf "float x" "float n"
45.Ft double
46.Fn significand "double x"
47.Ft float
48.Fn significandf "float x"
49.Sh DESCRIPTION
50These functions allow users to test conformance to
51.St -ieee754 .
52Their use is not otherwise recommended.
53.Pp
54.Fn scalb x n
55and
56.Fn scalbf x n
57return
58.Fa x Ns \(**(2** Ns Fa n )
59computed by exponent manipulation.
60If
61.Fa n
62is not an integer, \*(Pm\*(If, or an \*(Na, the result is unspecified.
63.Pp
64.Fn significand x
65and
66.Fn significandf x
67return
68.Fa sig ,
69where
70.Fa x
71:=
72.Fa sig No \(** 2** Ns Fa n
73with 1 \(<=
74.Fa sig
75< 2.
76.Fn significand x
77and
78.Fn significandf x
79are not defined when
80.Fa x
81is 0, \*(Pm\*(If, or \*(Na.
82.Sh SEE ALSO
83.Xr ieee 3 ,
84.Xr math 3
85.Sh STANDARDS
86.St -ieee754
87