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

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

https://bitbucket.org/pizzafactory/pf-gcc
HTML | 770 lines | 635 code | 135 blank | 0 comment | 0 complexity | 774678a1f1510304f820006a28de1c95 MD5 | raw file
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta name="generator" content=
  6. "HTML Tidy for Linux/x86 (vers 12 April 2005), see www.w3.org" />
  7. <title>trie_order_statistics_node_update Interface</title>
  8. <meta http-equiv="Content-Type" content=
  9. "text/html; charset=us-ascii" />
  10. </head>
  11. <body>
  12. <div id="page">
  13. <h1><tt>trie_order_statistics_node_update</tt> Interface</h1>
  14. <p>Functor updating ranks of entrees.</p>
  15. <p>Defined in: <a href=
  16. "http://gcc.gnu.org/viewcvs/*checkout*/trunk/libstdc%2B%2B-v3/include/ext/pb_ds/trie_policy.hpp"><tt>trie_policy.hpp</tt></a></p>
  17. <h2><a name="link1" id="link1">Template Parameters</a></h2>
  18. <table class="c1" width="100%" border="1" summary=
  19. "Template Parameters">
  20. <tr>
  21. <td width="20%" align="left"><b>Parameter</b></td>
  22. <td width="50%" align="left"><b>Description</b></td>
  23. <td width="30%" align="left"><b>Default Value</b></td>
  24. </tr>
  25. <tr>
  26. <td>
  27. <pre>
  28. <a name="Const_Node_Iterator1933878761" id=
  29. "Const_Node_Iterator1933878761"><b>class</b> Const_Node_Iterator</a>
  30. </pre>
  31. </td>
  32. <td>
  33. <p>Const node iterator type.</p>
  34. </td>
  35. <td>-</td>
  36. </tr>
  37. <tr>
  38. <td>
  39. <pre>
  40. <a name="Node_Iterator4206909839" id=
  41. "Node_Iterator4206909839"><b>class</b> Node_Iterator</a>
  42. </pre>
  43. </td>
  44. <td>
  45. <p>Node iterator type.</p>
  46. </td>
  47. <td>-</td>
  48. </tr>
  49. <tr>
  50. <td>
  51. <pre>
  52. <a name="E_Access_Traits686553840" id=
  53. "E_Access_Traits686553840"><b>class</b> E_Access_Traits</a>
  54. </pre>
  55. </td>
  56. <td>
  57. <p>Comparison functor.</p>
  58. </td>
  59. <td>-</td>
  60. </tr>
  61. <tr>
  62. <td>
  63. <pre>
  64. <a name="Allocator35940069" id=
  65. "Allocator35940069"><b>class</b> Allocator</a>
  66. </pre>
  67. </td>
  68. <td>
  69. <p>Allocator type.</p>
  70. </td>
  71. <td>-</td>
  72. </tr>
  73. </table>
  74. <h2><a name="link2" id="link2">Public Types and
  75. Constants</a></h2>
  76. <h3><a name="link3" id="link3">Policy Definitions</a></h3>
  77. <table class="c1" width="100%" border="1" summary="Types">
  78. <tr>
  79. <td width="30%" align="left"><b>Type</b></td>
  80. <td width="55%" align="left"><b>Definition</b></td>
  81. <td width="15%" align="left"><b>Description</b></td>
  82. </tr>
  83. <tr>
  84. <td>
  85. <pre>
  86. <a name="e_access_traits1948190928" id=
  87. "e_access_traits1948190928">e_access_traits</a>
  88. </pre>
  89. </td>
  90. <td>
  91. <pre>
  92. <a href="#E_Access_Traits686553840"><tt>E_Access_Traits</tt></a>
  93. </pre>
  94. </td>
  95. <td>
  96. <p>Element access traits.</p>
  97. </td>
  98. </tr>
  99. <tr>
  100. <td>
  101. <pre>
  102. <a name="const_e_iterator2450008044" id=
  103. "const_e_iterator2450008044">const_e_iterator</a>
  104. </pre>
  105. </td>
  106. <td>
  107. <pre>
  108. <b>typename</b> <a href=
  109. "#e_access_traits1948190928"><tt>e_access_traits</tt></a>::const_iterator
  110. </pre>
  111. </td>
  112. <td>
  113. <p>Const element iterator.</p>
  114. </td>
  115. </tr>
  116. <tr>
  117. <td>
  118. <pre>
  119. <a name="allocator48440069" id="allocator48440069">allocator</a>
  120. </pre>
  121. </td>
  122. <td>
  123. <pre>
  124. <a href="#Allocator35940069"><tt>Allocator</tt></a>
  125. </pre>
  126. </td>
  127. <td>
  128. <p><a href="#Allocator35940069"><tt>Allocator</tt></a>
  129. type.</p>
  130. </td>
  131. </tr>
  132. </table>
  133. <h3><a name="link4" id="link4">General Definitions</a></h3>
  134. <table class="c1" width="100%" border="1" summary="Types">
  135. <tr>
  136. <td width="30%" align="left"><b>Type</b></td>
  137. <td width="55%" align="left"><b>Definition</b></td>
  138. <td width="15%" align="left"><b>Description</b></td>
  139. </tr>
  140. <tr>
  141. <td>
  142. <pre>
  143. <a name="size_type55424436" id="size_type55424436">size_type</a>
  144. </pre>
  145. </td>
  146. <td>
  147. <pre>
  148. <b>typename</b> <a href=
  149. "#allocator48440069"><tt>allocator</tt></a>::size_type
  150. </pre>
  151. </td>
  152. <td>
  153. <p>Size type.</p>
  154. </td>
  155. </tr>
  156. </table>
  157. <h3><a name="link5" id="link5">Key-Type Definitions</a></h3>
  158. <table class="c1" width="100%" border="1" summary="Types">
  159. <tr>
  160. <td width="30%" align="left"><b>Type</b></td>
  161. <td width="55%" align="left"><b>Definition</b></td>
  162. <td width="15%" align="left"><b>Description</b></td>
  163. </tr>
  164. <tr>
  165. <td>
  166. <pre>
  167. <a name="key_type10393186" id="key_type10393186">key_type</a>
  168. </pre>
  169. </td>
  170. <td>
  171. <pre>
  172. The instantiating container's key type.
  173. </pre>
  174. </td>
  175. <td>
  176. <p>Key type.</p>
  177. </td>
  178. </tr>
  179. <tr>
  180. <td>
  181. <pre>
  182. <a name="const_key_reference3185471705" id=
  183. "const_key_reference3185471705">const_key_reference</a>
  184. </pre>
  185. </td>
  186. <td>
  187. <pre>
  188. The instantiating container's const key reference type.
  189. </pre>
  190. </td>
  191. <td>
  192. <p>Const key reference.</p>
  193. </td>
  194. </tr>
  195. </table>
  196. <h3><a name="link6" id="link6">Metadata-Type
  197. Definitions</a></h3>
  198. <table class="c1" width="100%" border="1" summary="Types">
  199. <tr>
  200. <td width="30%" align="left"><b>Type</b></td>
  201. <td width="55%" align="left"><b>Definition</b></td>
  202. <td width="15%" align="left"><b>Description</b></td>
  203. </tr>
  204. <tr>
  205. <td>
  206. <pre>
  207. <a name="metadata_type2849297114" id=
  208. "metadata_type2849297114">metadata_type</a>
  209. </pre>
  210. </td>
  211. <td>
  212. <pre>
  213. <a href="#size_type55424436"><tt>size_type</tt></a>
  214. </pre>
  215. </td>
  216. <td>
  217. <p>Metadata type.</p>
  218. </td>
  219. </tr>
  220. </table>
  221. <h3><a name="link7" id="link7">Iterator Definitions</a></h3>
  222. <table class="c1" width="100%" border="1" summary="Types">
  223. <tr>
  224. <td width="30%" align="left"><b>Type</b></td>
  225. <td width="55%" align="left"><b>Definition</b></td>
  226. <td width="15%" align="left"><b>Description</b></td>
  227. </tr>
  228. <tr>
  229. <td>
  230. <pre>
  231. <a name="const_node_iterator4205924553" id=
  232. "const_node_iterator4205924553">const_node_iterator</a>
  233. </pre>
  234. </td>
  235. <td>
  236. <pre>
  237. <a href=
  238. "#Const_Node_Iterator1933878761"><tt>Const_Node_Iterator</tt></a>
  239. </pre>
  240. </td>
  241. <td>
  242. <p>Const node iterator type.</p>
  243. </td>
  244. </tr>
  245. <tr>
  246. <td>
  247. <pre>
  248. <a name="node_iterator3431975247" id=
  249. "node_iterator3431975247">node_iterator</a>
  250. </pre>
  251. </td>
  252. <td>
  253. <pre>
  254. <a href="#Node_Iterator4206909839"><tt>Node_Iterator</tt></a>
  255. </pre>
  256. </td>
  257. <td>
  258. <p>Node iterator type.</p>
  259. </td>
  260. </tr>
  261. <tr>
  262. <td>
  263. <pre>
  264. <a name="const_iterator98626788" id=
  265. "const_iterator98626788">const_iterator</a>
  266. </pre>
  267. </td>
  268. <td>
  269. <pre>
  270. <b>typename</b> <a href=
  271. "#const_node_iterator4205924553"><tt>const_node_iterator</tt></a>::value_type
  272. </pre>
  273. </td>
  274. <td>
  275. <p>Const iterator type.</p>
  276. </td>
  277. </tr>
  278. <tr>
  279. <td>
  280. <pre>
  281. <a name="iterator10418194" id="iterator10418194">iterator</a>
  282. </pre>
  283. </td>
  284. <td>
  285. <pre>
  286. <b>typename</b> <a href=
  287. "#node_iterator3431975247"><tt>node_iterator</tt></a>::value_type
  288. </pre>
  289. </td>
  290. <td>
  291. <p>Iterator type.</p>
  292. </td>
  293. </tr>
  294. </table>
  295. <h2><a name="link8" id="link8">Public Methods</a></h2>
  296. <h3><a name="link9" id="link9">Find-Type Methods</a></h3>
  297. <table class="c1" width="100%" border="1" summary="Methods">
  298. <tr>
  299. <td width="45%" align="left"><b>Method</b></td>
  300. <td width="55%" align="left"><b>Description</b></td>
  301. </tr>
  302. <tr>
  303. <td>
  304. <pre>
  305. <b>inline</b> <a href=
  306. "#const_iterator98626788"><tt>const_iterator</tt></a>
  307. find_by_order
  308. (<a href=
  309. "#size_type55424436"><tt>size_type</tt></a> order) <b>const</b>
  310. </pre>
  311. </td>
  312. <td>
  313. <p>Finds an entry by order. Returns a <a href=
  314. "#const_iterator98626788"><tt>const_iterator</tt></a> to
  315. the entry with the order <span class=
  316. "c1"><tt>order</tt></span>, or a <a href=
  317. "#const_iterator98626788"><tt>const_iterator</tt></a> to
  318. the container object's end if <span class=
  319. "c1"><tt>order</tt></span> is at least the size of the
  320. container object.</p>
  321. </td>
  322. </tr>
  323. <tr>
  324. <td>
  325. <pre>
  326. <b>inline</b> <a href="#iterator10418194"><tt>iterator</tt></a>
  327. find_by_order
  328. (<a href="#size_type55424436"><tt>size_type</tt></a> order)
  329. </pre>
  330. </td>
  331. <td>
  332. <p>Finds an entry by order. Returns an <a href=
  333. "#iterator10418194"><tt>iterator</tt></a> to the entry
  334. with the order <span class="c1"><tt>order</tt></span>, or
  335. an <a href="#iterator10418194"><tt>iterator</tt></a> to
  336. the container object's end if <span class=
  337. "c1"><tt>order</tt></span> is at least the size of the
  338. container object.</p>
  339. </td>
  340. </tr>
  341. <tr>
  342. <td>
  343. <pre>
  344. <b>inline</b> <a href="#size_type55424436"><tt>size_type</tt></a>
  345. order_of_key
  346. (<a href=
  347. "#const_key_reference3185471705"><tt>const_key_reference</tt></a> r_key) <b>const</b>
  348. </pre>
  349. </td>
  350. <td>
  351. <p>Returns the order of a key within a sequence. For
  352. example, if <span class="c1"><tt>r_key</tt></span> is the
  353. smallest key, this method will return 0; if <span class=
  354. "c1"><tt>r_key</tt></span> is a key between the smallest
  355. and next key, this method will return 1; if <span class=
  356. "c1"><tt>r_key</tt></span> is a key larger than the
  357. largest key, this method will return the size of r_c.</p>
  358. </td>
  359. </tr>
  360. <tr>
  361. <td>
  362. <pre>
  363. <b>inline</b> <a href="#size_type55424436"><tt>size_type</tt></a>
  364. order_of_prefix
  365. (<a href=
  366. "#const_e_iterator2450008044"><tt>const_e_iterator</tt></a> b,
  367. <a href=
  368. "#const_e_iterator2450008044"><tt>const_e_iterator</tt></a> e) <b>const</b>
  369. </pre>
  370. </td>
  371. <td>
  372. <p>Returns the order of a prefix within a sequence. For
  373. <span class="c1"><tt>e</tt></span>example, if [b,
  374. <span class="c1"><tt>e</tt></span>] is the smallest
  375. prefix, this method will return 0; if r_key is a key
  376. <span class="c1"><tt>b</tt></span>between the smallest and
  377. next key, this method will return 1; if r_key is a key
  378. larger than the largest key, this method will return the
  379. size of r_c.</p>
  380. </td>
  381. </tr>
  382. </table>
  383. <h2><a name="link10" id="link10">Protected Types and
  384. Constants</a></h2>
  385. <h3><a name="link11" id="link11">Value-Type
  386. Definitions</a></h3>
  387. <table class="c1" width="100%" border="1" summary="Types">
  388. <tr>
  389. <td width="30%" align="left"><b>Type</b></td>
  390. <td width="55%" align="left"><b>Definition</b></td>
  391. <td width="15%" align="left"><b>Description</b></td>
  392. </tr>
  393. <tr>
  394. <td>
  395. <pre>
  396. <a name="const_reference495461441" id=
  397. "const_reference495461441">const_reference</a>
  398. </pre>
  399. </td>
  400. <td>
  401. <pre>
  402. The instantiating container's const reference type.
  403. </pre>
  404. </td>
  405. <td>
  406. <p>Const reference to the container's value-type.</p>
  407. </td>
  408. </tr>
  409. <tr>
  410. <td>
  411. <pre>
  412. <a name="const_pointer878814947" id=
  413. "const_pointer878814947">const_pointer</a>
  414. </pre>
  415. </td>
  416. <td>
  417. <pre>
  418. The instantiating container's const pointer type.
  419. </pre>
  420. </td>
  421. <td>
  422. <p>Const pointer to the container's value-type.</p>
  423. </td>
  424. </tr>
  425. <tr>
  426. <td>
  427. <pre>
  428. <a name="const_metadata_reference1108857465" id=
  429. "const_metadata_reference1108857465">const_metadata_reference</a>
  430. </pre>
  431. </td>
  432. <td>
  433. <pre>
  434. <b>typename</b> <a href=
  435. "#Allocator35940069"><tt>Allocator</tt></a>::<b>template</b> rebind&lt;
  436. <a href=
  437. "#metadata_type2849297114"><tt>metadata_type</tt></a>&gt;::other::<a href="#const_reference495461441"><tt>const_reference</tt></a>
  438. </pre>
  439. </td>
  440. <td>
  441. <p>Const metadata reference.</p>
  442. </td>
  443. </tr>
  444. <tr>
  445. <td>
  446. <pre>
  447. <a name="metadata_reference583863863" id=
  448. "metadata_reference583863863">metadata_reference</a>
  449. </pre>
  450. </td>
  451. <td>
  452. <pre>
  453. <b>typename</b> <a href=
  454. "#Allocator35940069"><tt>Allocator</tt></a>::<b>template</b> rebind&lt;
  455. <a href=
  456. "#metadata_type2849297114"><tt>metadata_type</tt></a>&gt;::other::reference
  457. </pre>
  458. </td>
  459. <td>
  460. <p>Metadata reference.</p>
  461. </td>
  462. </tr>
  463. </table>
  464. <h2><a name="link12" id="link12">Protected Methods</a></h2>
  465. <h3><a name="link13" id="link13">Operators</a></h3>
  466. <table class="c1" width="100%" border="1" summary="Methods">
  467. <tr>
  468. <td width="45%" align="left"><b>Method</b></td>
  469. <td width="55%" align="left"><b>Description</b></td>
  470. </tr>
  471. <tr>
  472. <td>
  473. <pre>
  474. <b>inline</b> <b>void</b>
  475. <b>operator</b>()
  476. (<a href=
  477. "#node_iterator3431975247"><tt>node_iterator</tt></a> node_it,
  478. <a href=
  479. "#const_node_iterator4205924553"><tt>const_node_iterator</tt></a> end_nd_it) <b>const</b>
  480. </pre>
  481. </td>
  482. <td>
  483. <p>Updates the rank of a node through a <a href=
  484. "#node_iterator3431975247"><tt>node_iterator</tt></a>
  485. <span class="c1"><tt>node_it</tt></span>; <span class=
  486. "c1"><tt>end_nd_it</tt></span> is the end node <a href=
  487. "#iterator10418194"><tt>iterator</tt></a>.</p>
  488. </td>
  489. </tr>
  490. </table>
  491. <h3><a name="link14" id="link14">Constructors, destructor, and
  492. related</a></h3>
  493. <table class="c1" width="100%" border="1" summary="Methods">
  494. <tr>
  495. <td width="45%" align="left"><b>Method</b></td>
  496. <td width="55%" align="left"><b>Description</b></td>
  497. </tr>
  498. <tr>
  499. <td>
  500. <pre>
  501. <b>virtual</b>
  502. ~trie_order_statistics_node_update
  503. ()
  504. </pre>
  505. </td>
  506. <td>
  507. <p>Destructor.</p>
  508. </td>
  509. </tr>
  510. </table>
  511. <h2><a name="link15" id="link15">Private Methods</a></h2>
  512. <h3><a name="link16" id="link16">Overrides</a></h3>
  513. <table class="c1" width="100%" border="1" summary="Methods">
  514. <tr>
  515. <td width="45%" align="left"><b>Method</b></td>
  516. <td width="55%" align="left"><b>Description</b></td>
  517. </tr>
  518. <tr>
  519. <td>
  520. <pre>
  521. <b>virtual</b> <b>bool</b>
  522. empty
  523. () <b>const</b> = 0
  524. </pre>
  525. </td>
  526. <td>
  527. <p>Returns <tt><b>true</b></tt> if the container is
  528. empty.</p>
  529. </td>
  530. </tr>
  531. <tr>
  532. <td>
  533. <pre>
  534. <b>virtual</b> <a href="#iterator10418194"><tt>iterator</tt></a>
  535. begin
  536. () = 0
  537. </pre>
  538. </td>
  539. <td>
  540. <p>Returns the <a href=
  541. "#iterator10418194"><tt>iterator</tt></a> associated with
  542. the trie's first element.</p>
  543. </td>
  544. </tr>
  545. <tr>
  546. <td>
  547. <pre>
  548. <b>virtual</b> <a href="#iterator10418194"><tt>iterator</tt></a>
  549. end
  550. () = 0
  551. </pre>
  552. </td>
  553. <td>
  554. <p>Returns the <a href=
  555. "#iterator10418194"><tt>iterator</tt></a> associated with
  556. the trie's just-after-last element.</p>
  557. </td>
  558. </tr>
  559. <tr>
  560. <td>
  561. <pre>
  562. <b>virtual</b> <a href=
  563. "#const_node_iterator4205924553"><tt>const_node_iterator</tt></a>
  564. node_begin
  565. () <b>const</b> = 0
  566. </pre>
  567. </td>
  568. <td>
  569. <p>Returns the <a href=
  570. "#const_node_iterator4205924553"><tt>const_node_iterator</tt></a>
  571. associated with the trie's root node.</p>
  572. </td>
  573. </tr>
  574. <tr>
  575. <td>
  576. <pre>
  577. <b>virtual</b> <a href=
  578. "#node_iterator3431975247"><tt>node_iterator</tt></a>
  579. node_begin
  580. () = 0
  581. </pre>
  582. </td>
  583. <td>
  584. <p>Returns the <a href=
  585. "#node_iterator3431975247"><tt>node_iterator</tt></a>
  586. associated with the trie's root node.</p>
  587. </td>
  588. </tr>
  589. <tr>
  590. <td>
  591. <pre>
  592. <b>virtual</b> <a href=
  593. "#const_node_iterator4205924553"><tt>const_node_iterator</tt></a>
  594. node_end
  595. () <b>const</b> = 0
  596. </pre>
  597. </td>
  598. <td>
  599. <p>Returns the <a href=
  600. "#const_node_iterator4205924553"><tt>const_node_iterator</tt></a>
  601. associated with a just-after leaf node.</p>
  602. </td>
  603. </tr>
  604. <tr>
  605. <td>
  606. <pre>
  607. <b>virtual</b> <a href=
  608. "#node_iterator3431975247"><tt>node_iterator</tt></a>
  609. node_end
  610. () = 0
  611. </pre>
  612. </td>
  613. <td>
  614. <p>Returns the <a href=
  615. "#node_iterator3431975247"><tt>node_iterator</tt></a>
  616. associated with a just-after leaf node.</p>
  617. </td>
  618. </tr>
  619. <tr>
  620. <td>
  621. <pre>
  622. <b>virtual</b> <a href=
  623. "#e_access_traits1948190928"><tt>e_access_traits</tt></a> &amp;
  624. get_e_access_traits
  625. () = 0
  626. </pre>
  627. </td>
  628. <td>
  629. <p>Access to the cmp_fn object.</p>
  630. </td>
  631. </tr>
  632. </table>
  633. </div>
  634. </body>
  635. </html>