Changes: Ready for 5.13
[man-pages.git] / man3 / significand.3
blob55b7bcd6daf4bd1642e60b682cee6d5c645347b6
1 .\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
2 .\"
3 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
4 .\" Distributed under GPL
5 .\" %%%LICENSE_END
6 .\"
7 .\" heavily based on glibc infopages, copyright Free Software Foundation
8 .\"
9 .TH SIGNIFICAND 3 2021-03-22 "GNU" "Linux Programmer's Manual"
10 .SH NAME
11 significand, significandf, significandl \-
12 get mantissa of floating-point number
13 .SH SYNOPSIS
14 .nf
15 .B #include <math.h>
16 .PP
17 .BI "double significand(double " x );
18 .BI "float significandf(float " x );
19 .BI "long double significandl(long double " x );
20 .fi
21 .PP
22 Link with \fI\-lm\fP.
23 .PP
24 .RS -4
25 Feature Test Macro Requirements for glibc (see
26 .BR feature_test_macros (7)):
27 .RE
28 .PP
29 .BR significand (),
30 .BR significandf (),
31 .BR significandl ():
32 .nf
33     /* Since glibc 2.19: */ _DEFAULT_SOURCE
34         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
35 .fi
36 .SH DESCRIPTION
37 These functions return the mantissa of
38 .I x
39 scaled to the range [1,2).
40 They are equivalent to
41 .PP
42 .in +4n
43 .EX
44 scalb(x, (double) \-ilogb(x))
45 .EE
46 .in
47 .PP
48 This function exists mainly for use in certain standardized tests
49 for IEEE 754 conformance.
50 .SH ATTRIBUTES
51 For an explanation of the terms used in this section, see
52 .BR attributes (7).
53 .ad l
54 .nh
55 .TS
56 allbox;
57 lbx lb lb
58 l l l.
59 Interface       Attribute       Value
61 .BR significand (),
62 .BR significandf (),
63 .BR significandl ()
64 T}      Thread safety   MT-Safe
65 .TE
66 .hy
67 .ad
68 .sp 1
69 .SH CONFORMING TO
70 These functions are nonstandard; the
71 .I double
72 version is available on a number of other systems.
73 .\" .SH HISTORY
74 .\" This function came from BSD.
75 .SH SEE ALSO
76 .BR ilogb (3),
77 .BR scalb (3)