PageRenderTime 29ms CodeModel.GetById 0ms RepoModel.GetById 0ms app.codeStats 0ms

/libstdc++-v3/doc/html/ext/pb_ds/sample_resize_trigger.html

https://bitbucket.org/pizzafactory/pf-gcc
HTML | 462 lines | 371 code | 91 blank | 0 comment | 0 complexity | a97d6a79197942ad871c2b9214a7e21c MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. 

  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    5. 

  5. <head>
    6. 

  6.   <meta name="generator" content=
    7. 

  7.   "HTML Tidy for Linux/x86 (vers 12 April 2005), see www.w3.org" />
    8. 

  8. 

  9.   <title>sample_resize_trigger Interface</title>
    10. 

  10.   <meta http-equiv="Content-Type" content=
    11. 

  11.   "text/html; charset=us-ascii" />
    12. 

  12.   </head>
    13. 

  13. 

  14. <body>
    15. 

  15.   <div id="page">
    16. 

  16.     <h1><tt>sample_resize_trigger</tt> Interface</h1>
    17. 

  17. 

  18.     <p>A sample resize trigger policy.</p>
    19. 

  19. 

  20.     <p>This class serves to show the interface a trigger policy
    21. 

  21.     needs to support.</p>
    22. 

  22. 

  23.     <p>Defined in: <a href=
    24. 

  24.     "http://gcc.gnu.org/viewcvs/*checkout*/trunk/libstdc%2B%2B-v3/include/ext/pb_ds/detail/resize_policy/sample_resize_trigger.hpp"><tt>
    25. 

  25.     sample_resize_trigger.hpp</tt></a></p>
    26. 

  26. 

  27.     <h2><a name="link1" id="link1">Public Types and
    28. 

  28.     Constants</a></h2>
    29. 

  29. 

  30.     <h3><a name="link2" id="link2">General definitions.</a></h3>
    31. 

  31. 

  32.     <table class="c1" width="100%" border="1" summary="Types">
    33. 

  33.       <tr>
    34. 

  34.         <td width="30%" align="left"><b>Type</b></td>
    35. 

  35. 

  36.         <td width="55%" align="left"><b>Definition</b></td>
    37. 

  37. 

  38.         <td width="15%" align="left"><b>Description</b></td>
    39. 

  39.       </tr>
    40. 

  40. 

  41.       <tr>
    42. 

  42.         <td>
    43. 

  43.           <pre>
    44. 

  44. <a name="size_type55424436" id="size_type55424436">size_type</a>
    45. 

  45. </pre>
    46. 

  46.         </td>
    47. 

  47. 

  48.         <td>
    49. 

  49.           <pre>
    50. 

  50. size_t, e.g.
    51. 

  51. </pre>
    52. 

  52.         </td>
    53. 

  53. 

  54.         <td>
    55. 

  55.           <p>Size type.</p>
    56. 

  56.         </td>
    57. 

  57.       </tr>
    58. 

  58.     </table>
    59. 

  59. 

  60.     <h2><a name="link3" id="link3">Public Methods</a></h2>
    61. 

  61. 

  62.     <h3><a name="link4" id="link4">Constructors, destructor, and
    63. 

  63.     related.</a></h3>
    64. 

  64. 

  65.     <table class="c1" width="100%" border="1" summary="Methods">
    66. 

  66.       <tr>
    67. 

  67.         <td width="45%" align="left"><b>Method</b></td>
    68. 

  68. 

  69.         <td width="55%" align="left"><b>Description</b></td>
    70. 

  70.       </tr>
    71. 

  71. 

  72.       <tr>
    73. 

  73.         <td>
    74. 

  74.           <pre>
    75. 

  75.   sample_resize_trigger
    76. 

  76.   ()
    77. 

  77. </pre>
    78. 

  78.         </td>
    79. 

  79. 

  80.         <td>
    81. 

  81.           <p>Default constructor.</p>
    82. 

  82. 

  83.           <p>Must be default constructable.</p>
    84. 

  84.         </td>
    85. 

  85.       </tr>
    86. 

  86. 

  87.       <tr>
    88. 

  88.         <td>
    89. 

  89.           <pre>
    90. 

  90.   sample_range_hashing
    91. 

  91.   (<b>const</b> sample_resize_trigger &amp;other)
    92. 

  92. </pre>
    93. 

  93.         </td>
    94. 

  94. 

  95.         <td>
    96. 

  96.           <p>Copy constructor.</p>
    97. 

  97. 

  98.           <p>Must be copy constructable.</p>
    99. 

  99.         </td>
    100. 

  100.       </tr>
    101. 

  101. 

  102.       <tr>
    103. 

  103.         <td>
    104. 

  104.           <pre>
    105. 

  105. <b>inline</b> <b>void</b>
    106. 

  106.   swap
    107. 

  107.   (sample_resize_trigger &amp;other)
    108. 

  108. </pre>
    109. 

  109.         </td>
    110. 

  110. 

  111.         <td>
    112. 

  112.           <p>Swaps content.</p>
    113. 

  113. 

  114.           <p>Must be swappable (if there is such a word).</p>
    115. 

  115.         </td>
    116. 

  116.       </tr>
    117. 

  117.     </table>
    118. 

  118. 

  119.     <h2><a name="link5" id="link5">Protected Methods</a></h2>
    120. 

  120. 

  121.     <h3><a name="link6" id="link6">Insert search
    122. 

  122.     notifications.</a></h3>
    123. 

  123. 

  124.     <p>Notifications called during an insert operation.</p>
    125. 

  125. 

  126.     <table class="c1" width="100%" border="1" summary="Methods">
    127. 

  127.       <tr>
    128. 

  128.         <td width="45%" align="left"><b>Method</b></td>
    129. 

  129. 

  130.         <td width="55%" align="left"><b>Description</b></td>
    131. 

  131.       </tr>
    132. 

  132. 

  133.       <tr>
    134. 

  134.         <td>
    135. 

  135.           <pre>
    136. 

  136. <b>inline</b> <b>void</b>
    137. 

  137.   notify_insert_search_start
    138. 

  138.   ()
    139. 

  139. </pre>
    140. 

  140.         </td>
    141. 

  141. 

  142.         <td>
    143. 

  143.           <p>Notifies a search started.</p>
    144. 

  144.         </td>
    145. 

  145.       </tr>
    146. 

  146. 

  147.       <tr>
    148. 

  148.         <td>
    149. 

  149.           <pre>
    150. 

  150. <b>inline</b> <b>void</b>
    151. 

  151.   notify_insert_search_collision
    152. 

  152.   ()
    153. 

  153. </pre>
    154. 

  154.         </td>
    155. 

  155. 

  156.         <td>
    157. 

  157.           <p>Notifies a search encountered a collision.</p>
    158. 

  158.         </td>
    159. 

  159.       </tr>
    160. 

  160. 

  161.       <tr>
    162. 

  162.         <td>
    163. 

  163.           <pre>
    164. 

  164. <b>inline</b> <b>void</b>
    165. 

  165.   notify_insert_search_end
    166. 

  166.   ()
    167. 

  167. </pre>
    168. 

  168.         </td>
    169. 

  169. 

  170.         <td>
    171. 

  171.           <p>Notifies a search ended.</p>
    172. 

  172.         </td>
    173. 

  173.       </tr>
    174. 

  174.     </table>
    175. 

  175. 

  176.     <h3><a name="link7" id="link7">Find search
    177. 

  177.     notifications.</a></h3>
    178. 

  178. 

  179.     <p>Notifications called during a find operation.</p>
    180. 

  180. 

  181.     <table class="c1" width="100%" border="1" summary="Methods">
    182. 

  182.       <tr>
    183. 

  183.         <td width="45%" align="left"><b>Method</b></td>
    184. 

  184. 

  185.         <td width="55%" align="left"><b>Description</b></td>
    186. 

  186.       </tr>
    187. 

  187. 

  188.       <tr>
    189. 

  189.         <td>
    190. 

  190.           <pre>
    191. 

  191. <b>inline</b> <b>void</b>
    192. 

  192.   notify_find_search_start
    193. 

  193.   ()
    194. 

  194. </pre>
    195. 

  195.         </td>
    196. 

  196. 

  197.         <td>
    198. 

  198.           <p>Notifies a search started.</p>
    199. 

  199.         </td>
    200. 

  200.       </tr>
    201. 

  201. 

  202.       <tr>
    203. 

  203.         <td>
    204. 

  204.           <pre>
    205. 

  205. <b>inline</b> <b>void</b>
    206. 

  206.   notify_find_search_collision
    207. 

  207.   ()
    208. 

  208. </pre>
    209. 

  209.         </td>
    210. 

  210. 

  211.         <td>
    212. 

  212.           <p>Notifies a search encountered a collision.</p>
    213. 

  213.         </td>
    214. 

  214.       </tr>
    215. 

  215. 

  216.       <tr>
    217. 

  217.         <td>
    218. 

  218.           <pre>
    219. 

  219. <b>inline</b> <b>void</b>
    220. 

  220.   notify_find_search_end
    221. 

  221.   ()
    222. 

  222. </pre>
    223. 

  223.         </td>
    224. 

  224. 

  225.         <td>
    226. 

  226.           <p>Notifies a search ended.</p>
    227. 

  227.         </td>
    228. 

  228.       </tr>
    229. 

  229.     </table>
    230. 

  230. 

  231.     <h3><a name="link8" id="link8">Erase search
    232. 

  232.     notifications.</a></h3>
    233. 

  233. 

  234.     <p>Notifications called during an insert operation.</p>
    235. 

  235. 

  236.     <table class="c1" width="100%" border="1" summary="Methods">
    237. 

  237.       <tr>
    238. 

  238.         <td width="45%" align="left"><b>Method</b></td>
    239. 

  239. 

  240.         <td width="55%" align="left"><b>Description</b></td>
    241. 

  241.       </tr>
    242. 

  242. 

  243.       <tr>
    244. 

  244.         <td>
    245. 

  245.           <pre>
    246. 

  246. <b>inline</b> <b>void</b>
    247. 

  247.   notify_erase_search_start
    248. 

  248.   ()
    249. 

  249. </pre>
    250. 

  250.         </td>
    251. 

  251. 

  252.         <td>
    253. 

  253.           <p>Notifies a search started.</p>
    254. 

  254.         </td>
    255. 

  255.       </tr>
    256. 

  256. 

  257.       <tr>
    258. 

  258.         <td>
    259. 

  259.           <pre>
    260. 

  260. <b>inline</b> <b>void</b>
    261. 

  261.   notify_erase_search_collision
    262. 

  262.   ()
    263. 

  263. </pre>
    264. 

  264.         </td>
    265. 

  265. 

  266.         <td>
    267. 

  267.           <p>Notifies a search encountered a collision.</p>
    268. 

  268.         </td>
    269. 

  269.       </tr>
    270. 

  270. 

  271.       <tr>
    272. 

  272.         <td>
    273. 

  273.           <pre>
    274. 

  274. <b>inline</b> <b>void</b>
    275. 

  275.   notify_erase_search_end
    276. 

  276.   ()
    277. 

  277. </pre>
    278. 

  278.         </td>
    279. 

  279. 

  280.         <td>
    281. 

  281.           <p>Notifies a search ended.</p>
    282. 

  282.         </td>
    283. 

  283.       </tr>
    284. 

  284.     </table>
    285. 

  285. 

  286.     <h3><a name="link9" id="link9">Content change
    287. 

  287.     notifications.</a></h3>
    288. 

  288. 

  289.     <p>Notifications called when the content of the table changes
    290. 

  290.     in a way that can affect the resize policy.</p>
    291. 

  291. 

  292.     <table class="c1" width="100%" border="1" summary="Methods">
    293. 

  293.       <tr>
    294. 

  294.         <td width="45%" align="left"><b>Method</b></td>
    295. 

  295. 

  296.         <td width="55%" align="left"><b>Description</b></td>
    297. 

  297.       </tr>
    298. 

  298. 

  299.       <tr>
    300. 

  300.         <td>
    301. 

  301.           <pre>
    302. 

  302. <b>inline</b> <b>void</b>
    303. 

  303.   notify_inserted
    304. 

  304.   (<a href="#size_type55424436"><tt>size_type</tt></a> num_entries)
    305. 

  305. </pre>
    306. 

  306.         </td>
    307. 

  307. 

  308.         <td>
    309. 

  309.           <p>Notifies an element was inserted. the total number of
    310. 

  310.           entries in the table is <span class=
    311. 

  311.           "c1"><tt>num_entries</tt></span>.</p>
    312. 

  312.         </td>
    313. 

  313.       </tr>
    314. 

  314. 

  315.       <tr>
    316. 

  316.         <td>
    317. 

  317.           <pre>
    318. 

  318. <b>inline</b> <b>void</b>
    319. 

  319.   notify_erased
    320. 

  320.   (<a href="#size_type55424436"><tt>size_type</tt></a> num_entries)
    321. 

  321. </pre>
    322. 

  322.         </td>
    323. 

  323. 

  324.         <td>
    325. 

  325.           <p>Notifies an element was erased.</p>
    326. 

  326.         </td>
    327. 

  327.       </tr>
    328. 

  328. 

  329.       <tr>
    330. 

  330.         <td>
    331. 

  331.           <pre>
    332. 

  332. <b>void</b> 
    333. 

  333.   notify_cleared
    334. 

  334.   ()
    335. 

  335. </pre>
    336. 

  336.         </td>
    337. 

  337. 

  338.         <td>
    339. 

  339.           <p>Notifies the table was cleared.</p>
    340. 

  340.         </td>
    341. 

  341.       </tr>
    342. 

  342.     </table>
    343. 

  343. 

  344.     <h3><a name="link10" id="link10">Size change
    345. 

  345.     notifications.</a></h3>
    346. 

  346. 

  347.     <p>Notifications called when the table changes size.</p>
    348. 

  348. 

  349.     <table class="c1" width="100%" border="1" summary="Methods">
    350. 

  350.       <tr>
    351. 

  351.         <td width="45%" align="left"><b>Method</b></td>
    352. 

  352. 

  353.         <td width="55%" align="left"><b>Description</b></td>
    354. 

  354.       </tr>
    355. 

  355. 

  356.       <tr>
    357. 

  357.         <td>
    358. 

  358.           <pre>
    359. 

  359. <b>void</b>
    360. 

  360.   notify_resized
    361. 

  361.   (<a href="#size_type55424436"><tt>size_type</tt></a> new_size)
    362. 

  362. </pre>
    363. 

  363.         </td>
    364. 

  364. 

  365.         <td>
    366. 

  366.           <p>Notifies the table was resized as a result of this
    367. 

  367.           object's signifying that a resize is needed.</p>
    368. 

  368.         </td>
    369. 

  369.       </tr>
    370. 

  370. 

  371.       <tr>
    372. 

  372.         <td>
    373. 

  373.           <pre>
    374. 

  374. <b>void</b>
    375. 

  375.   notify_externally_resized
    376. 

  376.   (<a href="#size_type55424436"><tt>size_type</tt></a> new_size)
    377. 

  377. </pre>
    378. 

  378.         </td>
    379. 

  379. 

  380.         <td>
    381. 

  381.           <p>Notifies the table was resized externally.</p>
    382. 

  382.         </td>
    383. 

  383.       </tr>
    384. 

  384.     </table>
    385. 

  385. 

  386.     <h3><a name="link11" id="link11">Queries.</a></h3>
    387. 

  387. 

  388.     <p>Called to query whether/how to resize.</p>
    389. 

  389. 

  390.     <table class="c1" width="100%" border="1" summary="Methods">
    391. 

  391.       <tr>
    392. 

  392.         <td width="45%" align="left"><b>Method</b></td>
    393. 

  393. 

  394.         <td width="55%" align="left"><b>Description</b></td>
    395. 

  395.       </tr>
    396. 

  396. 

  397.       <tr>
    398. 

  398.         <td>
    399. 

  399.           <pre>
    400. 

  400. <b>inline</b> <b>bool</b> 
    401. 

  401.   is_resize_needed
    402. 

  402.   () <b>const</b>
    403. 

  403. </pre>
    404. 

  404.         </td>
    405. 

  405. 

  406.         <td>
    407. 

  407.           <p>Queries whether a resize is needed.</p>
    408. 

  408.         </td>
    409. 

  409.       </tr>
    410. 

  410. 

  411.       <tr>
    412. 

  412.         <td>
    413. 

  413.           <pre>
    414. 

  414. <b>inline</b> <b>bool</b>
    415. 

  415.   is_grow_needed
    416. 

  416.   (<a href="#size_type55424436"><tt>size_type</tt></a> size, 
    417. 

  417.     <a href=
    418. 

  418. "#size_type55424436"><tt>size_type</tt></a> num_entries) <b>const</b>
    419. 

  419. </pre>
    420. 

  420.         </td>
    421. 

  421. 

  422.         <td>
    423. 

  423.           <p>Queries whether a grow is needed.</p>
    424. 

  424. 

  425.           <p>This method is called only if this object indicated
    426. 

  426.           resize is needed. The actual <span class=
    427. 

  427.           "c1"><tt>size</tt></span> of the table is <span class=
    428. 

  428.           "c1"><tt>size</tt></span>, and the number of entries in
    429. 

  429.           it is <span class="c1"><tt>num_entries</tt></span>.</p>
    430. 

  430.         </td>
    431. 

  431.       </tr>
    432. 

  432.     </table>
    433. 

  433. 

  434.     <h2><a name="link12" id="link12">Private Methods</a></h2>
    435. 

  435. 

  436.     <h3><a name="link13" id="link13">Overrides.</a></h3>
    437. 

  437. 

  438.     <table class="c1" width="100%" border="1" summary="Methods">
    439. 

  439.       <tr>
    440. 

  440.         <td width="45%" align="left"><b>Method</b></td>
    441. 

  441. 

  442.         <td width="55%" align="left"><b>Description</b></td>
    443. 

  443.       </tr>
    444. 

  444. 

  445.       <tr>
    446. 

  446.         <td>
    447. 

  447.           <pre>
    448. 

  448. <b>virtual</b> <b>void</b>
    449. 

  449.   do_resize
    450. 

  450.   (<a href="#size_type55424436"><tt>size_type</tt></a> new_size)
    451. 

  451. </pre>
    452. 

  452.         </td>
    453. 

  453. 

  454.         <td>
    455. 

  455.           <p>Resizes to <span class=
    456. 

  456.           "c1"><tt>new_size</tt></span>.</p>
    457. 

  457.         </td>
    458. 

  458.       </tr>
    459. 

  459.     </table>
    460. 

  460.   </div>
    461. 

  461. </body>
    462. 

  462. </html>
    463. 

  463.