classutil_1_1MyMath.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.11"/>
  7. <title>Tracore: util::MyMath Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">Tracore
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.11 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  42. <li><a href="files.html"><span>Files</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. <div id="navrow2" class="tabs2">
  62. <ul class="tablist">
  63. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  64. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  65. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  66. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  67. </ul>
  68. </div>
  69. <!-- window showing the filter options -->
  70. <div id="MSearchSelectWindow"
  71. onmouseover="return searchBox.OnSearchSelectShow()"
  72. onmouseout="return searchBox.OnSearchSelectHide()"
  73. onkeydown="return searchBox.OnSearchSelectKey(event)">
  74. </div>
  75. <!-- iframe showing the search results (closed by default) -->
  76. <div id="MSearchResultsWindow">
  77. <iframe src="javascript:void(0)" frameborder="0"
  78. name="MSearchResults" id="MSearchResults">
  79. </iframe>
  80. </div>
  81. <div id="nav-path" class="navpath">
  82. <ul>
  83. <li class="navelem"><b>util</b></li><li class="navelem"><a class="el" href="classutil_1_1MyMath.html">MyMath</a></li> </ul>
  84. </div>
  85. </div><!-- top -->
  86. <div class="header">
  87. <div class="summary">
  88. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  89. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  90. <a href="classutil_1_1MyMath-members.html">List of all members</a> </div>
  91. <div class="headertitle">
  92. <div class="title">util::MyMath Class Reference</div> </div>
  93. </div><!--header-->
  94. <div class="contents">
  95. <p><code>#include &lt;<a class="el" href="MyMath_8h_source.html">MyMath.h</a>&gt;</code></p>
  96. <table class="memberdecls">
  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  98. Static Public Member Functions</h2></td></tr>
  99. <tr class="memitem:a367a261dc52a85cc97ba376799ed13a3"><td class="memItemLeft" align="right" valign="top">static double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1MyMath.html#a367a261dc52a85cc97ba376799ed13a3">Clamp</a> (double min, double max, double value)</td></tr>
  100. <tr class="separator:a367a261dc52a85cc97ba376799ed13a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:ae68f361889a9929767b0c85ad7a010f1"><td class="memItemLeft" align="right" valign="top">static double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1MyMath.html#ae68f361889a9929767b0c85ad7a010f1">Lerp</a> (double a, double b, double value)</td></tr>
  102. <tr class="separator:ae68f361889a9929767b0c85ad7a010f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a789c283b324494ab50955af1e35178d5"><td class="memItemLeft" align="right" valign="top">static double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1MyMath.html#a789c283b324494ab50955af1e35178d5">InverseLerp</a> (double a, double b, double value)</td></tr>
  104. <tr class="separator:a789c283b324494ab50955af1e35178d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:abaf214b2fc7a31e43cf07245cf4b2e1f"><td class="memItemLeft" align="right" valign="top">static double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1MyMath.html#abaf214b2fc7a31e43cf07245cf4b2e1f">EuclideanDistance</a> (cv::Point3d a, cv::Point3d b)</td></tr>
  106. <tr class="separator:abaf214b2fc7a31e43cf07245cf4b2e1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a1e70b6714c4c2c0bf22ede78db7118f2"><td class="memItemLeft" align="right" valign="top">static double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1MyMath.html#a1e70b6714c4c2c0bf22ede78db7118f2">EuclideanDistance</a> (cv::Point2d a, cv::Point2d b)</td></tr>
  108. <tr class="separator:a1e70b6714c4c2c0bf22ede78db7118f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:aab093b6bf8f989a0d1879ce382e762af"><td class="memItemLeft" align="right" valign="top">static double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1MyMath.html#aab093b6bf8f989a0d1879ce382e762af">Radian</a> (double degree)</td></tr>
  110. <tr class="separator:aab093b6bf8f989a0d1879ce382e762af"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table><table class="memberdecls">
  112. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
  113. Static Public Attributes</h2></td></tr>
  114. <tr class="memitem:a0102b31b23c28614b0b48b1e53d23135"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0102b31b23c28614b0b48b1e53d23135"></a>
  115. static const double&#160;</td><td class="memItemRight" valign="bottom"><b>PI</b> = 3.14159</td></tr>
  116. <tr class="separator:a0102b31b23c28614b0b48b1e53d23135"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. </table>
  118. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  119. <div class="textblock"><p>Utility class for mathematical operations. </p>
  120. </div><h2 class="groupheader">Member Function Documentation</h2>
  121. <a class="anchor" id="a367a261dc52a85cc97ba376799ed13a3"></a>
  122. <div class="memitem">
  123. <div class="memproto">
  124. <table class="mlabels">
  125. <tr>
  126. <td class="mlabels-left">
  127. <table class="memname">
  128. <tr>
  129. <td class="memname">double util::MyMath::Clamp </td>
  130. <td>(</td>
  131. <td class="paramtype">double&#160;</td>
  132. <td class="paramname"><em>min</em>, </td>
  133. </tr>
  134. <tr>
  135. <td class="paramkey"></td>
  136. <td></td>
  137. <td class="paramtype">double&#160;</td>
  138. <td class="paramname"><em>max</em>, </td>
  139. </tr>
  140. <tr>
  141. <td class="paramkey"></td>
  142. <td></td>
  143. <td class="paramtype">double&#160;</td>
  144. <td class="paramname"><em>value</em>&#160;</td>
  145. </tr>
  146. <tr>
  147. <td></td>
  148. <td>)</td>
  149. <td></td><td></td>
  150. </tr>
  151. </table>
  152. </td>
  153. <td class="mlabels-right">
  154. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  155. </tr>
  156. </table>
  157. </div><div class="memdoc">
  158. <p>Clamps the value between min and max, both inclusive. </p><dl class="params"><dt>Parameters</dt><dd>
  159. <table class="params">
  160. <tr><td class="paramname">min</td><td>The minimum value </td></tr>
  161. <tr><td class="paramname">max</td><td>The maximum value </td></tr>
  162. <tr><td class="paramname">value</td><td>The value to clamp </td></tr>
  163. </table>
  164. </dd>
  165. </dl>
  166. <dl class="section return"><dt>Returns</dt><dd>The clamped value </dd></dl>
  167. </div>
  168. </div>
  169. <a class="anchor" id="abaf214b2fc7a31e43cf07245cf4b2e1f"></a>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="mlabels">
  173. <tr>
  174. <td class="mlabels-left">
  175. <table class="memname">
  176. <tr>
  177. <td class="memname">double util::MyMath::EuclideanDistance </td>
  178. <td>(</td>
  179. <td class="paramtype">cv::Point3d&#160;</td>
  180. <td class="paramname"><em>a</em>, </td>
  181. </tr>
  182. <tr>
  183. <td class="paramkey"></td>
  184. <td></td>
  185. <td class="paramtype">cv::Point3d&#160;</td>
  186. <td class="paramname"><em>b</em>&#160;</td>
  187. </tr>
  188. <tr>
  189. <td></td>
  190. <td>)</td>
  191. <td></td><td></td>
  192. </tr>
  193. </table>
  194. </td>
  195. <td class="mlabels-right">
  196. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  197. </tr>
  198. </table>
  199. </div><div class="memdoc">
  200. <p>Calculates the euclidean distance of the given points. </p><dl class="params"><dt>Parameters</dt><dd>
  201. <table class="params">
  202. <tr><td class="paramname">a</td><td>The first point in 3D space </td></tr>
  203. <tr><td class="paramname">b</td><td>The second point in 3D space </td></tr>
  204. </table>
  205. </dd>
  206. </dl>
  207. <dl class="section return"><dt>Returns</dt><dd>The euclidean distance </dd></dl>
  208. </div>
  209. </div>
  210. <a class="anchor" id="a1e70b6714c4c2c0bf22ede78db7118f2"></a>
  211. <div class="memitem">
  212. <div class="memproto">
  213. <table class="mlabels">
  214. <tr>
  215. <td class="mlabels-left">
  216. <table class="memname">
  217. <tr>
  218. <td class="memname">double util::MyMath::EuclideanDistance </td>
  219. <td>(</td>
  220. <td class="paramtype">cv::Point2d&#160;</td>
  221. <td class="paramname"><em>a</em>, </td>
  222. </tr>
  223. <tr>
  224. <td class="paramkey"></td>
  225. <td></td>
  226. <td class="paramtype">cv::Point2d&#160;</td>
  227. <td class="paramname"><em>b</em>&#160;</td>
  228. </tr>
  229. <tr>
  230. <td></td>
  231. <td>)</td>
  232. <td></td><td></td>
  233. </tr>
  234. </table>
  235. </td>
  236. <td class="mlabels-right">
  237. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>Calculates the euclidean distance of the given points. </p><dl class="params"><dt>Parameters</dt><dd>
  242. <table class="params">
  243. <tr><td class="paramname">a</td><td>The first point in 2D space </td></tr>
  244. <tr><td class="paramname">b</td><td>The second point in 2D space </td></tr>
  245. </table>
  246. </dd>
  247. </dl>
  248. <dl class="section return"><dt>Returns</dt><dd>The euclidean distance </dd></dl>
  249. </div>
  250. </div>
  251. <a class="anchor" id="a789c283b324494ab50955af1e35178d5"></a>
  252. <div class="memitem">
  253. <div class="memproto">
  254. <table class="mlabels">
  255. <tr>
  256. <td class="mlabels-left">
  257. <table class="memname">
  258. <tr>
  259. <td class="memname">double util::MyMath::InverseLerp </td>
  260. <td>(</td>
  261. <td class="paramtype">double&#160;</td>
  262. <td class="paramname"><em>a</em>, </td>
  263. </tr>
  264. <tr>
  265. <td class="paramkey"></td>
  266. <td></td>
  267. <td class="paramtype">double&#160;</td>
  268. <td class="paramname"><em>b</em>, </td>
  269. </tr>
  270. <tr>
  271. <td class="paramkey"></td>
  272. <td></td>
  273. <td class="paramtype">double&#160;</td>
  274. <td class="paramname"><em>value</em>&#160;</td>
  275. </tr>
  276. <tr>
  277. <td></td>
  278. <td>)</td>
  279. <td></td><td></td>
  280. </tr>
  281. </table>
  282. </td>
  283. <td class="mlabels-right">
  284. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  285. </tr>
  286. </table>
  287. </div><div class="memdoc">
  288. <p>Inverse linearly interpolates between a and b at value. </p><dl class="params"><dt>Parameters</dt><dd>
  289. <table class="params">
  290. <tr><td class="paramname">a</td><td>The first value </td></tr>
  291. <tr><td class="paramname">b</td><td>The second value </td></tr>
  292. <tr><td class="paramname">value</td><td>The value to get the interpolation of </td></tr>
  293. </table>
  294. </dd>
  295. </dl>
  296. <dl class="section return"><dt>Returns</dt><dd>The interpolation value </dd></dl>
  297. </div>
  298. </div>
  299. <a class="anchor" id="ae68f361889a9929767b0c85ad7a010f1"></a>
  300. <div class="memitem">
  301. <div class="memproto">
  302. <table class="mlabels">
  303. <tr>
  304. <td class="mlabels-left">
  305. <table class="memname">
  306. <tr>
  307. <td class="memname">double util::MyMath::Lerp </td>
  308. <td>(</td>
  309. <td class="paramtype">double&#160;</td>
  310. <td class="paramname"><em>a</em>, </td>
  311. </tr>
  312. <tr>
  313. <td class="paramkey"></td>
  314. <td></td>
  315. <td class="paramtype">double&#160;</td>
  316. <td class="paramname"><em>b</em>, </td>
  317. </tr>
  318. <tr>
  319. <td class="paramkey"></td>
  320. <td></td>
  321. <td class="paramtype">double&#160;</td>
  322. <td class="paramname"><em>value</em>&#160;</td>
  323. </tr>
  324. <tr>
  325. <td></td>
  326. <td>)</td>
  327. <td></td><td></td>
  328. </tr>
  329. </table>
  330. </td>
  331. <td class="mlabels-right">
  332. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  333. </tr>
  334. </table>
  335. </div><div class="memdoc">
  336. <p>Linearly interpolates between a and b at value. </p><dl class="params"><dt>Parameters</dt><dd>
  337. <table class="params">
  338. <tr><td class="paramname">a</td><td>The first value </td></tr>
  339. <tr><td class="paramname">b</td><td>The second value </td></tr>
  340. <tr><td class="paramname">value</td><td>The interpolation value </td></tr>
  341. </table>
  342. </dd>
  343. </dl>
  344. <dl class="section return"><dt>Returns</dt><dd>The interpolated value </dd></dl>
  345. </div>
  346. </div>
  347. <a class="anchor" id="aab093b6bf8f989a0d1879ce382e762af"></a>
  348. <div class="memitem">
  349. <div class="memproto">
  350. <table class="mlabels">
  351. <tr>
  352. <td class="mlabels-left">
  353. <table class="memname">
  354. <tr>
  355. <td class="memname">double util::MyMath::Radian </td>
  356. <td>(</td>
  357. <td class="paramtype">double&#160;</td>
  358. <td class="paramname"><em>degree</em></td><td>)</td>
  359. <td></td>
  360. </tr>
  361. </table>
  362. </td>
  363. <td class="mlabels-right">
  364. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  365. </tr>
  366. </table>
  367. </div><div class="memdoc">
  368. <p>Calculates the radian value of the given degree value. </p><dl class="params"><dt>Parameters</dt><dd>
  369. <table class="params">
  370. <tr><td class="paramname">degree</td><td>The arc value in degree </td></tr>
  371. </table>
  372. </dd>
  373. </dl>
  374. <dl class="section return"><dt>Returns</dt><dd>The arc value in radian </dd></dl>
  375. </div>
  376. </div>
  377. <hr/>The documentation for this class was generated from the following files:<ul>
  378. <li>util/<a class="el" href="MyMath_8h_source.html">MyMath.h</a></li>
  379. <li>util/MyMath.cpp</li>
  380. </ul>
  381. </div><!-- contents -->
  382. <!-- start footer part -->
  383. <hr class="footer"/><address class="footer"><small>
  384. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  385. <img class="footer" src="doxygen.png" alt="doxygen"/>
  386. </a> 1.8.11
  387. </small></address>
  388. </body>
  389. </html>