File: Poco.FPEnvironment.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (181 lines) | stat: -rw-r--r-- 10,858 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Class Poco::FPEnvironment</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.html" class="namespace">Poco</a></h1>
<h1 class="symbol">class FPEnvironment</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Foundation<br />
<b>Package:</b> Core<br />
<b>Header:</b> Poco/FPEnvironment.h</p>
<h2>Description</h2>
<div class="description">
<p>Instances of this class can be used to save and later restore the current floating point environment (consisting of rounding mode and floating-point flags). The class also provides various static methods to query certain properties of a floating-point number.  </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b>FPEnvironmentImpl</p>
<p><b>All Base Classes: </b>FPEnvironmentImpl</p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.FPEnvironment.html#6876" title="Poco::FPEnvironment::clearFlags()">clearFlags</a>, <a href="Poco.FPEnvironment.html#6894" title="Poco::FPEnvironment::copySign()">copySign</a>, <a href="Poco.FPEnvironment.html#6881" title="Poco::FPEnvironment::getRoundingMode()">getRoundingMode</a>, <a href="Poco.FPEnvironment.html#6877" title="Poco::FPEnvironment::isFlag()">isFlag</a>, <a href="Poco.FPEnvironment.html#6882" title="Poco::FPEnvironment::isInfinite()">isInfinite</a>, <a href="Poco.FPEnvironment.html#6888" title="Poco::FPEnvironment::isNaN()">isNaN</a>, <a href="Poco.FPEnvironment.html#6875" title="Poco::FPEnvironment::keepCurrent()">keepCurrent</a>, <a href="Poco.FPEnvironment.html#6873" title="Poco::FPEnvironment::operator =()">operator&nbsp;=</a>, <a href="Poco.FPEnvironment.html#6879" title="Poco::FPEnvironment::setRoundingMode()">setRoundingMode</a></p>
<h2>Enumerations</h2>
<h3><a name="6861">Flag</a></h3>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="6862">FP_DIVIDE_BY_ZERO</a> = FP_DIVIDE_BY_ZERO_IMPL</p>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="6863">FP_INEXACT</a> = FP_INEXACT_IMPL</p>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="6864">FP_OVERFLOW</a> = FP_OVERFLOW_IMPL</p>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="6865">FP_UNDERFLOW</a> = FP_UNDERFLOW_IMPL</p>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="6866">FP_INVALID</a> = FP_INVALID_IMPL</p>
<div class="description">
<p></p>
</div>
<h3><a name="6856">RoundingMode</a></h3>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="6857">FP_ROUND_DOWNWARD</a> = FP_ROUND_DOWNWARD_IMPL</p>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="6858">FP_ROUND_UPWARD</a> = FP_ROUND_UPWARD_IMPL</p>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="6859">FP_ROUND_TONEAREST</a> = FP_ROUND_TONEAREST_IMPL</p>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="6860">FP_ROUND_TOWARDZERO</a> = FP_ROUND_TOWARDZERO_IMPL</p>
<div class="description">
<p></p>
</div>
<h2>Constructors</h2>
<h3><a name="6867">FPEnvironment</a></h3>
<p class="decl"><a href="Poco.FPEnvironment.html" title="class Poco::FPEnvironment">FPEnvironment</a>();</p>
<div class="description">
<p>Standard constructor. Remembers the current environment. </p>
</div>
<h3><a name="6868">FPEnvironment</a></h3>
<p class="decl"><a href="Poco.FPEnvironment.html" title="class Poco::FPEnvironment">FPEnvironment</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.FPEnvironment.html#6856" title="enum  Poco::FPEnvironment::RoundingMode">RoundingMode</a> mode<br />);</p>
<div class="description">
<p>Remembers the current environment and sets the given rounding mode. </p>
</div>
<h3><a name="6870">FPEnvironment</a></h3>
<p class="decl"><a href="Poco.FPEnvironment.html" title="class Poco::FPEnvironment">FPEnvironment</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.FPEnvironment.html" title="class Poco::FPEnvironment">FPEnvironment</a> &amp; env<br />);</p>
<div class="description">
<p>Copy constructor. </p>
</div>
<h2>Destructor</h2>
<h3><a name="6872">~FPEnvironment</a></h3>
<p class="decl">~<a href="Poco.FPEnvironment.html" title="class Poco::FPEnvironment">FPEnvironment</a>();</p>
<div class="description">
<p>Restores the previous environment (unless <a href="Poco.FPEnvironment.html#6875" title="Poco::FPEnvironment::keepCurrent()">keepCurrent</a>() has been called previously) </p>
</div>
<h2>Member Functions</h2>
<h3><a name="6876">clearFlags</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void clearFlags();</p>
<div class="description">
<p>Resets all flags. </p>
</div>
<h3><a name="6894">copySign</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" />  <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static float copySign(<br />&nbsp;&nbsp;&nbsp;&nbsp;float target,<br />&nbsp;&nbsp;&nbsp;&nbsp;float source<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="6897">copySign</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static double copySign(<br />&nbsp;&nbsp;&nbsp;&nbsp;double target,<br />&nbsp;&nbsp;&nbsp;&nbsp;double source<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="6900">copySign</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static long double copySign(<br />&nbsp;&nbsp;&nbsp;&nbsp;long double target,<br />&nbsp;&nbsp;&nbsp;&nbsp;long double source<br />);</p>
<div class="description">
<p>Copies the sign from source to target. </p>
</div>
<h3><a name="6881">getRoundingMode</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" />  <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static <a href="Poco.FPEnvironment.html#6856" title="enum  Poco::FPEnvironment::RoundingMode">RoundingMode</a> getRoundingMode();</p>
<div class="description">
<p>Returns the current rounding mode. </p>
</div>
<h3><a name="6877">isFlag</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" />  <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static bool isFlag(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.FPEnvironment.html#6861" title="enum  Poco::FPEnvironment::Flag">Flag</a> flag<br />);</p>
<div class="description">
<p>Returns true if and only if the given flag is set. </p>
</div>
<h3><a name="6882">isInfinite</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" />  <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static bool isInfinite(<br />&nbsp;&nbsp;&nbsp;&nbsp;float value<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="6884">isInfinite</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static bool isInfinite(<br />&nbsp;&nbsp;&nbsp;&nbsp;double value<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="6886">isInfinite</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static bool isInfinite(<br />&nbsp;&nbsp;&nbsp;&nbsp;long double value<br />);</p>
<div class="description">
<p>Returns true if and only if the given number is infinite. </p>
</div>
<h3><a name="6888">isNaN</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" />  <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static bool isNaN(<br />&nbsp;&nbsp;&nbsp;&nbsp;float value<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="6890">isNaN</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static bool isNaN(<br />&nbsp;&nbsp;&nbsp;&nbsp;double value<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="6892">isNaN</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static bool isNaN(<br />&nbsp;&nbsp;&nbsp;&nbsp;long double value<br />);</p>
<div class="description">
<p>Returns true if and only if the given number is NaN. </p>
</div>
<h3><a name="6875">keepCurrent</a></h3>
<p class="decl">void keepCurrent();</p>
<div class="description">
<p>Keep the current environment even after destroying the <a href="Poco.FPEnvironment.html" title="class Poco::FPEnvironment">FPEnvironment</a> object. </p>
</div>
<h3><a name="6873">operator =</a></h3>
<p class="decl"><a href="Poco.FPEnvironment.html" title="class Poco::FPEnvironment">FPEnvironment</a> &amp; operator = (<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.FPEnvironment.html" title="class Poco::FPEnvironment">FPEnvironment</a> &amp; env<br />);</p>
<div class="description">
<p>Assignment operator </p>
</div>
<h3><a name="6879">setRoundingMode</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" />  <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void setRoundingMode(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.FPEnvironment.html#6856" title="enum  Poco::FPEnvironment::RoundingMode">RoundingMode</a> mode<br />);</p>
<div class="description">
<p>Sets the rounding mode. </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>