xref: /freebsd/lib/msun/man/ieee_test.3 (revision 734e82fe33aa764367791a7d603b383996c6b40b)
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.\"     from: @(#)ieee.3	6.4 (Berkeley) 5/6/91
29.\"
30.Dd November 6, 2005
31.Dt IEEE_TEST 3
32.Os
33.Sh NAME
34.Nm scalb ,
35.Nm scalbf ,
36.Nm significand ,
37.Nm significandf
38.Nd IEEE test functions
39.Sh LIBRARY
40.Lb libm
41.Sh SYNOPSIS
42.In math.h
43.Ft double
44.Fn scalb "double x" "double n"
45.Ft float
46.Fn scalbf "float x" "float n"
47.Ft double
48.Fn significand "double x"
49.Ft float
50.Fn significandf "float 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 scalb x n
57and
58.Fn scalbf x n
59return
60.Fa x Ns \(**(2** Ns Fa n )
61computed by exponent manipulation.
62If
63.Fa n
64is not an integer, \*(Pm\*(If, or an \*(Na, the result is unspecified.
65.Pp
66.Fn significand x
67and
68.Fn significandf x
69return
70.Fa sig ,
71where
72.Fa x
73:=
74.Fa sig No \(** 2** Ns Fa n
75with 1 \(<=
76.Fa sig
77< 2.
78.Fn significand x
79and
80.Fn significandf x
81are not defined when
82.Fa x
83is 0, \*(Pm\*(If, or \*(Na.
84.Sh SEE ALSO
85.Xr ieee 3 ,
86.Xr math 3
87.Sh STANDARDS
88.St -ieee754
89