PageRenderTime 36ms CodeModel.GetById 0ms RepoModel.GetById 1ms app.codeStats 0ms

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

https://bitbucket.org/pizzafactory/pf-gcc
HTML | 678 lines | 554 code | 124 blank | 0 comment | 0 complexity | 0f33b9581f1606d32bfec7299bfe2657 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>tree_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>tree_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/tree_policy.hpp"><tt>tree_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="Cmp_Fn294335" id="Cmp_Fn294335"><b>class</b> Cmp_Fn</a>
  53. </pre>
  54. </td>
  55. <td>
  56. <p>Comparison functor.</p>
  57. </td>
  58. <td>-</td>
  59. </tr>
  60. <tr>
  61. <td>
  62. <pre>
  63. <a name="Allocator35940069" id=
  64. "Allocator35940069"><b>class</b> Allocator</a>
  65. </pre>
  66. </td>
  67. <td>
  68. <p>Allocator type.</p>
  69. </td>
  70. <td>-</td>
  71. </tr>
  72. </table>
  73. <h2><a name="link2" id="link2">Public Types and
  74. Constants</a></h2>
  75. <h3><a name="link3" id="link3">Policy Definitions</a></h3>
  76. <table class="c1" width="100%" border="1" summary="Types">
  77. <tr>
  78. <td width="30%" align="left"><b>Type</b></td>
  79. <td width="55%" align="left"><b>Definition</b></td>
  80. <td width="15%" align="left"><b>Description</b></td>
  81. </tr>
  82. <tr>
  83. <td>
  84. <pre>
  85. <a name="cmp_fn394495" id="cmp_fn394495">cmp_fn</a>
  86. </pre>
  87. </td>
  88. <td>
  89. <pre>
  90. <a href="#Cmp_Fn294335"><tt>Cmp_Fn</tt></a>
  91. </pre>
  92. </td>
  93. <td>
  94. <p><a href="#Allocator35940069"><tt>Allocator</tt></a>
  95. type.</p>
  96. </td>
  97. </tr>
  98. <tr>
  99. <td>
  100. <pre>
  101. <a name="allocator48440069" id="allocator48440069">allocator</a>
  102. </pre>
  103. </td>
  104. <td>
  105. <pre>
  106. <a href="#Allocator35940069"><tt>Allocator</tt></a>
  107. </pre>
  108. </td>
  109. <td>
  110. <p><a href="#Allocator35940069"><tt>Allocator</tt></a>
  111. type.</p>
  112. </td>
  113. </tr>
  114. </table>
  115. <h3><a name="link4" id="link4">General Definitions</a></h3>
  116. <table class="c1" width="100%" border="1" summary="Types">
  117. <tr>
  118. <td width="30%" align="left"><b>Type</b></td>
  119. <td width="55%" align="left"><b>Definition</b></td>
  120. <td width="15%" align="left"><b>Description</b></td>
  121. </tr>
  122. <tr>
  123. <td>
  124. <pre>
  125. <a name="size_type55424436" id="size_type55424436">size_type</a>
  126. </pre>
  127. </td>
  128. <td>
  129. <pre>
  130. <b>typename</b> <a href=
  131. "#allocator48440069"><tt>allocator</tt></a>::size_type
  132. </pre>
  133. </td>
  134. <td>
  135. <p>Size type.</p>
  136. </td>
  137. </tr>
  138. </table>
  139. <h3><a name="link5" id="link5">Key-type Definitions</a></h3>
  140. <table class="c1" width="100%" border="1" summary="Types">
  141. <tr>
  142. <td width="30%" align="left"><b>Type</b></td>
  143. <td width="55%" align="left"><b>Definition</b></td>
  144. <td width="15%" align="left"><b>Description</b></td>
  145. </tr>
  146. <tr>
  147. <td>
  148. <pre>
  149. <a name="key_type10393186" id="key_type10393186">key_type</a>
  150. </pre>
  151. </td>
  152. <td>
  153. <pre>
  154. The instantiating container's key type.
  155. </pre>
  156. </td>
  157. <td>
  158. <p>Key type.</p>
  159. </td>
  160. </tr>
  161. <tr>
  162. <td>
  163. <pre>
  164. <a name="const_key_reference3185471705" id=
  165. "const_key_reference3185471705">const_key_reference</a>
  166. </pre>
  167. </td>
  168. <td>
  169. <pre>
  170. The instantiating container's const key reference type.
  171. </pre>
  172. </td>
  173. <td>
  174. <p>Const key reference.</p>
  175. </td>
  176. </tr>
  177. </table>
  178. <h3><a name="link6" id="link6">Metadata-Type
  179. Definitions</a></h3>
  180. <table class="c1" width="100%" border="1" summary="Types">
  181. <tr>
  182. <td width="30%" align="left"><b>Type</b></td>
  183. <td width="55%" align="left"><b>Definition</b></td>
  184. <td width="15%" align="left"><b>Description</b></td>
  185. </tr>
  186. <tr>
  187. <td>
  188. <pre>
  189. <a name="metadata_type2849297114" id=
  190. "metadata_type2849297114">metadata_type</a>
  191. </pre>
  192. </td>
  193. <td>
  194. <pre>
  195. <a href="#size_type55424436"><tt>size_type</tt></a>
  196. </pre>
  197. </td>
  198. <td>
  199. <p>Metadata type.</p>
  200. </td>
  201. </tr>
  202. </table>
  203. <h3><a name="link7" id="link7">Iterator Definitions</a></h3>
  204. <table class="c1" width="100%" border="1" summary="Types">
  205. <tr>
  206. <td width="30%" align="left"><b>Type</b></td>
  207. <td width="55%" align="left"><b>Definition</b></td>
  208. <td width="15%" align="left"><b>Description</b></td>
  209. </tr>
  210. <tr>
  211. <td>
  212. <pre>
  213. <a name="const_node_iterator4205924553" id=
  214. "const_node_iterator4205924553">const_node_iterator</a>
  215. </pre>
  216. </td>
  217. <td>
  218. <pre>
  219. <a href=
  220. "#Const_Node_Iterator1933878761"><tt>Const_Node_Iterator</tt></a>
  221. </pre>
  222. </td>
  223. <td>
  224. <p>Const node iterator type.</p>
  225. </td>
  226. </tr>
  227. <tr>
  228. <td>
  229. <pre>
  230. <a name="node_iterator3431975247" id=
  231. "node_iterator3431975247">node_iterator</a>
  232. </pre>
  233. </td>
  234. <td>
  235. <pre>
  236. <a href="#Node_Iterator4206909839"><tt>Node_Iterator</tt></a>
  237. </pre>
  238. </td>
  239. <td>
  240. <p>Node iterator type.</p>
  241. </td>
  242. </tr>
  243. <tr>
  244. <td>
  245. <pre>
  246. <a name="const_iterator98626788" id=
  247. "const_iterator98626788">const_iterator</a>
  248. </pre>
  249. </td>
  250. <td>
  251. <pre>
  252. <b>typename</b> <a href=
  253. "#const_node_iterator4205924553"><tt>const_node_iterator</tt></a>::value_type
  254. </pre>
  255. </td>
  256. <td>
  257. <p>Const iterator type.</p>
  258. </td>
  259. </tr>
  260. <tr>
  261. <td>
  262. <pre>
  263. <a name="iterator10418194" id="iterator10418194">iterator</a>
  264. </pre>
  265. </td>
  266. <td>
  267. <pre>
  268. <b>typename</b> <a href=
  269. "#node_iterator3431975247"><tt>node_iterator</tt></a>::value_type
  270. </pre>
  271. </td>
  272. <td>
  273. <p>Iterator type.</p>
  274. </td>
  275. </tr>
  276. </table>
  277. <h2><a name="link8" id="link8">Public Methods</a></h2>
  278. <h3><a name="link9" id="link9">Find-Type Methods</a></h3>
  279. <table class="c1" width="100%" border="1" summary="Methods">
  280. <tr>
  281. <td width="45%" align="left"><b>Method</b></td>
  282. <td width="55%" align="left"><b>Description</b></td>
  283. </tr>
  284. <tr>
  285. <td>
  286. <pre>
  287. <b>inline</b> <a href=
  288. "#const_iterator98626788"><tt>const_iterator</tt></a>
  289. find_by_order
  290. (<a href=
  291. "#size_type55424436"><tt>size_type</tt></a> order) <b>const</b>
  292. </pre>
  293. </td>
  294. <td>
  295. <p>Finds an entry by order. Returns a <a href=
  296. "#const_iterator98626788"><tt>const_iterator</tt></a> to
  297. the entry with the order <span class=
  298. "c1"><tt>order</tt></span>, or a <a href=
  299. "#const_iterator98626788"><tt>const_iterator</tt></a> to
  300. the container object's end if <span class=
  301. "c1"><tt>order</tt></span> is at least the size of the
  302. container object.</p>
  303. </td>
  304. </tr>
  305. <tr>
  306. <td>
  307. <pre>
  308. <b>inline</b> <a href="#iterator10418194"><tt>iterator</tt></a>
  309. find_by_order
  310. (<a href="#size_type55424436"><tt>size_type</tt></a> order)
  311. </pre>
  312. </td>
  313. <td>
  314. <p>Finds an entry by order. Returns an <a href=
  315. "#iterator10418194"><tt>iterator</tt></a> to the entry
  316. with the order <span class="c1"><tt>order</tt></span>, or
  317. an <a href="#iterator10418194"><tt>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="#size_type55424436"><tt>size_type</tt></a>
  327. order_of_key
  328. (<a href=
  329. "#const_key_reference3185471705"><tt>const_key_reference</tt></a> r_key) <b>const</b>
  330. </pre>
  331. </td>
  332. <td>
  333. <p>Returns the order of a key within a sequence. For
  334. example, if <span class="c1"><tt>r_key</tt></span> is the
  335. smallest key, this method will return 0; if <span class=
  336. "c1"><tt>r_key</tt></span> is a key between the smallest
  337. and next key, this method will return 1; if <span class=
  338. "c1"><tt>r_key</tt></span> is a key larger than the
  339. largest key, this method will return the size of r_c.</p>
  340. </td>
  341. </tr>
  342. </table>
  343. <h2><a name="link10" id="link10">Protected Types and
  344. Constants</a></h2>
  345. <h3><a name="link11" id="link11">Value-type
  346. Definitions</a></h3>
  347. <table class="c1" width="100%" border="1" summary="Types">
  348. <tr>
  349. <td width="30%" align="left"><b>Type</b></td>
  350. <td width="55%" align="left"><b>Definition</b></td>
  351. <td width="15%" align="left"><b>Description</b></td>
  352. </tr>
  353. <tr>
  354. <td>
  355. <pre>
  356. <a name="const_reference495461441" id=
  357. "const_reference495461441">const_reference</a>
  358. </pre>
  359. </td>
  360. <td>
  361. <pre>
  362. The instantiating container's const reference type.
  363. </pre>
  364. </td>
  365. <td>
  366. <p>Const reference to the container's value-type.</p>
  367. </td>
  368. </tr>
  369. <tr>
  370. <td>
  371. <pre>
  372. <a name="const_pointer878814947" id=
  373. "const_pointer878814947">const_pointer</a>
  374. </pre>
  375. </td>
  376. <td>
  377. <pre>
  378. The instantiating container's const pointer type.
  379. </pre>
  380. </td>
  381. <td>
  382. <p>Const pointer to the container's value-type.</p>
  383. </td>
  384. </tr>
  385. <tr>
  386. <td>
  387. <pre>
  388. <a name="const_metadata_reference1108857465" id=
  389. "const_metadata_reference1108857465">const_metadata_reference</a>
  390. </pre>
  391. </td>
  392. <td>
  393. <pre>
  394. <b>typename</b> <a href=
  395. "#Allocator35940069"><tt>Allocator</tt></a>::<b>template</b> rebind&lt;
  396. <a href=
  397. "#metadata_type2849297114"><tt>metadata_type</tt></a>&gt;::other::<a href="#const_reference495461441"><tt>const_reference</tt></a>
  398. </pre>
  399. </td>
  400. <td>
  401. <p>Const metadata reference.</p>
  402. </td>
  403. </tr>
  404. <tr>
  405. <td>
  406. <pre>
  407. <a name="metadata_reference583863863" id=
  408. "metadata_reference583863863">metadata_reference</a>
  409. </pre>
  410. </td>
  411. <td>
  412. <pre>
  413. <b>typename</b> <a href=
  414. "#Allocator35940069"><tt>Allocator</tt></a>::<b>template</b> rebind&lt;
  415. <a href=
  416. "#metadata_type2849297114"><tt>metadata_type</tt></a>&gt;::other::reference
  417. </pre>
  418. </td>
  419. <td>
  420. <p>Metadata reference.</p>
  421. </td>
  422. </tr>
  423. </table>
  424. <h2><a name="link12" id="link12">Protected Methods</a></h2>
  425. <h3><a name="link13" id="link13">Operators</a></h3>
  426. <table class="c1" width="100%" border="1" summary="Methods">
  427. <tr>
  428. <td width="45%" align="left"><b>Method</b></td>
  429. <td width="55%" align="left"><b>Description</b></td>
  430. </tr>
  431. <tr>
  432. <td>
  433. <pre>
  434. <b>inline</b> <b>void</b>
  435. <b>operator</b>()
  436. (<a href=
  437. "#node_iterator3431975247"><tt>node_iterator</tt></a> node_it,
  438. <a href=
  439. "#const_node_iterator4205924553"><tt>const_node_iterator</tt></a> end_nd_it) <b>const</b>
  440. </pre>
  441. </td>
  442. <td>
  443. <p>Updates the rank of a node through a <a href=
  444. "#node_iterator3431975247"><tt>node_iterator</tt></a>
  445. <span class="c1"><tt>node_it</tt></span>; <span class=
  446. "c1"><tt>end_nd_it</tt></span> is the end node <a href=
  447. "#iterator10418194"><tt>iterator</tt></a>.</p>
  448. </td>
  449. </tr>
  450. </table>
  451. <h3><a name="link14" id="link14">Constructors, destructor, and
  452. related</a></h3>
  453. <table class="c1" width="100%" border="1" summary="Methods">
  454. <tr>
  455. <td width="45%" align="left"><b>Method</b></td>
  456. <td width="55%" align="left"><b>Description</b></td>
  457. </tr>
  458. <tr>
  459. <td>
  460. <pre>
  461. <b>virtual</b>
  462. ~tree_order_statistics_node_update
  463. ()
  464. </pre>
  465. </td>
  466. <td>
  467. <p>Destructor.</p>
  468. </td>
  469. </tr>
  470. </table>
  471. <h2><a name="link15" id="link15">Private Methods</a></h2>
  472. <h3><a name="link16" id="link16">Overrides</a></h3>
  473. <table class="c1" width="100%" border="1" summary="Methods">
  474. <tr>
  475. <td width="45%" align="left"><b>Method</b></td>
  476. <td width="55%" align="left"><b>Description</b></td>
  477. </tr>
  478. <tr>
  479. <td>
  480. <pre>
  481. <b>virtual</b> <a href=
  482. "#const_node_iterator4205924553"><tt>const_node_iterator</tt></a>
  483. node_begin
  484. () <b>const</b> = 0
  485. </pre>
  486. </td>
  487. <td>
  488. <p>Returns the <a href=
  489. "#const_node_iterator4205924553"><tt>const_node_iterator</tt></a>
  490. associated with the tree's root node.</p>
  491. </td>
  492. </tr>
  493. <tr>
  494. <td>
  495. <pre>
  496. <b>virtual</b> <a href=
  497. "#node_iterator3431975247"><tt>node_iterator</tt></a>
  498. node_begin
  499. () = 0
  500. </pre>
  501. </td>
  502. <td>
  503. <p>Returns the <a href=
  504. "#node_iterator3431975247"><tt>node_iterator</tt></a>
  505. associated with the tree's root node.</p>
  506. </td>
  507. </tr>
  508. <tr>
  509. <td>
  510. <pre>
  511. <b>virtual</b> <a href=
  512. "#const_node_iterator4205924553"><tt>const_node_iterator</tt></a>
  513. node_end
  514. () <b>const</b> = 0
  515. </pre>
  516. </td>
  517. <td>
  518. <p>Returns the <a href=
  519. "#const_node_iterator4205924553"><tt>const_node_iterator</tt></a>
  520. associated with a just-after leaf node.</p>
  521. </td>
  522. </tr>
  523. <tr>
  524. <td>
  525. <pre>
  526. <b>virtual</b> <a href=
  527. "#node_iterator3431975247"><tt>node_iterator</tt></a>
  528. node_end
  529. () = 0
  530. </pre>
  531. </td>
  532. <td>
  533. <p>Returns the <a href=
  534. "#node_iterator3431975247"><tt>node_iterator</tt></a>
  535. associated with a just-after leaf node.</p>
  536. </td>
  537. </tr>
  538. <tr>
  539. <td>
  540. <pre>
  541. <b>virtual</b> <a href="#cmp_fn394495"><tt>cmp_fn</tt></a> &amp;
  542. get_cmp_fn
  543. () = 0
  544. </pre>
  545. </td>
  546. <td>
  547. <p>Access to the <a href=
  548. "#cmp_fn394495"><tt>cmp_fn</tt></a> object.</p>
  549. </td>
  550. </tr>
  551. </table>
  552. </div>
  553. </body>
  554. </html>