Document G_HOOK_FLAG_USER_SHIFT.
[platform/upstream/glib.git] / docs / reference / glib / tmpl / numerical.sgml
1 <!-- ##### SECTION Title ##### -->
2 Numerical Definitions
3
4 <!-- ##### SECTION Short_Description ##### -->
5
6 Mathematical constants, and floating point decomposition.
7
8 <!-- ##### SECTION Long_Description ##### -->
9 <para>
10 GLib offers mathematical constants such as #G_PI for the value of pi;
11 many platforms have these in the C library, but some don't, the GLib
12 versions always exist.
13 </para>
14
15 <para>
16 The #GFloatIEEE754 and #GDoubleIEEE754 unions are used to access the
17         sign, mantissa and exponent of IEEE floats and doubles. These
18         unions are defined as appropriate for a given platform. 
19  IEEE floats and doubles are supported (used for
20         storage) by at least intel, ppc and sparc, for reference: <ulink url="http://twister.ou.edu/workshop.docs/common-tools/numerical_comp_guide/ncg_math.doc.html">http://twister.ou.edu/workshop.docs/common-tools/numerical_comp_guide/ncg_math.doc.html</ulink>
21 </para>
22
23 <!-- ##### SECTION See_Also ##### -->
24 <para>
25 <ulink url="http://twister.ou.edu/workshop.docs/common-tools/numerical_comp_guide/ncg_math.doc.html">http://twister.ou.edu/workshop.docs/common-tools/numerical_comp_guide/ncg_math.doc.html</ulink>
26 </para>
27
28 <!-- ##### MACRO G_IEEE754_FLOAT_BIAS ##### -->
29 <para>
30 See <ulink url="http://twister.ou.edu/workshop.docs/common-tools/numerical_comp_guide/ncg_math.doc.html">http://twister.ou.edu/workshop.docs/common-tools/numerical_comp_guide/ncg_math.doc.html</ulink>
31 </para>
32
33
34
35 <!-- ##### MACRO G_IEEE754_DOUBLE_BIAS ##### -->
36 <para>
37 See <ulink url="http://twister.ou.edu/workshop.docs/common-tools/numerical_comp_guide/ncg_math.doc.html">http://twister.ou.edu/workshop.docs/common-tools/numerical_comp_guide/ncg_math.doc.html</ulink>
38 </para>
39
40
41
42 <!-- ##### UNION GFloatIEEE754 ##### -->
43 <para>
44 The #GFloatIEEE754 and #GDoubleIEEE754 unions are used to access the
45         sign, mantissa and exponent of IEEE floats and doubles. These
46         unions are defined as appropriate for a given platform. 
47  IEEE floats and doubles are supported (used for
48         storage) by at least intel, ppc and sparc, for reference: 
49 <ulink url="http://twister.ou.edu/workshop.docs/common-tools/numerical_comp_guide/ncg_math.doc.html">http://twister.ou.edu/workshop.docs/common-tools/numerical_comp_guide/ncg_math.doc.html</ulink>
50 </para>
51
52
53 <!-- ##### UNION GDoubleIEEE754 ##### -->
54 <para>
55 The #GFloatIEEE754 and #GDoubleIEEE754 unions are used to access the
56         sign, mantissa and exponent of IEEE floats and doubles. These
57         unions are defined as appropriate for a given platform. 
58  IEEE floats and doubles are supported (used for
59         storage) by at least intel, ppc and sparc, for reference: 
60 <ulink url="http://twister.ou.edu/workshop.docs/common-tools/numerical_comp_guide/ncg_math.doc.html">http://twister.ou.edu/workshop.docs/common-tools/numerical_comp_guide/ncg_math.doc.html</ulink>
61 </para>
62
63
64 <!-- ##### MACRO G_E ##### -->
65 <para>
66 The base of natural logarithms.
67 </para>
68
69
70
71 <!-- ##### MACRO G_LN2 ##### -->
72 <para>
73 The natural logarithm of 2.
74 </para>
75
76
77
78 <!-- ##### MACRO G_LN10 ##### -->
79 <para>
80 The natural logarithm of 10.
81 </para>
82
83
84
85 <!-- ##### MACRO G_PI ##### -->
86 <para>
87 The value of pi (ratio of circle's circumference to its diameter).
88 </para>
89
90
91
92 <!-- ##### MACRO G_PI_2 ##### -->
93 <para>
94 Pi divided by 2.
95 </para>
96
97
98
99 <!-- ##### MACRO G_PI_4 ##### -->
100 <para>
101 Pi divided by 4.
102 </para>
103
104
105
106 <!-- ##### MACRO G_SQRT2 ##### -->
107 <para>
108 The square root of two.
109 </para>
110
111
112
113 <!-- ##### MACRO G_LOG_2_BASE_10 ##### -->
114 <para>
115 Used for fooling around with float formats, see 
116 <ulink url="http://twister.ou.edu/workshop.docs/common-tools/numerical_comp_guide/ncg_math.doc.html">http://twister.ou.edu/workshop.docs/common-tools/numerical_comp_guide/ncg_math.doc.html</ulink>
117 </para>
118
119
120