source: NonGTP/FCollada/Documentation/_f_m_float_8h.html @ 964

Revision 964, 12.9 KB checked in by igarcia, 18 years ago (diff)
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>FCollada: FMath/FMFloat.h File Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.4.6-NO -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13    <li><a href="classes.html"><span>Classes</span></a></li>
14    <li id="current"><a href="files.html"><span>Files</span></a></li>
15    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
16  </ul></div>
17<div class="tabs">
18  <ul>
19    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
20    <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
21  </ul></div>
22<h1>FMath/FMFloat.h File Reference</h1>The file containing functions and constants for floating point values. <a href="#_details">More...</a>
23<p>
24
25<p>
26<a href="_f_m_float_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
27<tr><td></td></tr>
28<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
29<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3458b13111109beee2df9a2d42218678"></a><!-- doxytag: member="FMFloat.h::DBL_TOLERANCE" ref="3458b13111109beee2df9a2d42218678" args="" -->
30#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_f_m_float_8h.html#3458b13111109beee2df9a2d42218678">DBL_TOLERANCE</a>&nbsp;&nbsp;&nbsp;0.0001</td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default tolerance for double-sized floating-point comparison functions. <br></td></tr>
33<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e1862cb712bfc3a8d5210438601b9a1b"></a><!-- doxytag: member="FMFloat.h::FLT_TOLERANCE" ref="e1862cb712bfc3a8d5210438601b9a1b" args="" -->
34#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_f_m_float_8h.html#e1862cb712bfc3a8d5210438601b9a1b">FLT_TOLERANCE</a>&nbsp;&nbsp;&nbsp;0.0001f</td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default tolerance for single-sized floating-point comparison functions. <br></td></tr>
37<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
38<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5bb580701178fb1f9f459e91ae955e2"></a><!-- doxytag: member="FMFloat.h::DoubleList" ref="a5bb580701178fb1f9f459e91ae955e2" args="" -->
39typedef <a class="el" href="classvector.html">vector</a>&lt; double &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_f_m_float_8h.html#a5bb580701178fb1f9f459e91ae955e2">DoubleList</a></td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A dynamically-sized array of double-sized floating-point values. <br></td></tr>
42<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="28301729e6656a2428b8d728fdae0e88"></a><!-- doxytag: member="FMFloat.h::FloatList" ref="28301729e6656a2428b8d728fdae0e88" args="" -->
43typedef <a class="el" href="classvector.html">vector</a>&lt; float &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_f_m_float_8h.html#28301729e6656a2428b8d728fdae0e88">FloatList</a></td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A dynamically-sized array of floating-point values. <br></td></tr>
46<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
47<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_f_m_float_8h.html#b6dd2a235e432f2ee271b2213446fbbf">IsEquivalent</a> (float f1, float f2)</td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether two floating-point values are equivalent within a given tolerance.  <a href="#b6dd2a235e432f2ee271b2213446fbbf"></a><br></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_f_m_float_8h.html#49839e11ca3bf4c2162665c1ec062908">IsEquivalent</a> (float f1, float f2, float tolerance)</td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether two floating-point values are equivalent within a given tolerance.  <a href="#49839e11ca3bf4c2162665c1ec062908"></a><br></td></tr>
53<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_f_m_float_8h.html#eadaba3626e4515a4e0a7b965cb6ed25">IsEquivalent</a> (double f1, double f2)</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether two double-sized floating-point values are equivalent.  <a href="#eadaba3626e4515a4e0a7b965cb6ed25"></a><br></td></tr>
56<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_f_m_float_8h.html#0eb5ab4f00fba07604caa7e9d2730478">IsEquivalent</a> (double f1, double f2, double tolerance)</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether two double-sized floating-point values are equivalent within a given tolerance.  <a href="#0eb5ab4f00fba07604caa7e9d2730478"></a><br></td></tr>
59</table>
60<hr><a name="_details"></a><h2>Detailed Description</h2>
61The file containing functions and constants for floating point values.
62<p>
63<hr><h2>Function Documentation</h2>
64<a class="anchor" name="0eb5ab4f00fba07604caa7e9d2730478"></a><!-- doxytag: member="FMFloat.h::IsEquivalent" ref="0eb5ab4f00fba07604caa7e9d2730478" args="(double f1, double f2, double tolerance)" --><p>
65<table class="mdTable" cellpadding="2" cellspacing="0">
66  <tr>
67    <td class="mdRow">
68      <table cellpadding="0" cellspacing="0" border="0">
69        <tr>
70          <td class="md" nowrap valign="top">bool IsEquivalent           </td>
71          <td class="md" valign="top">(&nbsp;</td>
72          <td class="md" nowrap valign="top">double&nbsp;</td>
73          <td class="mdname" nowrap> <em>f1</em>, </td>
74        </tr>
75        <tr>
76          <td class="md" nowrap align="right"></td>
77          <td class="md"></td>
78          <td class="md" nowrap>double&nbsp;</td>
79          <td class="mdname" nowrap> <em>f2</em>, </td>
80        </tr>
81        <tr>
82          <td class="md" nowrap align="right"></td>
83          <td class="md"></td>
84          <td class="md" nowrap>double&nbsp;</td>
85          <td class="mdname" nowrap> <em>tolerance</em></td>
86        </tr>
87        <tr>
88          <td class="md"></td>
89          <td class="md">)&nbsp;</td>
90          <td class="md" colspan="2"><code> [inline]</code></td>
91        </tr>
92      </table>
93    </td>
94  </tr>
95</table>
96<table cellspacing="5" cellpadding="0" border="0">
97  <tr>
98    <td>
99      &nbsp;
100    </td>
101    <td>
102
103<p>
104Returns whether two double-sized floating-point values are equivalent within a given tolerance.
105<p>
106<dl compact><dt><b>Parameters:</b></dt><dd>
107  <table border="0" cellspacing="2" cellpadding="0">
108    <tr><td valign="top"></td><td valign="top"><em>f1</em>&nbsp;</td><td>A first double-sized floating-point value. </td></tr>
109    <tr><td valign="top"></td><td valign="top"><em>f2</em>&nbsp;</td><td>A second double-sized floating-point value. </td></tr>
110    <tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance in which to accept the two double-sized floating-point values as equivalent. </td></tr>
111  </table>
112</dl>
113    </td>
114  </tr>
115</table>
116<a class="anchor" name="eadaba3626e4515a4e0a7b965cb6ed25"></a><!-- doxytag: member="FMFloat.h::IsEquivalent" ref="eadaba3626e4515a4e0a7b965cb6ed25" args="(double f1, double f2)" --><p>
117<table class="mdTable" cellpadding="2" cellspacing="0">
118  <tr>
119    <td class="mdRow">
120      <table cellpadding="0" cellspacing="0" border="0">
121        <tr>
122          <td class="md" nowrap valign="top">bool IsEquivalent           </td>
123          <td class="md" valign="top">(&nbsp;</td>
124          <td class="md" nowrap valign="top">double&nbsp;</td>
125          <td class="mdname" nowrap> <em>f1</em>, </td>
126        </tr>
127        <tr>
128          <td class="md" nowrap align="right"></td>
129          <td class="md"></td>
130          <td class="md" nowrap>double&nbsp;</td>
131          <td class="mdname" nowrap> <em>f2</em></td>
132        </tr>
133        <tr>
134          <td class="md"></td>
135          <td class="md">)&nbsp;</td>
136          <td class="md" colspan="2"><code> [inline]</code></td>
137        </tr>
138      </table>
139    </td>
140  </tr>
141</table>
142<table cellspacing="5" cellpadding="0" border="0">
143  <tr>
144    <td>
145      &nbsp;
146    </td>
147    <td>
148
149<p>
150Returns whether two double-sized floating-point values are equivalent.
151<p>
152<dl compact><dt><b>Parameters:</b></dt><dd>
153  <table border="0" cellspacing="2" cellpadding="0">
154    <tr><td valign="top"></td><td valign="top"><em>f1</em>&nbsp;</td><td>A first double-sized floating-point value. </td></tr>
155    <tr><td valign="top"></td><td valign="top"><em>f2</em>&nbsp;</td><td>A second double-sized floating-point value. </td></tr>
156  </table>
157</dl>
158    </td>
159  </tr>
160</table>
161<a class="anchor" name="49839e11ca3bf4c2162665c1ec062908"></a><!-- doxytag: member="FMFloat.h::IsEquivalent" ref="49839e11ca3bf4c2162665c1ec062908" args="(float f1, float f2, float tolerance)" --><p>
162<table class="mdTable" cellpadding="2" cellspacing="0">
163  <tr>
164    <td class="mdRow">
165      <table cellpadding="0" cellspacing="0" border="0">
166        <tr>
167          <td class="md" nowrap valign="top">bool IsEquivalent           </td>
168          <td class="md" valign="top">(&nbsp;</td>
169          <td class="md" nowrap valign="top">float&nbsp;</td>
170          <td class="mdname" nowrap> <em>f1</em>, </td>
171        </tr>
172        <tr>
173          <td class="md" nowrap align="right"></td>
174          <td class="md"></td>
175          <td class="md" nowrap>float&nbsp;</td>
176          <td class="mdname" nowrap> <em>f2</em>, </td>
177        </tr>
178        <tr>
179          <td class="md" nowrap align="right"></td>
180          <td class="md"></td>
181          <td class="md" nowrap>float&nbsp;</td>
182          <td class="mdname" nowrap> <em>tolerance</em></td>
183        </tr>
184        <tr>
185          <td class="md"></td>
186          <td class="md">)&nbsp;</td>
187          <td class="md" colspan="2"><code> [inline]</code></td>
188        </tr>
189      </table>
190    </td>
191  </tr>
192</table>
193<table cellspacing="5" cellpadding="0" border="0">
194  <tr>
195    <td>
196      &nbsp;
197    </td>
198    <td>
199
200<p>
201Returns whether two floating-point values are equivalent within a given tolerance.
202<p>
203<dl compact><dt><b>Parameters:</b></dt><dd>
204  <table border="0" cellspacing="2" cellpadding="0">
205    <tr><td valign="top"></td><td valign="top"><em>f1</em>&nbsp;</td><td>A first floating-point value. </td></tr>
206    <tr><td valign="top"></td><td valign="top"><em>f2</em>&nbsp;</td><td>A second floating-point value. </td></tr>
207    <tr><td valign="top"></td><td valign="top"><em>tolerance</em>&nbsp;</td><td>The tolerance in which to accept the two floating-point values as equivalent. </td></tr>
208  </table>
209</dl>
210    </td>
211  </tr>
212</table>
213<a class="anchor" name="b6dd2a235e432f2ee271b2213446fbbf"></a><!-- doxytag: member="FMFloat.h::IsEquivalent" ref="b6dd2a235e432f2ee271b2213446fbbf" args="(float f1, float f2)" --><p>
214<table class="mdTable" cellpadding="2" cellspacing="0">
215  <tr>
216    <td class="mdRow">
217      <table cellpadding="0" cellspacing="0" border="0">
218        <tr>
219          <td class="md" nowrap valign="top">bool IsEquivalent           </td>
220          <td class="md" valign="top">(&nbsp;</td>
221          <td class="md" nowrap valign="top">float&nbsp;</td>
222          <td class="mdname" nowrap> <em>f1</em>, </td>
223        </tr>
224        <tr>
225          <td class="md" nowrap align="right"></td>
226          <td class="md"></td>
227          <td class="md" nowrap>float&nbsp;</td>
228          <td class="mdname" nowrap> <em>f2</em></td>
229        </tr>
230        <tr>
231          <td class="md"></td>
232          <td class="md">)&nbsp;</td>
233          <td class="md" colspan="2"><code> [inline]</code></td>
234        </tr>
235      </table>
236    </td>
237  </tr>
238</table>
239<table cellspacing="5" cellpadding="0" border="0">
240  <tr>
241    <td>
242      &nbsp;
243    </td>
244    <td>
245
246<p>
247Returns whether two floating-point values are equivalent within a given tolerance.
248<p>
249<dl compact><dt><b>Parameters:</b></dt><dd>
250  <table border="0" cellspacing="2" cellpadding="0">
251    <tr><td valign="top"></td><td valign="top"><em>f1</em>&nbsp;</td><td>A first floating-point value. </td></tr>
252    <tr><td valign="top"></td><td valign="top"><em>f2</em>&nbsp;</td><td>A second floating-point value. </td></tr>
253  </table>
254</dl>
255    </td>
256  </tr>
257</table>
258<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:40 2006 for FCollada by&nbsp;
259<a href="http://www.doxygen.org/index.html">
260<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
261</body>
262</html>
Note: See TracBrowser for help on using the repository browser.