classutil_1_1MyMath.html 16 KB

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