1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2 3<html> 4<head> 5 <meta http-equiv="Content-Language" content="en-us"> 6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 7 <link rel="stylesheet" type="text/css" href="../../../boost.css"> 8 9 <title>{{library}} - Header <{{header}}></title> 10</head> 11 12<body link="#0000FF" vlink="#800080"> 13 <table border="0" cellpadding="7" cellspacing="0" width="100%" summary= 14 "header"> 15 <tr> 16 <td valign="top" width="300"> 17 <h3><a href="../../../index.htm"><img height="86" width="277" alt= 18 "C++ Boost" src="../../../boost.png" border="0"></a></h3> 19 </td> 20 21 <td valign="top"> 22 <h1 align="center">{{library}}</h1> 23 24 <h2 align="center">Header <{{header}}></h2> 25 </td> 26 </tr> 27 </table> 28 <hr> 29 30 <h2>Contents</h2> 31 32 <dl class="page-index"> 33 <dt><a href="#introduction">Introduction</a></dt> 34 35 <dt><a href="#macros">Macros</a></dt> 36 37 <dd> 38 <dl class="page-index"> 39 <dt><a href="#macro-spec">{{macro name}}</a></dt> 40 </dl> 41 </dd> 42 43 <dt><a href="#values">Values</a></dt> 44 45 <dd> 46 <dl class="page-index"> 47 <dt><a href="#value-spec">{{value name}}</a></dt> 48 </dl> 49 </dd> 50 51 <dt><a href="#types">Types</a></dt> 52 53 <dd> 54 <dl class="page-index"> 55 <dt><a href="#type-spec">{{type name}}</a></dt> 56 </dl> 57 </dd> 58 59 <dt><a href="#classes">Classes</a></dt> 60 61 <dd> 62 <dl class="page-index"> 63 <dt><a href="#class-spec">Class <code>{{class name}}</code></a></dt> 64 65 <dd> 66 <dl class="page-index"> 67 <dt><a href="#class-spec-synopsis">Class <code>{{class 68 name}}</code> synopsis</a></dt> 69 70 <dt><a href="#class-spec-ctors">Class <code>{{class name}}</code> 71 constructors and destructor</a></dt> 72 73 <dt><a href="#class-spec-comparisons">Class <code>{{class 74 name}}</code> comparison functions</a></dt> 75 76 <dt><a href="#class-spec-modifiers">Class <code>{{class 77 name}}</code> modifier functions</a></dt> 78 79 <dt><a href="#class-spec-observers">Class <code>{{class 80 name}}</code> observer functions</a></dt> 81 82 <dt><a href="#class-spec-statics">Class <code>{{class 83 name}}</code> static functions</a></dt> 84 </dl> 85 </dd> 86 </dl> 87 </dd> 88 89 <dt><a href="#functions">Functions</a></dt> 90 91 <dd> 92 <dl class="page-index"> 93 <dt><a href="#function-spec">{{function name}}</a></dt> 94 </dl> 95 </dd> 96 97 <dt><a href="#objects">Objects</a></dt> 98 99 <dd> 100 <dl class="page-index"> 101 <dt><a href="#object-spec">{{object name}}</a></dt> 102 </dl> 103 </dd> 104 105 <dt><a href="#examples">Example(s)</a></dt> 106 </dl> 107 <hr> 108 109 <h2><a name="introduction" id="introduction"></a>Introduction</h2> 110 111 <p>{{Introductory text}}</p> 112 113 <h2><a name="macros" id="macros"></a>Macros</h2> 114 115 <p><a name="macro-spec" id="macro-spec"></a>{{Macro specifications}}</p> 116 117 <h2><a name="values" id="values"></a>Values</h2> 118 119 <p><a name="value-spec" id="value-spec"></a>{{Value specifications}}</p> 120 121 <h2><a name="types" id="types"></a>Types</h2> 122 123 <p><a name="type-spec" id="type-spec"></a>{{Type specifications}}</p> 124 125 <h2><a name="classes" id="classes"></a>Classes</h2> 126 127 <h3><a name="class-spec" id="class-spec"></a>Class <code>{{class 128 name}}</code></h3> 129 130 <p>{{class overview text}}</p> 131 132 <h4><a name="class-spec-synopsis" id="class-spec-synopsis"></a>Class 133 <code>{{class name}}</code> synopsis</h4> 134 <pre> 135namespace boost 136{ 137 class {{class name}} 138 { 139 }; 140}; 141</pre> 142 143 <h4><a name="class-spec-ctors" id="class-spec-ctors"></a>Class 144 <code>{{class name}}</code> constructors and destructor</h4> 145 <pre> 146{{constructor}} 147</pre> 148 149 <dl class="function-semantics"> 150 <dt><b>Requires:</b> {{text}}</dt> 151 152 <dt><b>Effects:</b> {{text}}</dt> 153 154 <dt><b>Postconditions:</b> {{text}}</dt> 155 156 <dt><b>Returns:</b> {{text}}</dt> 157 158 <dt><b>Throws:</b> {{text}}</dt> 159 160 <dt><b>Complexity:</b> {{text}}</dt> 161 162 <dt><b>Note:</b> {{text}}</dt> 163 164 <dt><b>Danger:</b> {{text}}</dt> 165 166 <dt><b>Rationale:</b> {{text}}</dt> 167 </dl> 168 <pre> 169{{destructor}} 170</pre> 171 172 <dl class="function-semantics"> 173 <dt><b>Requires:</b> {{text}}</dt> 174 175 <dt><b>Effects:</b> {{text}}</dt> 176 177 <dt><b>Postconditions:</b> {{text}}</dt> 178 179 <dt><b>Returns:</b> {{text}}</dt> 180 181 <dt><b>Throws:</b> {{text}}</dt> 182 183 <dt><b>Complexity:</b> {{text}}</dt> 184 185 <dt><b>Note:</b> {{text}}</dt> 186 187 <dt><b>Danger:</b> {{text}}</dt> 188 189 <dt><b>Rationale:</b> {{text}}</dt> 190 </dl> 191 192 <h4><a name="class-spec-comparisons" id="class-spec-comparisons"></a>Class 193 <code>{{class name}}</code> comparison functions</h4> 194 <pre> 195{{function}} 196</pre> 197 198 <dl class="function-semantics"> 199 <dt><b>Requires:</b> {{text}}</dt> 200 201 <dt><b>Effects:</b> {{text}}</dt> 202 203 <dt><b>Postconditions:</b> {{text}}</dt> 204 205 <dt><b>Returns:</b> {{text}}</dt> 206 207 <dt><b>Throws:</b> {{text}}</dt> 208 209 <dt><b>Complexity:</b> {{text}}</dt> 210 211 <dt><b>Note:</b> {{text}}</dt> 212 213 <dt><b>Danger:</b> {{text}}</dt> 214 215 <dt><b>Rationale:</b> {{text}}</dt> 216 </dl> 217 218 <h4><a name="class-spec-modifiers" id="class-spec-modifiers"></a>Class 219 <code>{{class name}}</code> modifier functions</h4> 220 <pre> 221{{function}} 222</pre> 223 224 <dl class="function-semantics"> 225 <dt><b>Requires:</b> {{text}}</dt> 226 227 <dt><b>Effects:</b> {{text}}</dt> 228 229 <dt><b>Postconditions:</b> {{text}}</dt> 230 231 <dt><b>Returns:</b> {{text}}</dt> 232 233 <dt><b>Throws:</b> {{text}}</dt> 234 235 <dt><b>Complexity:</b> {{text}}</dt> 236 237 <dt><b>Note:</b> {{text}}</dt> 238 239 <dt><b>Danger:</b> {{text}}</dt> 240 241 <dt><b>Rationale:</b> {{text}}</dt> 242 </dl> 243 244 <h4><a name="class-spec-observers" id="class-spec-observers"></a>Class 245 <code>{{class name}}</code> observer functions</h4> 246 <pre> 247{{function}} 248</pre> 249 250 <dl class="function-semantics"> 251 <dt><b>Requires:</b> {{text}}</dt> 252 253 <dt><b>Effects:</b> {{text}}</dt> 254 255 <dt><b>Postconditions:</b> {{text}}</dt> 256 257 <dt><b>Returns:</b> {{text}}</dt> 258 259 <dt><b>Throws:</b> {{text}}</dt> 260 261 <dt><b>Complexity:</b> {{text}}</dt> 262 263 <dt><b>Note:</b> {{text}}</dt> 264 265 <dt><b>Danger:</b> {{text}}</dt> 266 267 <dt><b>Rationale:</b> {{text}}</dt> 268 </dl> 269 270 <h4><a name="class-spec-statics" id="class-spec-statics"></a>Class 271 <code>{{class name}}</code> static functions</h4> 272 <pre> 273{{function}} 274</pre> 275 276 <dl class="function-semantics"> 277 <dt><b>Requires:</b> {{text}}</dt> 278 279 <dt><b>Effects:</b> {{text}}</dt> 280 281 <dt><b>Postconditions:</b> {{text}}</dt> 282 283 <dt><b>Returns:</b> {{text}}</dt> 284 285 <dt><b>Throws:</b> {{text}}</dt> 286 287 <dt><b>Complexity:</b> {{text}}</dt> 288 289 <dt><b>Note:</b> {{text}}</dt> 290 291 <dt><b>Danger:</b> {{text}}</dt> 292 293 <dt><b>Rationale:</b> {{text}}</dt> 294 </dl> 295 296 <h2><a name="functions" id="functions"></a>Functions</h2> 297 <pre> 298<a name="function-spec" id="function-spec"></a>{{function}} 299</pre> 300 301 <dl class="function-semantics"> 302 <dt><b>Requires:</b> {{text}}</dt> 303 304 <dt><b>Effects:</b> {{text}}</dt> 305 306 <dt><b>Postconditions:</b> {{text}}</dt> 307 308 <dt><b>Returns:</b> {{text}}</dt> 309 310 <dt><b>Throws:</b> {{text}}</dt> 311 312 <dt><b>Complexity:</b> {{text}}</dt> 313 314 <dt><b>Note:</b> {{text}}</dt> 315 316 <dt><b>Danger:</b> {{text}}</dt> 317 318 <dt><b>Rationale:</b> {{text}}</dt> 319 </dl> 320 321 <h2><a name="objects" id="objects"></a>Objects</h2> 322 323 <p><a name="object-spec" id="object-spec"></a>{{Object specifications}}</p> 324 325 <h2><a name="examples" id="examples"></a>Example(s)</h2> 326 327 <p>{{Example(s)}}</p> 328 <hr> 329 330 <p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src= 331 "../../../doc/images/valid-html401.png" alt="Valid HTML 4.01 Transitional" 332 height="31" width="88"></a></p> 333 334 <p>Revised 335 <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04 336 December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p> 337 338 <p><i>Copyright © 2006 <a href= 339 "mailto:{{address}}">{{author}}</a></i></p> 340 341 <p><i>Distributed under the Boost Software License, Version 1.0. (See 342 accompanying file <a href="../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or 343 copy at <a href= 344 "http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p> 345</body> 346</html> 347
