-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNumericConstants_8h_source.html
More file actions
198 lines (196 loc) · 17.4 KB
/
Copy pathNumericConstants_8h_source.html
File metadata and controls
198 lines (196 loc) · 17.4 KB
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<!-- HTML header for doxygen 1.9.5-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>hydrobricks: /github/workspace/core/src/base/NumericConstants.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript">
DoxygenAwesomeInteractiveToc.init()
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">hydrobricks
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('NumericConstants_8h_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">NumericConstants.h</div></div>
</div><!--header-->
<div class="contents">
<a href="NumericConstants_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef HYDROBRICKS_NUMERIC_CONSTANTS_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define HYDROBRICKS_NUMERIC_CONSTANTS_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <cmath></span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <limits></span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">namespace </span>NumericConstants {</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">double</span> EPSILON_D = std::numeric_limits<double>::epsilon();</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">double</span> EPSILON_F = std::numeric_limits<float>::epsilon();</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">double</span> PRECISION = 0.00000001;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">double</span> TOLERANCE_LOOSE = 0.0001;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="foldopen" id="foldopen00051" data-start="{" data-end="}">
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="NumericConstants_8h.html#acde30944809b62828dde414ba72e1112"> 51</a></span><span class="keyword">inline</span> <span class="keywordtype">bool</span> NearlyEqual(<span class="keywordtype">double</span> a, <span class="keywordtype">double</span> b, <span class="keywordtype">double</span> tolerance = PRECISION) {</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordflow">return</span> std::fabs(a - b) <= tolerance;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>}</div>
</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="foldopen" id="foldopen00062" data-start="{" data-end="}">
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="NumericConstants_8h.html#a16ea17ced280b58868317c5cf0eb81db"> 62</a></span><span class="keyword">inline</span> <span class="keywordtype">bool</span> NearlyZero(<span class="keywordtype">double</span> value, <span class="keywordtype">double</span> tolerance = PRECISION) {</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keywordflow">return</span> std::fabs(value) <= tolerance;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span>}</div>
</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="foldopen" id="foldopen00074" data-start="{" data-end="}">
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="NumericConstants_8h.html#a26e5d98de4005d32e5e7b927ac5b57a6"> 74</a></span><span class="keyword">inline</span> <span class="keywordtype">bool</span> GreaterThan(<span class="keywordtype">double</span> a, <span class="keywordtype">double</span> b, <span class="keywordtype">double</span> tolerance = PRECISION) {</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordflow">return</span> a > b + tolerance;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span>}</div>
</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="foldopen" id="foldopen00086" data-start="{" data-end="}">
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="NumericConstants_8h.html#a25749e3124cfc66b1c371d245849dfc2"> 86</a></span><span class="keyword">inline</span> <span class="keywordtype">bool</span> LessThan(<span class="keywordtype">double</span> a, <span class="keywordtype">double</span> b, <span class="keywordtype">double</span> tolerance = PRECISION) {</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordflow">return</span> a < b - tolerance;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span>}</div>
</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="foldopen" id="foldopen00098" data-start="{" data-end="}">
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="NumericConstants_8h.html#a314ef1a5f63ccd8896195e6acca8ecdb"> 98</a></span><span class="keyword">inline</span> <span class="keywordtype">bool</span> GreaterThanOrEqual(<span class="keywordtype">double</span> a, <span class="keywordtype">double</span> b, <span class="keywordtype">double</span> tolerance = PRECISION) {</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordflow">return</span> a >= b - tolerance;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span>}</div>
</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="foldopen" id="foldopen00110" data-start="{" data-end="}">
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="NumericConstants_8h.html#aa4e3d239d11026ef5889c5260033c032"> 110</a></span><span class="keyword">inline</span> <span class="keywordtype">bool</span> LessThanOrEqual(<span class="keywordtype">double</span> a, <span class="keywordtype">double</span> b, <span class="keywordtype">double</span> tolerance = PRECISION) {</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <span class="keywordflow">return</span> a <= b + tolerance;</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span>}</div>
</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span>} <span class="comment">// namespace NumericConstants</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="comment">// Expose constants in global namespace</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="keyword">using </span>NumericConstants::EPSILON_D;</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="keyword">using </span>NumericConstants::EPSILON_F;</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="keyword">using </span>NumericConstants::PRECISION;</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="keyword">using </span>NumericConstants::TOLERANCE_LOOSE;</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="comment">// Convenience functions in global namespace</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span><span class="keyword">using </span><a class="code hl_function" href="NumericConstants_8h.html#a26e5d98de4005d32e5e7b927ac5b57a6">NumericConstants::GreaterThan</a>;</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span><span class="keyword">using </span><a class="code hl_function" href="NumericConstants_8h.html#a314ef1a5f63ccd8896195e6acca8ecdb">NumericConstants::GreaterThanOrEqual</a>;</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="keyword">using </span><a class="code hl_function" href="NumericConstants_8h.html#a25749e3124cfc66b1c371d245849dfc2">NumericConstants::LessThan</a>;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="keyword">using </span><a class="code hl_function" href="NumericConstants_8h.html#aa4e3d239d11026ef5889c5260033c032">NumericConstants::LessThanOrEqual</a>;</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="keyword">using </span><a class="code hl_function" href="NumericConstants_8h.html#acde30944809b62828dde414ba72e1112">NumericConstants::NearlyEqual</a>;</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="keyword">using </span><a class="code hl_function" href="NumericConstants_8h.html#a16ea17ced280b58868317c5cf0eb81db">NumericConstants::NearlyZero</a>;</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span><span class="preprocessor">#endif </span><span class="comment">// HYDROBRICKS_NUMERIC_CONSTANTS_H</span></div>
<div class="ttc" id="aNumericConstants_8h_html_a16ea17ced280b58868317c5cf0eb81db"><div class="ttname"><a href="NumericConstants_8h.html#a16ea17ced280b58868317c5cf0eb81db">NumericConstants::NearlyZero</a></div><div class="ttdeci">bool NearlyZero(double value, double tolerance=PRECISION)</div><div class="ttdef"><b>Definition</b> NumericConstants.h:62</div></div>
<div class="ttc" id="aNumericConstants_8h_html_a25749e3124cfc66b1c371d245849dfc2"><div class="ttname"><a href="NumericConstants_8h.html#a25749e3124cfc66b1c371d245849dfc2">NumericConstants::LessThan</a></div><div class="ttdeci">bool LessThan(double a, double b, double tolerance=PRECISION)</div><div class="ttdef"><b>Definition</b> NumericConstants.h:86</div></div>
<div class="ttc" id="aNumericConstants_8h_html_a26e5d98de4005d32e5e7b927ac5b57a6"><div class="ttname"><a href="NumericConstants_8h.html#a26e5d98de4005d32e5e7b927ac5b57a6">NumericConstants::GreaterThan</a></div><div class="ttdeci">bool GreaterThan(double a, double b, double tolerance=PRECISION)</div><div class="ttdef"><b>Definition</b> NumericConstants.h:74</div></div>
<div class="ttc" id="aNumericConstants_8h_html_a314ef1a5f63ccd8896195e6acca8ecdb"><div class="ttname"><a href="NumericConstants_8h.html#a314ef1a5f63ccd8896195e6acca8ecdb">NumericConstants::GreaterThanOrEqual</a></div><div class="ttdeci">bool GreaterThanOrEqual(double a, double b, double tolerance=PRECISION)</div><div class="ttdef"><b>Definition</b> NumericConstants.h:98</div></div>
<div class="ttc" id="aNumericConstants_8h_html_aa4e3d239d11026ef5889c5260033c032"><div class="ttname"><a href="NumericConstants_8h.html#aa4e3d239d11026ef5889c5260033c032">NumericConstants::LessThanOrEqual</a></div><div class="ttdeci">bool LessThanOrEqual(double a, double b, double tolerance=PRECISION)</div><div class="ttdef"><b>Definition</b> NumericConstants.h:110</div></div>
<div class="ttc" id="aNumericConstants_8h_html_acde30944809b62828dde414ba72e1112"><div class="ttname"><a href="NumericConstants_8h.html#acde30944809b62828dde414ba72e1112">NumericConstants::NearlyEqual</a></div><div class="ttdeci">bool NearlyEqual(double a, double b, double tolerance=PRECISION)</div><div class="ttdef"><b>Definition</b> NumericConstants.h:51</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_0af1587c8378955de40f48b4bd1869f0.html">base</a></li><li class="navelem"><a class="el" href="NumericConstants_8h.html">NumericConstants.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>