xref: /freebsd/lib/msun/man/ieee_test.3 (revision c6989859ae9388eeb46a24fe88f9b8d07101c710)
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.\" $FreeBSD$
30.\"
31.Dd November 6, 2005
32.Dt IEEE_TEST 3
33.Os
34.Sh NAME
35.Nm scalb ,
36.Nm scalbf ,
37.Nm significand ,
38.Nm significandf
39.Nd IEEE test functions
40.Sh LIBRARY
41.Lb libm
42.Sh SYNOPSIS
43.In math.h
44.Ft double
45.Fn scalb "double x" "double n"
46.Ft float
47.Fn scalbf "float x" "float n"
48.Ft double
49.Fn significand "double x"
50.Ft float
51.Fn significandf "float x"
52.Sh DESCRIPTION
53These functions allow users to test conformance to
54.St -ieee754 .
55Their use is not otherwise recommended.
56.Pp
57.Fn scalb x n
58and
59.Fn scalbf x n
60return
61.Fa x Ns \(**(2** Ns Fa n )
62computed by exponent manipulation.
63If
64.Fa n
65is not an integer, \*(Pm\*(If, or an \*(Na, the result is unspecified.
66.Pp
67.Fn significand x
68and
69.Fn significandf x
70return
71.Fa sig ,
72where
73.Fa x
74:=
75.Fa sig No \(** 2** Ns Fa n
76with 1 \(<=
77.Fa sig
78< 2.
79.Fn significand x
80and
81.Fn significandf x
82are 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.Sh STANDARDS
89.St -ieee754
90