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>Boost.Circular_buffer C++ Reference</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="circular_buffer/version_id.html" title="Documentation Version Info"> 11<link rel="next" href="BOOST_CB_ENABLE_DEBUG.html" title="Macro BOOST_CB_ENABLE_DEBUG"> 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="circular_buffer/version_id.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="BOOST_CB_ENABLE_DEBUG.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="boost_circular_buffer_c___reference"></a>Boost.Circular_buffer C++ Reference</h2></div></div></div> 29<div class="toc"><dl class="toc"> 30<dt><span class="section"><a href="boost_circular_buffer_c___reference.html#header.boost.circular_buffer_hpp">Header <boost/circular_buffer.hpp></a></span></dt> 31<dt><span class="section"><a href="boost_circular_buffer_c___reference.html#header.boost.circular_buffer.base_hpp">Header <boost/circular_buffer/base.hpp></a></span></dt> 32<dt><span class="section"><a href="boost_circular_buffer_c___reference.html#header.boost.circular_buffer.space_optimized_hpp">Header <boost/circular_buffer/space_optimized.hpp></a></span></dt> 33</dl></div> 34<div class="section"> 35<div class="titlepage"><div><div><h3 class="title"> 36<a name="header.boost.circular_buffer_hpp"></a>Header <<a href="../../boost/circular_buffer.hpp" target="_top">boost/circular_buffer.hpp</a>></h3></div></div></div> 37<p>Includes <boost/circular_buffer/base.hpp> </p> 38<pre class="synopsis"> 39 40<a class="link" href="BOOST_CB_ENABLE_DEBUG.html" title="Macro BOOST_CB_ENABLE_DEBUG">BOOST_CB_ENABLE_DEBUG</a></pre> 41</div> 42<div class="section"> 43<div class="titlepage"><div><div><h3 class="title"> 44<a name="header.boost.circular_buffer.base_hpp"></a>Header <<a href="../../boost/circular_buffer/base.hpp" target="_top">boost/circular_buffer/base.hpp</a>></h3></div></div></div> 45<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> 46 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> <span class="keyword">class</span> <a class="link" href="boost/circular_buffer.html" title="Class template circular_buffer">circular_buffer</a><span class="special">;</span> 47 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> 48 <span class="keyword">bool</span> <a class="link" href="boost/operator_idm45227212472336.html" title="Function template operator=="><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="boost/circular_buffer.html" title="Class template circular_buffer">circular_buffer</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> 49 <span class="keyword">const</span> <a class="link" href="boost/circular_buffer.html" title="Class template circular_buffer">circular_buffer</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 50 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> 51 <span class="keyword">bool</span> <a class="link" href="boost/operator_idm45227212458416.html" title="Function template operator<"><span class="keyword">operator</span><span class="special"><</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="boost/circular_buffer.html" title="Class template circular_buffer">circular_buffer</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> 52 <span class="keyword">const</span> <a class="link" href="boost/circular_buffer.html" title="Class template circular_buffer">circular_buffer</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 53 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> 54 <span class="keyword">bool</span> <a class="link" href="boost/operator_idm45227212444592.html" title="Function template operator!="><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="boost/circular_buffer.html" title="Class template circular_buffer">circular_buffer</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> 55 <span class="keyword">const</span> <a class="link" href="boost/circular_buffer.html" title="Class template circular_buffer">circular_buffer</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 56 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> 57 <span class="keyword">bool</span> <a class="link" href="boost/operator_idm45227212429792.html" title="Function template operator>"><span class="keyword">operator</span><span class="special">></span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="boost/circular_buffer.html" title="Class template circular_buffer">circular_buffer</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> 58 <span class="keyword">const</span> <a class="link" href="boost/circular_buffer.html" title="Class template circular_buffer">circular_buffer</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 59 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> 60 <span class="keyword">bool</span> <a class="link" href="boost/operator_idm45227212414976.html" title="Function template operator<="><span class="keyword">operator</span><span class="special"><=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="boost/circular_buffer.html" title="Class template circular_buffer">circular_buffer</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> 61 <span class="keyword">const</span> <a class="link" href="boost/circular_buffer.html" title="Class template circular_buffer">circular_buffer</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 62 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> 63 <span class="keyword">bool</span> <a class="link" href="boost/operator_idm45227212400160.html" title="Function template operator>="><span class="keyword">operator</span><span class="special">>=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="boost/circular_buffer.html" title="Class template circular_buffer">circular_buffer</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> 64 <span class="keyword">const</span> <a class="link" href="boost/circular_buffer.html" title="Class template circular_buffer">circular_buffer</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 65 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> 66 <span class="keyword">void</span> <a class="link" href="boost/swap_idm45227212385328.html" title="Function template swap"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="boost/circular_buffer.html" title="Class template circular_buffer">circular_buffer</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="boost/circular_buffer.html" title="Class template circular_buffer">circular_buffer</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 67<span class="special">}</span></pre> 68</div> 69<div class="section"> 70<div class="titlepage"><div><div><h3 class="title"> 71<a name="header.boost.circular_buffer.space_optimized_hpp"></a>Header <<a href="../../boost/circular_buffer/space_optimized.hpp" target="_top">boost/circular_buffer/space_optimized.hpp</a>></h3></div></div></div> 72<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> 73 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> <span class="keyword">class</span> <a class="link" href="boost/circular_idm45227212366288.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a><span class="special">;</span> 74 75 <span class="comment">// Test two space optimized circular buffers for equality. </span> 76 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> 77 <span class="keyword">bool</span> <a name="boost.operator_idm45227211477072"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="boost/circular_idm45227212366288.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span> lhs<span class="special">,</span> 78 <span class="keyword">const</span> <a class="link" href="boost/circular_idm45227212366288.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span> 79 80 <span class="comment">// Lexicographical comparison. </span> 81 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> 82 <span class="keyword">bool</span> <a name="boost.operator_idm45227211472176"></a><span class="keyword">operator</span><span class="special"><</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="boost/circular_idm45227212366288.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span> lhs<span class="special">,</span> 83 <span class="keyword">const</span> <a class="link" href="boost/circular_idm45227212366288.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span> 84 85 <span class="comment">// Test two space optimized circular buffers for non-equality. </span> 86 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> 87 <span class="keyword">bool</span> <a name="boost.operator_idm45227211467312"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="boost/circular_idm45227212366288.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span> lhs<span class="special">,</span> 88 <span class="keyword">const</span> <a class="link" href="boost/circular_idm45227212366288.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span> 89 90 <span class="comment">// Lexicographical comparison. </span> 91 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> 92 <span class="keyword">bool</span> <a name="boost.operator_idm45227211462416"></a><span class="keyword">operator</span><span class="special">></span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="boost/circular_idm45227212366288.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span> lhs<span class="special">,</span> 93 <span class="keyword">const</span> <a class="link" href="boost/circular_idm45227212366288.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span> 94 95 <span class="comment">// Lexicographical comparison. </span> 96 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> 97 <span class="keyword">bool</span> <a name="boost.operator_idm45227211457552"></a><span class="keyword">operator</span><span class="special"><=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="boost/circular_idm45227212366288.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span> lhs<span class="special">,</span> 98 <span class="keyword">const</span> <a class="link" href="boost/circular_idm45227212366288.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span> 99 100 <span class="comment">// Lexicographical comparison. </span> 101 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> 102 <span class="keyword">bool</span> <a name="boost.operator_idm45227211452688"></a><span class="keyword">operator</span><span class="special">>=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="boost/circular_idm45227212366288.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span> lhs<span class="special">,</span> 103 <span class="keyword">const</span> <a class="link" href="boost/circular_idm45227212366288.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span> 104 105 <span class="comment">// Swap the contents of two space optimized circular buffers. </span> 106 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Alloc<span class="special">></span> 107 <span class="keyword">void</span> <a name="boost.swap_idm45227211447824"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="boost/circular_idm45227212366288.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span> lhs<span class="special">,</span> 108 <a class="link" href="boost/circular_idm45227212366288.html" title="Class template circular_buffer_space_optimized">circular_buffer_space_optimized</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Alloc</span> <span class="special">></span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span> 109<span class="special">}</span></pre> 110</div> 111</div> 112<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 113<td align="left"></td> 114<td align="right"><div class="copyright-footer">Copyright © 2003-2013 Jan Gaspar<p> 115 Distributed under the Boost Software License, Version 1.0. (See accompanying 116 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>) 117 </p> 118</div></td> 119</tr></table> 120<hr> 121<div class="spirit-nav"> 122<a accesskey="p" href="circular_buffer/version_id.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="BOOST_CB_ENABLE_DEBUG.html"><img src="../../doc/src/images/next.png" alt="Next"></a> 123</div> 124</body> 125</html> 126
