libstdc++-v3/docs/html/ext/pb_ds/move_to_front_lu_policy.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6   <meta name="generator" content=
   7   "HTML Tidy for Linux/x86 (vers 12 April 2005), see www.w3.org" />
   8
   9   <title>move_to_front_lu_policy Interface</title>
  10   <meta http-equiv="Content-Type" content=
  11   "text/html; charset=us-ascii" />
  12   </head>
  13
  14 <body>
  15   <div id="page">
  16     <h1><tt>move_to_front_lu_policy</tt> Interface</h1>
  17
  18     <p>A list-update policy that unconditionally moves elements to
  19     the front of the list.</p>
  20
  21     <p>Defined in: <a href=
  22     "../../../../include/ext/pb_ds/list_update_policy.hpp"><tt>list_update_policy.hpp</tt></a></p>
  23
  24     <h2><a name="link1" id="link1">Template Parameters</a></h2>
  25
  26     <table class="c1" width="100%" border="1" summary=
  27     "Template Parameters">
  28       <tr>
  29         <td width="20%" align="left"><b>Parameter</b></td>
  30
  31         <td width="50%" align="left"><b>Description</b></td>
  32
  33         <td width="30%" align="left"><b>Default Value</b></td>
  34       </tr>
  35
  36       <tr>
  37         <td>
  38           <pre>
  39 <a name="Allocator35940069" id=
  40 "Allocator35940069"><b>class</b> Allocator </a>
  41 </pre>
  42         </td>
  43
  44         <td>
  45           <p>Allocator type.</p>
  46
  47           <p>This is used only for definitions, e.g., the size
  48           type.</p>
  49         </td>
  50
  51         <td>
  52           <pre>
  53 std::allocator&lt;<b>char</b>&gt;
  54 </pre>
  55         </td>
  56       </tr>
  57     </table>
  58
  59     <h2><a name="link2" id="link2">Public Types and
  60     Constants</a></h2>
  61
  62     <h3><a name="link3" id="link3">Policy Definitions</a></h3>
  63
  64     <table class="c1" width="100%" border="1" summary="Types">
  65       <tr>
  66         <td width="30%" align="left"><b>Type</b></td>
  67
  68         <td width="55%" align="left"><b>Definition</b></td>
  69
  70         <td width="15%" align="left"><b>Description</b></td>
  71       </tr>
  72
  73       <tr>
  74         <td>
  75           <pre>
  76 <a name="allocator48440069" id="allocator48440069">allocator</a>
  77 </pre>
  78         </td>
  79
  80         <td>
  81           <pre>
  82 <a href="#Allocator35940069"><tt>Allocator</tt></a>
  83 </pre>
  84         </td>
  85
  86         <td>
  87           <p><a href="#Allocator35940069"><tt>Allocator</tt></a>
  88           type.</p>
  89         </td>
  90       </tr>
  91     </table>
  92
  93     <h3><a name="link4" id="link4">Metadata-Type
  94     Definitions</a></h3>
  95
  96     <table class="c1" width="100%" border="1" summary="Types">
  97       <tr>
  98         <td width="30%" align="left"><b>Type</b></td>
  99
 100         <td width="55%" align="left"><b>Definition</b></td>
 101
 102         <td width="15%" align="left"><b>Description</b></td>
 103       </tr>
 104
 105       <tr>
 106         <td>
 107           <pre>
 108 <a name="metadata_type2849297114" id=
 109 "metadata_type2849297114">metadata_type</a>
 110 </pre>
 111         </td>
 112
 113         <td>
 114           <pre>
 115 <a href="null_lu_metadata.html"><span class=
 116 "c2"><tt>null_lu_metadata</tt></span></a>
 117 </pre>
 118         </td>
 119
 120         <td>
 121           <p>Metadata on which this functor operates.</p>
 122
 123           <p>In this case, none.</p>
 124         </td>
 125       </tr>
 126
 127       <tr>
 128         <td>
 129           <pre>
 130 <a name="metadata_reference583863863" id=
 131 "metadata_reference583863863">metadata_reference</a>
 132 </pre>
 133         </td>
 134
 135         <td>
 136           <pre>
 137 <b>typename</b> <a href=
 138 "#Allocator35940069"><tt>Allocator</tt></a>::<b>template</b> rebind&lt;
 139     <a href=
 140 "#metadata_type2849297114"><tt>metadata_type</tt></a>&gt;::other::reference
 141 </pre>
 142         </td>
 143
 144         <td>
 145           <p>Reference to metadata on which this functor
 146           operates.</p>
 147         </td>
 148       </tr>
 149     </table>
 150
 151     <h2><a name="link5" id="link5">Public Methods</a></h2>
 152
 153     <h3><a name="link6" id="link6">Metadata Methods</a></h3>
 154
 155     <table class="c1" width="100%" border="1" summary="Methods">
 156       <tr>
 157         <td width="45%" align="left"><b>Method</b></td>
 158
 159         <td width="55%" align="left"><b>Description</b></td>
 160       </tr>
 161
 162       <tr>
 163         <td>
 164           <pre>
 165 <a href="#metadata_type2849297114"><tt>metadata_type</tt></a>
 166   <b>operator</b>()
 167   () <b>const</b>
 168 </pre>
 169         </td>
 170
 171         <td>
 172           <p>Creates a metadata object.</p>
 173         </td>
 174       </tr>
 175
 176       <tr>
 177         <td>
 178           <pre>
 179 <b>inline</b> <b>bool</b>
 180   <b>operator</b>()
 181   (<a href=
 182 "#metadata_reference583863863"><tt>metadata_reference</tt></a> r_metadata) <b>const</b>
 183 </pre>
 184         </td>
 185
 186         <td>
 187           <p>Decides whether a metadata object should be moved to
 188           the front of the list.</p>
 189         </td>
 190       </tr>
 191     </table>
 192   </div>
 193 </body>
 194 </html>