-
Notifications
You must be signed in to change notification settings - Fork 1
/
BasicMathFunctions_8h_source.html
196 lines (194 loc) · 19 KB
/
BasicMathFunctions_8h_source.html
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
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DGtal: BasicMathFunctions.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="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.3/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">DGtal
 <span id="projectnumber">1.4.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('BasicMathFunctions_8h_source.html',''); initResizable(); });
/* @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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">BasicMathFunctions.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>  </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#if defined(BasicMathFunctions_RECURSES)</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#error Recursive header files inclusion detected in BasicMathFunctions.h</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#else </span><span class="comment">// defined(BasicMathFunctions_RECURSES)</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span>#define BasicMathFunctions_RECURSES</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#if !defined BasicMathFunctions_h</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#define BasicMathFunctions_h</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// Inclusions</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#include <algorithm></span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#include <functional></span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#include "DGtal/base/Common.h"</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#include "DGtal/base/Bits.h"</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#include "DGtal/kernel/NumberTraits.h"</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">namespace </span><a class="code" href="namespaceDGtal.html">DGtal</a> </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">namespace </span>functions</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  {</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="namespaceDGtal_1_1functions.html#a18b68d329aa1461a0847a18e99247885"> 73</a></span>  T <a class="code" href="namespaceDGtal_1_1functions.html#a18b68d329aa1461a0847a18e99247885">power</a>(<span class="keyword">const</span> T&aVal, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> exponent)</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  {</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> q=exponent;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  T p(aVal);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">if</span> (exponent == 0) { <span class="keywordflow">return</span> 1; }</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  T result = <a class="code" href="structDGtal_1_1NumberTraits.html">NumberTraits<T>::ONE</a>;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">while</span> (q != 0) </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  {</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">if</span> (q % 2 == 1) { <span class="comment">// q is odd</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  result *= p;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  q--;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  }</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  p *= p;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  q /= 2;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  }</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">return</span> result;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T> </div>
<div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="namespaceDGtal_1_1functions.html#a48dff4e7a37ef5122f124d830b4b177a"> 102</a></span>  T <a class="code" href="namespaceDGtal_1_1functions.html#a48dff4e7a37ef5122f124d830b4b177a">roundToUpperPowerOfTwo</a>(<span class="keyword">const</span> T &n){</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordflow">return</span> (T) 1 << (1+<a class="code" href="structDGtal_1_1Bits.html#a25b5f464fec0d951d75f1fe10a07f0ea">DGtal::Bits::mostSignificantBit</a>( (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) n-1 ) );</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  }</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
<div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="namespaceDGtal_1_1functions.html#af95dcf36f806f7fc15626ca6b1c27d22"> 116</a></span>  T <a class="code" href="namespaceDGtal_1_1functions.html#af95dcf36f806f7fc15626ca6b1c27d22">abs</a>(<span class="keyword">const</span> T & a)</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  {</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  BOOST_CONCEPT_ASSERT((<a class="code" href="structboost_1_1LessThanComparable.html">boost::LessThanComparable<T></a>));</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordflow">if</span> (a<0) </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordflow">return</span> -a;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordflow">else</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordflow">return</span> a;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  }</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">inline</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="namespaceDGtal_1_1functions.html#ac8e2160844093488cdd738354027daa1"> 133</a></span>  T <a class="code" href="namespaceDGtal_1_1functions.html#ac8e2160844093488cdd738354027daa1">square</a>( T x )</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  { <span class="keywordflow">return</span> x * x; }</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  </div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">inline</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="namespaceDGtal_1_1functions.html#a4828e0475cb9aa8dceefa94f0ab4d168"> 144</a></span>  T <a class="code" href="namespaceDGtal_1_1functions.html#a4828e0475cb9aa8dceefa94f0ab4d168">cube</a>( T x )</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  { <span class="keywordflow">return</span> x * x * x; }</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  } <span class="comment">// namespace functions</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> } <span class="comment">// namespace DGTal</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  </div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  </div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  </div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  </div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="preprocessor">#endif </span><span class="comment">// !defined BasicMathFunctions_h</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  </div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="preprocessor">#undef BasicMathFunctions_RECURSES</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="preprocessor">#endif </span><span class="comment">// else defined(BasicMathFunctions_RECURSES)</span></div>
<div class="ttc" id="anamespaceDGtal_1_1functions_html_a18b68d329aa1461a0847a18e99247885"><div class="ttname"><a href="namespaceDGtal_1_1functions.html#a18b68d329aa1461a0847a18e99247885">DGtal::functions::power</a></div><div class="ttdeci">T power(const T &aVal, const unsigned int exponent)</div><div class="ttdef"><b>Definition:</b> <a href="BasicMathFunctions_8h_source.html#l00073">BasicMathFunctions.h:73</a></div></div>
<div class="ttc" id="anamespaceDGtal_1_1functions_html_a4828e0475cb9aa8dceefa94f0ab4d168"><div class="ttname"><a href="namespaceDGtal_1_1functions.html#a4828e0475cb9aa8dceefa94f0ab4d168">DGtal::functions::cube</a></div><div class="ttdeci">T cube(T x)</div><div class="ttdef"><b>Definition:</b> <a href="BasicMathFunctions_8h_source.html#l00144">BasicMathFunctions.h:144</a></div></div>
<div class="ttc" id="anamespaceDGtal_1_1functions_html_a48dff4e7a37ef5122f124d830b4b177a"><div class="ttname"><a href="namespaceDGtal_1_1functions.html#a48dff4e7a37ef5122f124d830b4b177a">DGtal::functions::roundToUpperPowerOfTwo</a></div><div class="ttdeci">T roundToUpperPowerOfTwo(const T &n)</div><div class="ttdef"><b>Definition:</b> <a href="BasicMathFunctions_8h_source.html#l00102">BasicMathFunctions.h:102</a></div></div>
<div class="ttc" id="anamespaceDGtal_1_1functions_html_ac8e2160844093488cdd738354027daa1"><div class="ttname"><a href="namespaceDGtal_1_1functions.html#ac8e2160844093488cdd738354027daa1">DGtal::functions::square</a></div><div class="ttdeci">T square(T x)</div><div class="ttdef"><b>Definition:</b> <a href="BasicMathFunctions_8h_source.html#l00133">BasicMathFunctions.h:133</a></div></div>
<div class="ttc" id="anamespaceDGtal_1_1functions_html_af95dcf36f806f7fc15626ca6b1c27d22"><div class="ttname"><a href="namespaceDGtal_1_1functions.html#af95dcf36f806f7fc15626ca6b1c27d22">DGtal::functions::abs</a></div><div class="ttdeci">T abs(const T &a)</div><div class="ttdef"><b>Definition:</b> <a href="BasicMathFunctions_8h_source.html#l00116">BasicMathFunctions.h:116</a></div></div>
<div class="ttc" id="anamespaceDGtal_html"><div class="ttname"><a href="namespaceDGtal.html">DGtal</a></div><div class="ttdoc">DGtal is the top-level namespace which contains all DGtal functions and types.</div></div>
<div class="ttc" id="astructDGtal_1_1Bits_html_a25b5f464fec0d951d75f1fe10a07f0ea"><div class="ttname"><a href="structDGtal_1_1Bits.html#a25b5f464fec0d951d75f1fe10a07f0ea">DGtal::Bits::mostSignificantBit</a></div><div class="ttdeci">static unsigned int mostSignificantBit(DGtal::uint8_t n)</div><div class="ttdef"><b>Definition:</b> <a href="Bits_8h_source.html#l00343">Bits.h:343</a></div></div>
<div class="ttc" id="astructDGtal_1_1NumberTraits_html"><div class="ttname"><a href="structDGtal_1_1NumberTraits.html">DGtal::NumberTraits</a></div><div class="ttdoc">Aim: The traits class for all models of Cinteger.</div><div class="ttdef"><b>Definition:</b> <a href="NumberTraits_8h_source.html#l00562">NumberTraits.h:564</a></div></div>
<div class="ttc" id="astructboost_1_1LessThanComparable_html"><div class="ttname"><a href="structboost_1_1LessThanComparable.html">boost::LessThanComparable</a></div><div class="ttdoc">Go to http://www.sgi.com/tech/stl/LessThanComparable.html.</div><div class="ttdef"><b>Definition:</b> <a href="Boost_8dox_source.html#l00048">Boost.dox:48</a></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_f2cd1aeea1cfa982bb13a5f95fa4218c.html">DGtal</a></li><li class="navelem"><a class="el" href="dir_b5108e809fa67f729d044e06289c9bff.html">math</a></li><li class="navelem"><b>BasicMathFunctions.h</b></li>
<li class="footer">Generated on Mon Dec 23 2024 13:18:27 for DGtal by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>