class_bit_matrix.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: BitMatrix 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. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-methods">Public Member Functions</a> &#124;
  73. <a href="class_bit_matrix-members.html">List of all members</a> </div>
  74. <div class="headertitle"><div class="title">BitMatrix Class Reference</div></div>
  75. </div><!--header-->
  76. <div class="contents">
  77. <p><code>#include &lt;bitMatrix.h&gt;</code></p>
  78. <table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  80. Public Member Functions</h2></td></tr>
  81. <tr class="memitem:ae9ee1020b9b3c1e35cc2c9d88d3a9175" id="r_ae9ee1020b9b3c1e35cc2c9d88d3a9175"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bit_matrix.html#ae9ee1020b9b3c1e35cc2c9d88d3a9175">BitMatrix</a> (const U32 width, const U32 height)</td></tr>
  82. <tr class="separator:ae9ee1020b9b3c1e35cc2c9d88d3a9175"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a6df32faac2a41ebd08957eca340e58ac" id="r_a6df32faac2a41ebd08957eca340e58ac"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bit_matrix.html#a6df32faac2a41ebd08957eca340e58ac">~BitMatrix</a> ()</td></tr>
  84. <tr class="separator:a6df32faac2a41ebd08957eca340e58ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr><td colspan="2"><div class="groupHeader">Setters</div></td></tr>
  86. <tr class="memitem:a5b69f33c61a5274c68bb65edc6a1aa0b" id="r_a5b69f33c61a5274c68bb65edc6a1aa0b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bit_matrix.html#a5b69f33c61a5274c68bb65edc6a1aa0b">clearAllBits</a> ()</td></tr>
  87. <tr class="memdesc:a5b69f33c61a5274c68bb65edc6a1aa0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set all the bits in the matrix to false. <br /></td></tr>
  88. <tr class="separator:a5b69f33c61a5274c68bb65edc6a1aa0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a4358f6338b95c85d3365b9f3aa785e47" id="r_a4358f6338b95c85d3365b9f3aa785e47"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bit_matrix.html#a4358f6338b95c85d3365b9f3aa785e47">setAllBits</a> ()</td></tr>
  90. <tr class="memdesc:a4358f6338b95c85d3365b9f3aa785e47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set all the bits in the matrix to true. <br /></td></tr>
  91. <tr class="separator:a4358f6338b95c85d3365b9f3aa785e47"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:aa51cef2296c4b7b369a956045a6446d5" id="r_aa51cef2296c4b7b369a956045a6446d5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bit_matrix.html#aa51cef2296c4b7b369a956045a6446d5">setBit</a> (const U32 x, const U32 y)</td></tr>
  93. <tr class="memdesc:aa51cef2296c4b7b369a956045a6446d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a bit at a given location in the matrix. <br /></td></tr>
  94. <tr class="separator:aa51cef2296c4b7b369a956045a6446d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a672c09f0906f4cab9901235c5410942e" id="r_a672c09f0906f4cab9901235c5410942e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bit_matrix.html#a672c09f0906f4cab9901235c5410942e">clearBit</a> (const U32 x, const U32 y)</td></tr>
  96. <tr class="memdesc:a672c09f0906f4cab9901235c5410942e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear a bit at a given location in the matrix. <br /></td></tr>
  97. <tr class="separator:a672c09f0906f4cab9901235c5410942e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr><td colspan="2"><div class="groupHeader">Queries</div></td></tr>
  99. <tr class="memitem:ae1b7032d479370e92ecac47e45ef2741" id="r_ae1b7032d479370e92ecac47e45ef2741"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bit_matrix.html#ae1b7032d479370e92ecac47e45ef2741">isSet</a> (const U32 x, const U32 y) const</td></tr>
  100. <tr class="memdesc:ae1b7032d479370e92ecac47e45ef2741"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the specified bit set? <br /></td></tr>
  101. <tr class="separator:ae1b7032d479370e92ecac47e45ef2741"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a204a8bc84deb2d8798713f2aac5bff3e" id="r_a204a8bc84deb2d8798713f2aac5bff3e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bit_matrix.html#a204a8bc84deb2d8798713f2aac5bff3e">isAnySetCol</a> (const U32 x)</td></tr>
  103. <tr class="memdesc:a204a8bc84deb2d8798713f2aac5bff3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is any bit in the given column set? <br /></td></tr>
  104. <tr class="separator:a204a8bc84deb2d8798713f2aac5bff3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a17bacf6e22985e0e9073dc95e606de8d" id="r_a17bacf6e22985e0e9073dc95e606de8d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bit_matrix.html#a17bacf6e22985e0e9073dc95e606de8d">isAnySetRow</a> (const U32 y)</td></tr>
  106. <tr class="memdesc:a17bacf6e22985e0e9073dc95e606de8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is any bit in the given row set? <br /></td></tr>
  107. <tr class="separator:a17bacf6e22985e0e9073dc95e606de8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. </table>
  109. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  110. <div class="textblock"><p>A matrix of bits.</p>
  111. <p>This class manages an array of bits. There are no limitations on the size of the bit matrix (beyond available memory).</p>
  112. <dl class="section note"><dt>Note</dt><dd>This class is currently unused. </dd></dl>
  113. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  114. <a id="ae9ee1020b9b3c1e35cc2c9d88d3a9175" name="ae9ee1020b9b3c1e35cc2c9d88d3a9175"></a>
  115. <h2 class="memtitle"><span class="permalink"><a href="#ae9ee1020b9b3c1e35cc2c9d88d3a9175">&#9670;&#160;</a></span>BitMatrix()</h2>
  116. <div class="memitem">
  117. <div class="memproto">
  118. <table class="mlabels">
  119. <tr>
  120. <td class="mlabels-left">
  121. <table class="memname">
  122. <tr>
  123. <td class="memname"><a class="el" href="class_bit_matrix.html">BitMatrix</a> </td>
  124. <td>(</td>
  125. <td class="paramtype">const U32&#160;</td>
  126. <td class="paramname"><em>width</em>, </td>
  127. </tr>
  128. <tr>
  129. <td class="paramkey"></td>
  130. <td></td>
  131. <td class="paramtype">const U32&#160;</td>
  132. <td class="paramname"><em>height</em>&#160;</td>
  133. </tr>
  134. <tr>
  135. <td></td>
  136. <td>)</td>
  137. <td></td><td></td>
  138. </tr>
  139. </table>
  140. </td>
  141. <td class="mlabels-right">
  142. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  143. </tr>
  144. </table>
  145. </div><div class="memdoc">
  146. <p>Create a new bit matrix.</p>
  147. <dl class="params"><dt>Parameters</dt><dd>
  148. <table class="params">
  149. <tr><td class="paramname">width</td><td>Width of matrix in bits. </td></tr>
  150. <tr><td class="paramname">height</td><td>Height of matrix in bits. </td></tr>
  151. </table>
  152. </dd>
  153. </dl>
  154. </div>
  155. </div>
  156. <a id="a6df32faac2a41ebd08957eca340e58ac" name="a6df32faac2a41ebd08957eca340e58ac"></a>
  157. <h2 class="memtitle"><span class="permalink"><a href="#a6df32faac2a41ebd08957eca340e58ac">&#9670;&#160;</a></span>~BitMatrix()</h2>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="mlabels">
  161. <tr>
  162. <td class="mlabels-left">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">~<a class="el" href="class_bit_matrix.html">BitMatrix</a> </td>
  166. <td>(</td>
  167. <td class="paramname"></td><td>)</td>
  168. <td></td>
  169. </tr>
  170. </table>
  171. </td>
  172. <td class="mlabels-right">
  173. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. </div>
  178. </div>
  179. <h2 class="groupheader">Member Function Documentation</h2>
  180. <a id="a5b69f33c61a5274c68bb65edc6a1aa0b" name="a5b69f33c61a5274c68bb65edc6a1aa0b"></a>
  181. <h2 class="memtitle"><span class="permalink"><a href="#a5b69f33c61a5274c68bb65edc6a1aa0b">&#9670;&#160;</a></span>clearAllBits()</h2>
  182. <div class="memitem">
  183. <div class="memproto">
  184. <table class="mlabels">
  185. <tr>
  186. <td class="mlabels-left">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname">void clearAllBits </td>
  190. <td>(</td>
  191. <td class="paramname"></td><td>)</td>
  192. <td></td>
  193. </tr>
  194. </table>
  195. </td>
  196. <td class="mlabels-right">
  197. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. <p>Set all the bits in the matrix to false. </p>
  202. </div>
  203. </div>
  204. <a id="a672c09f0906f4cab9901235c5410942e" name="a672c09f0906f4cab9901235c5410942e"></a>
  205. <h2 class="memtitle"><span class="permalink"><a href="#a672c09f0906f4cab9901235c5410942e">&#9670;&#160;</a></span>clearBit()</h2>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="mlabels">
  209. <tr>
  210. <td class="mlabels-left">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname">void clearBit </td>
  214. <td>(</td>
  215. <td class="paramtype">const U32&#160;</td>
  216. <td class="paramname"><em>x</em>, </td>
  217. </tr>
  218. <tr>
  219. <td class="paramkey"></td>
  220. <td></td>
  221. <td class="paramtype">const U32&#160;</td>
  222. <td class="paramname"><em>y</em>&#160;</td>
  223. </tr>
  224. <tr>
  225. <td></td>
  226. <td>)</td>
  227. <td></td><td></td>
  228. </tr>
  229. </table>
  230. </td>
  231. <td class="mlabels-right">
  232. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. <p>Clear a bit at a given location in the matrix. </p>
  237. </div>
  238. </div>
  239. <a id="a204a8bc84deb2d8798713f2aac5bff3e" name="a204a8bc84deb2d8798713f2aac5bff3e"></a>
  240. <h2 class="memtitle"><span class="permalink"><a href="#a204a8bc84deb2d8798713f2aac5bff3e">&#9670;&#160;</a></span>isAnySetCol()</h2>
  241. <div class="memitem">
  242. <div class="memproto">
  243. <table class="mlabels">
  244. <tr>
  245. <td class="mlabels-left">
  246. <table class="memname">
  247. <tr>
  248. <td class="memname">bool isAnySetCol </td>
  249. <td>(</td>
  250. <td class="paramtype">const U32&#160;</td>
  251. <td class="paramname"><em>x</em></td><td>)</td>
  252. <td></td>
  253. </tr>
  254. </table>
  255. </td>
  256. <td class="mlabels-right">
  257. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  258. </tr>
  259. </table>
  260. </div><div class="memdoc">
  261. <p>Is any bit in the given column set? </p>
  262. </div>
  263. </div>
  264. <a id="a17bacf6e22985e0e9073dc95e606de8d" name="a17bacf6e22985e0e9073dc95e606de8d"></a>
  265. <h2 class="memtitle"><span class="permalink"><a href="#a17bacf6e22985e0e9073dc95e606de8d">&#9670;&#160;</a></span>isAnySetRow()</h2>
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="mlabels">
  269. <tr>
  270. <td class="mlabels-left">
  271. <table class="memname">
  272. <tr>
  273. <td class="memname">bool isAnySetRow </td>
  274. <td>(</td>
  275. <td class="paramtype">const U32&#160;</td>
  276. <td class="paramname"><em>y</em></td><td>)</td>
  277. <td></td>
  278. </tr>
  279. </table>
  280. </td>
  281. <td class="mlabels-right">
  282. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  283. </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. <p>Is any bit in the given row set? </p>
  287. </div>
  288. </div>
  289. <a id="ae1b7032d479370e92ecac47e45ef2741" name="ae1b7032d479370e92ecac47e45ef2741"></a>
  290. <h2 class="memtitle"><span class="permalink"><a href="#ae1b7032d479370e92ecac47e45ef2741">&#9670;&#160;</a></span>isSet()</h2>
  291. <div class="memitem">
  292. <div class="memproto">
  293. <table class="mlabels">
  294. <tr>
  295. <td class="mlabels-left">
  296. <table class="memname">
  297. <tr>
  298. <td class="memname">bool isSet </td>
  299. <td>(</td>
  300. <td class="paramtype">const U32&#160;</td>
  301. <td class="paramname"><em>x</em>, </td>
  302. </tr>
  303. <tr>
  304. <td class="paramkey"></td>
  305. <td></td>
  306. <td class="paramtype">const U32&#160;</td>
  307. <td class="paramname"><em>y</em>&#160;</td>
  308. </tr>
  309. <tr>
  310. <td></td>
  311. <td>)</td>
  312. <td></td><td> const</td>
  313. </tr>
  314. </table>
  315. </td>
  316. <td class="mlabels-right">
  317. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  318. </tr>
  319. </table>
  320. </div><div class="memdoc">
  321. <p>Is the specified bit set? </p>
  322. </div>
  323. </div>
  324. <a id="a4358f6338b95c85d3365b9f3aa785e47" name="a4358f6338b95c85d3365b9f3aa785e47"></a>
  325. <h2 class="memtitle"><span class="permalink"><a href="#a4358f6338b95c85d3365b9f3aa785e47">&#9670;&#160;</a></span>setAllBits()</h2>
  326. <div class="memitem">
  327. <div class="memproto">
  328. <table class="mlabels">
  329. <tr>
  330. <td class="mlabels-left">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname">void setAllBits </td>
  334. <td>(</td>
  335. <td class="paramname"></td><td>)</td>
  336. <td></td>
  337. </tr>
  338. </table>
  339. </td>
  340. <td class="mlabels-right">
  341. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  342. </tr>
  343. </table>
  344. </div><div class="memdoc">
  345. <p>Set all the bits in the matrix to true. </p>
  346. </div>
  347. </div>
  348. <a id="aa51cef2296c4b7b369a956045a6446d5" name="aa51cef2296c4b7b369a956045a6446d5"></a>
  349. <h2 class="memtitle"><span class="permalink"><a href="#aa51cef2296c4b7b369a956045a6446d5">&#9670;&#160;</a></span>setBit()</h2>
  350. <div class="memitem">
  351. <div class="memproto">
  352. <table class="mlabels">
  353. <tr>
  354. <td class="mlabels-left">
  355. <table class="memname">
  356. <tr>
  357. <td class="memname">void setBit </td>
  358. <td>(</td>
  359. <td class="paramtype">const U32&#160;</td>
  360. <td class="paramname"><em>x</em>, </td>
  361. </tr>
  362. <tr>
  363. <td class="paramkey"></td>
  364. <td></td>
  365. <td class="paramtype">const U32&#160;</td>
  366. <td class="paramname"><em>y</em>&#160;</td>
  367. </tr>
  368. <tr>
  369. <td></td>
  370. <td>)</td>
  371. <td></td><td></td>
  372. </tr>
  373. </table>
  374. </td>
  375. <td class="mlabels-right">
  376. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  377. </tr>
  378. </table>
  379. </div><div class="memdoc">
  380. <p>Set a bit at a given location in the matrix. </p>
  381. </div>
  382. </div>
  383. <hr/>The documentation for this class was generated from the following file:<ul>
  384. <li>collection/<b>bitMatrix.h</b></li>
  385. </ul>
  386. </div><!-- contents -->
  387. <!-- start footer part -->
  388. <hr class="footer"/><address class="footer"><small>
  389. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  390. </small></address>
  391. </body>
  392. </html>