• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>Template Parameters</title>
6<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css">
7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9<link rel="up" href="../circular_buffer.html" title="Chapter 8. Boost.Circular Buffer">
10<link rel="prev" href="concepts.html" title="Modelled Concepts">
11<link rel="next" href="tickets.html" title="Trac Tickets">
12</head>
13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14<table cellpadding="2" width="100%"><tr>
15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
16<td align="center"><a href="../../../index.html">Home</a></td>
17<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20<td align="center"><a href="../../../more/index.htm">More</a></td>
21</tr></table>
22<hr>
23<div class="spirit-nav">
24<a accesskey="p" href="concepts.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../circular_buffer.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tickets.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="section">
27<div class="titlepage"><div><div><h2 class="title" style="clear: both">
28<a name="circular_buffer.template_params"></a><a class="link" href="template_params.html" title="Template Parameters">Template Parameters</a>
29</h2></div></div></div>
30<div class="table">
31<a name="circular_buffer.template_params.templ"></a><p class="title"><b>Table 8.1. Template parameter requirements</b></p>
32<div class="table-contents"><table class="table" summary="Template parameter requirements">
33<colgroup>
34<col>
35<col>
36</colgroup>
37<thead><tr>
38<th>
39              <p>
40                parameter
41              </p>
42            </th>
43<th>
44              <p>
45                Requirements
46              </p>
47            </th>
48</tr></thead>
49<tbody>
50<tr>
51<td>
52              <p>
53                T
54              </p>
55            </td>
56<td>
57              <p>
58                The type of the elements stored in the circular_buffer. The T has
59                to be <a href="../../../libs/utility/Assignable.html" target="_top">Assignable</a>
60                and <a href="../../../libs/utility/CopyConstructible.html" target="_top">CopyConstructible</a>.
61                Moreover T has to be <a href="https://www.boost.org/sgi/stl/DefaultConstructible.html" target="_top">DefaultConstructible</a>
62                if supplied as a default parameter when invoking some of the circular_buffer's
63                methods, e.g. <code class="computeroutput"><span class="identifier">insert</span><span class="special">(</span><span class="identifier">iterator</span>
64                <span class="identifier">pos</span><span class="special">,</span>
65                <span class="keyword">const</span> <span class="identifier">value_type</span><span class="special">&amp;</span> <span class="identifier">item</span>
66                <span class="special">=</span> <span class="identifier">value_type</span><span class="special">())</span></code>. And <a href="https://www.boost.org/sgi/stl/EqualityComparable.html" target="_top">EqualityComparable</a>
67                and/or <a href="../../../libs/utility/LessThanComparable.html" target="_top">LessThanComparable</a>
68                if the circular_buffer will be compared with another container.
69              </p>
70            </td>
71</tr>
72<tr>
73<td>
74              <p>
75                Alloc
76              </p>
77            </td>
78<td>
79              <p>
80                The allocator type used for all internal memory management. The Alloc
81                has to meet the allocator requirements imposed by STL.
82              </p>
83            </td>
84</tr>
85</tbody>
86</table></div>
87</div>
88<br class="table-break">
89</div>
90<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
91<td align="left"></td>
92<td align="right"><div class="copyright-footer">Copyright © 2003-2013 Jan Gaspar<p>
93        Distributed under the Boost Software License, Version 1.0. (See accompanying
94        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
95      </p>
96</div></td>
97</tr></table>
98<hr>
99<div class="spirit-nav">
100<a accesskey="p" href="concepts.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../circular_buffer.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tickets.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
101</div>
102</body>
103</html>
104