mirror of
https://github.com/boostorg/circular_buffer.git
synced 2026-02-09 23:12:25 +00:00
d846eee0be
https://svn.boost.org/svn/boost/trunk ................ r42455 | johnmaddock | 2008-01-04 08:54:35 -0800 (Fri, 04 Jan 2008) | 1 line Fix typos. ................ r42456 | eric_niebler | 2008-01-04 09:14:53 -0800 (Fri, 04 Jan 2008) | 1 line mark up borland and sun accumulators failures ................ r42459 | andreas_huber69 | 2008-01-04 10:23:18 -0800 (Fri, 04 Jan 2008) | 1 line This should fix template parameter shadowing errors for gcc and Intel compilers. ................ r42462 | bgubenko | 2008-01-04 15:55:43 -0800 (Fri, 04 Jan 2008) | 1 line mark Accumulators tests for gcc 4.2.1 affected by GCC Bugzilla Bug 33580 ................ r42471 | turkanis | 2008-01-04 20:51:49 -0800 (Fri, 04 Jan 2008) | 1 line merged changes from iostreams_dev, revisions 42441-42469; added 'std::' for Intel on Linux/Darwin; added STDCXX workaround for codecvt; fixed docs for invert.hpp ................ r42473 | turkanis | 2008-01-04 23:35:44 -0800 (Fri, 04 Jan 2008) | 1 line new iostreams expected failures: stream_offset_64bit_test.cpp on Borland, and wide stream tests on gcc-3.4.2_hpux_pa_risc ................ r42475 | andreas_huber69 | 2008-01-05 04:42:02 -0800 (Sat, 05 Jan 2008) | 1 line Added defaults for in_state_reaction template parameters and updated tests accordingly. ................ r42476 | bemandawes | 2008-01-05 06:41:55 -0800 (Sat, 05 Jan 2008) | 1 line Disable Microsoft "secure" overloads in Dinkumware libraries since they cause compile errors with Intel versions 9 and 10 ................ r42478 | jurko | 2008-01-05 07:19:53 -0800 (Sat, 05 Jan 2008) | 1 line Typo corrections. Minor stylistic changes. ................ r42479 | jurko | 2008-01-05 08:53:03 -0800 (Sat, 05 Jan 2008) | 1 line Updated Boost.Jam command line option texts. Minor stylistic changes. ................ r42480 | jurko | 2008-01-05 08:55:36 -0800 (Sat, 05 Jan 2008) | 1 line Typo corrections. Minor stylistic changes. ................ r42481 | jurko | 2008-01-05 08:56:42 -0800 (Sat, 05 Jan 2008) | 1 line Typo correction. Corrected an invalid command-line option name. ................ r42482 | jurko | 2008-01-05 08:57:17 -0800 (Sat, 05 Jan 2008) | 1 line Corrected an invalid command-line option name reference. ................ r42483 | jurko | 2008-01-05 08:58:01 -0800 (Sat, 05 Jan 2008) | 1 line Corrected an out-of-date comment listing all command-line options. ................ r42484 | jurko | 2008-01-05 09:11:50 -0800 (Sat, 05 Jan 2008) | 1 line Corrected the used file suffix for the VERBATIM file type. Now the documentation is in sync with the 'customization' example. This also closes the Trac ticket 134. Minor stylistic changes. ................ r42485 | jurko | 2008-01-05 09:46:45 -0800 (Sat, 05 Jan 2008) | 1 line Stylistic comment changes & typo corrections. ................ r42486 | jurko | 2008-01-05 09:52:31 -0800 (Sat, 05 Jan 2008) | 1 line Stylistic comment changes & typo corrections in several files. Corrected an incorrect error message in boost-build/build/project.jam displayed when a --build-dir command-line option and a non top-level project build-dir attribute are specified. ................ r42487 | jurko | 2008-01-05 09:54:02 -0800 (Sat, 05 Jan 2008) | 1 line Cleaned up some import rule calls. ................ r42488 | jurko | 2008-01-05 10:02:23 -0800 (Sat, 05 Jan 2008) | 1 line Documentation wording cleaned up a bit. ................ r42489 | jurko | 2008-01-05 10:13:10 -0800 (Sat, 05 Jan 2008) | 1 line Removed or simplified some import calls. Comment updates. Minor stylistic changes. ................ r42490 | jurko | 2008-01-05 10:14:20 -0800 (Sat, 05 Jan 2008) | 2 lines Simplified the used make rules. Removed some dead code. Minor stylistic changes. ................ r42492 | jurko | 2008-01-05 10:29:36 -0800 (Sat, 05 Jan 2008) | 1 line Removed trailing spaces and some empty lines. ................ r42494 | jurko | 2008-01-05 12:02:24 -0800 (Sat, 05 Jan 2008) | 1 line Minor stylistic changes such as: comment typo corrections, wrapping lines to 80 characters, indentations, removing trailing spaces, etc. ................ r42495 | jurko | 2008-01-05 12:06:15 -0800 (Sat, 05 Jan 2008) | 2 lines Cleaned up where the stage module is imported in tools/builtin.jam. Added a missing import in tools/stage.jam that causes errors with the previous fix. Minor stylistic changes in tools/stage.jam. ................ r42496 | jurko | 2008-01-05 12:14:48 -0800 (Sat, 05 Jan 2008) | 1 line Comment cleanup. ................ r42497 | jurko | 2008-01-05 12:37:44 -0800 (Sat, 05 Jan 2008) | 1 line Minor stylistic changes - cleaned up import calls, wrapped much text at 80 characters updated comments, typo corrections, removed trailing spaces, etc. ................ r42498 | jurko | 2008-01-05 12:48:50 -0800 (Sat, 05 Jan 2008) | 1 line Renamed some Jamfile and project-root.jam references to Jamfile.jam and Jamroot.jam respectively. ................ r42499 | jurko | 2008-01-05 13:37:15 -0800 (Sat, 05 Jan 2008) | 1 line Test code cleaned up a bit. No functional changes. ................ r42502 | hkaiser | 2008-01-05 14:44:28 -0800 (Sat, 05 Jan 2008) | 1 line Wave: updated copyright messages to include the year 2008 (merged from release branch). ................ r42504 | jurko | 2008-01-05 15:18:17 -0800 (Sat, 05 Jan 2008) | 1 line Refactored the test into two separate test functions. Made the 'directory names with dots' test use the expect_output_line() tool instead of a manual find, causing a better diagnostic to be displayed in case of a failure. Made one of the test Jam scripts more compact. Made the test use the Jamroot.jam file instead of project-root.jam. ................ r42505 | bgubenko | 2008-01-05 15:35:05 -0800 (Sat, 05 Jan 2008) | 1 line mark up accumulators library test weighted_kurtosis for acc toolset ................ r42506 | jurko | 2008-01-05 16:25:48 -0800 (Sat, 05 Jan 2008) | 1 line No functional changes but only stylistic changes such as: comment typo corrections, wrapping lines to 80 characters, indentations, removing trailing spaces, removing empty lines, made tests use Jamfile.jam and Jamroot.jam Boost Build script names, removed unnecessary module imports, etc. ................ r42507 | jurko | 2008-01-05 16:53:09 -0800 (Sat, 05 Jan 2008) | 1 line No functional changes but only stylistic changes such as: comment typo corrections, wrapping lines to 80 characters, indentations, removing trailing spaces, removing empty lines, removed unnecessary module imports, etc. ................ r42508 | jurko | 2008-01-05 22:15:39 -0800 (Sat, 05 Jan 2008) | 5 lines Refactored build-system.jam. Added many detailed comments. Test configuration module now gets loaded the same as all other configuration modules. In addition to being able to specify which user configuration to load, user may now also prevent loading the user configuration by specifying an empty file name for it. ................ r42509 | jurko | 2008-01-05 22:50:56 -0800 (Sat, 05 Jan 2008) | 1 line Added a --test-config command-line option for specifying where the test configuration file should be loaded from instead of always being looked up in Boost Build's test folder. This allows non-test builds to not use test config when it exists on the system and different tests to use different test configurations when needed. ................ r42510 | jurko | 2008-01-05 22:58:24 -0800 (Sat, 05 Jan 2008) | 1 line Specifying that a build uses test configuration no longer prevents toolset auto-configuration and therefore no longer causes --toolset options to be ignored. ................ r42511 | jurko | 2008-01-05 23:13:28 -0800 (Sat, 05 Jan 2008) | 1 line Minor stylistic comment changes. ................ r42512 | jurko | 2008-01-05 23:17:08 -0800 (Sat, 05 Jan 2008) | 1 line Added support for choosing the toolset and toolset version to be used 'by default' by Boost Build. Allows testing of default toolset functionality. ................ r42513 | jurko | 2008-01-05 23:26:46 -0800 (Sat, 05 Jan 2008) | 1 line Upgraded the tool for testing that a certain line exists in the given output support so that it now also knows how to test that a certain line does not exist in the given output. ................ r42514 | jurko | 2008-01-05 23:28:47 -0800 (Sat, 05 Jan 2008) | 1 line Added the --ignore-site-config option telling Boost.Build not to load the site configuration file. ................ r42516 | jurko | 2008-01-06 00:16:34 -0800 (Sun, 06 Jan 2008) | 1 line Stylistic changes: typo corrections, comment alignments, output string updates, no functional changes, etc. ................ r42527 | andreas_huber69 | 2008-01-06 05:49:31 -0800 (Sun, 06 Jan 2008) | 1 line Various doc updates. ................ r42528 | danieljames | 2008-01-06 08:47:16 -0800 (Sun, 06 Jan 2008) | 2 lines Add Boost.Unordered and add to the documentation. Not fully integrated yet. ................ r42529 | danieljames | 2008-01-06 08:48:36 -0800 (Sun, 06 Jan 2008) | 1 line Add more libraries that use Boost.Hash to its intro. ................ r42530 | danieljames | 2008-01-06 08:49:11 -0800 (Sun, 06 Jan 2008) | 1 line Add Boost.Unordered to Boost.Hash's intro. ................ r42531 | danieljames | 2008-01-06 08:59:18 -0800 (Sun, 06 Jan 2008) | 1 line Combine the 'container' and 'unordered' tests. ................ r42532 | danieljames | 2008-01-06 08:59:49 -0800 (Sun, 06 Jan 2008) | 1 line Give the unordered exception test suite its own name. ................ r42533 | danieljames | 2008-01-06 09:13:15 -0800 (Sun, 06 Jan 2008) | 1 line Add the contents of compile_tests.cpp to set_compile.cpp and map_compile.cpp ................ r42534 | danieljames | 2008-01-06 09:16:51 -0800 (Sun, 06 Jan 2008) | 1 line Rename the test-suites to match other libraries' style. ................ r42535 | danieljames | 2008-01-06 09:23:16 -0800 (Sun, 06 Jan 2008) | 2 lines Add forwarding html files for Boost.Unordered. ................ r42536 | danieljames | 2008-01-06 09:40:32 -0800 (Sun, 06 Jan 2008) | 1 line Add Boost.Unordered to the regression tests. ................ r42537 | eric_niebler | 2008-01-06 09:44:06 -0800 (Sun, 06 Jan 2008) | 1 line add myself as maintainer of accumulators ................ r42538 | danieljames | 2008-01-06 09:45:18 -0800 (Sun, 06 Jan 2008) | 2 lines Add library identification. ................ r42539 | danieljames | 2008-01-06 09:48:11 -0800 (Sun, 06 Jan 2008) | 2 lines Add the unordered library to the maintainers list. ................ r42540 | danieljames | 2008-01-06 09:56:06 -0800 (Sun, 06 Jan 2008) | 2 lines Add unordered to the library list. ................ r42544 | turkanis | 2008-01-06 10:32:05 -0800 (Sun, 06 Jan 2008) | 18 lines copy.hpp: fix for Visual Age: std::min was passed arguments of different types; replaced std:: min with conditional detail/streambuf/indirect_streambuf.hpp: removed trailing comma in enum definition test/combine_test.cpp: test/symmetric_filter_test.cpp: test/compose_test.cpp: test/close_test.cpp: test/invert_test.cpp: test/tee_test.cpp: test/restrict_test.cpp: test/Jamfile.v2: moved tests for close() into the test files for various adapters ................ r42546 | jurko | 2008-01-06 12:06:33 -0800 (Sun, 06 Jan 2008) | 1 line Corrected a bug with the customized default toolset being read from the toolset module but defined in the build-system module. Effect was that customized default toolsets were getting ignored. ................ r42547 | jurko | 2008-01-06 12:37:55 -0800 (Sun, 06 Jan 2008) | 1 line Simple code cleanup. Typo corrections. ................ r42548 | jurko | 2008-01-06 12:43:25 -0800 (Sun, 06 Jan 2008) | 1 line Added support for tests configuring whether they want their Boost Build to ignore toolset requirements instead of always ignoring them. Minor stylistic changes. ................ r42549 | jurko | 2008-01-06 12:56:20 -0800 (Sun, 06 Jan 2008) | 1 line Added new tests related to Boost Build's default toolset handling. They test that the correct default toolset gets use and that when it gets used that has no different status than any other explicitly specified toolset. ................ r42563 | turkanis | 2008-01-06 17:26:52 -0800 (Sun, 06 Jan 2008) | 1 line marked restrict_test.cpp as failing on vacpp and stream_offset_64bit_test as failing on sun (iostreams) ................ r42564 | turkanis | 2008-01-06 17:32:29 -0800 (Sun, 06 Jan 2008) | 1 line alphabetized the iostreams failures ................ r42565 | turkanis | 2008-01-06 21:20:32 -0800 (Sun, 06 Jan 2008) | 5 lines merged changes from branches/iostreams_dev, revisions 42544-42544 - added "slice" as an alias for "restrict", for platforms on which "restrict" is a keyword - attempted to configure file_descriptor for __IBMCPP__ - added better error output to stream_offset_64bit_test.cpp ................ r42566 | jurko | 2008-01-07 09:00:59 -0800 (Mon, 07 Jan 2008) | 1 line Corrected explicitly specified user-config file handling. Was not looking for the specified file in the regular path instead of the current folder and did not work with absolute paths. ................ r42567 | jurko | 2008-01-07 10:15:13 -0800 (Mon, 07 Jan 2008) | 1 line Code cleanup. Converted to using True/False instead of 1/0. Changed to obey documented coding conventions regarding whitespace and function parameters. Renamed private member functions to use the __ name prefix. ................ r42568 | jurko | 2008-01-07 10:38:28 -0800 (Mon, 07 Jan 2008) | 1 line Added a new configuration test making sure that the bug with not being able to process absolute user-config configuration file references never rears its ugly head again. ................ r42570 | eric_niebler | 2008-01-07 11:06:31 -0800 (Mon, 07 Jan 2008) | 1 line s/order/tail/ ................ r42571 | eric_niebler | 2008-01-07 11:08:16 -0800 (Mon, 07 Jan 2008) | 1 line add missing includes, fix signed/unsigned warnings, clean-up trailing whitespace, fixes #1552 ................ r42572 | danieljames | 2008-01-07 11:40:32 -0800 (Mon, 07 Jan 2008) | 1 line Rename the exception tests so that they don't clash with the normal tests. ................ r42573 | danieljames | 2008-01-07 11:41:05 -0800 (Mon, 07 Jan 2008) | 1 line Remove some development code. ................ r42575 | danieljames | 2008-01-07 11:44:13 -0800 (Mon, 07 Jan 2008) | 3 lines Add missing 'use namespace std'. Which I should have done when I was told about them before. Sorry. ................ r42576 | danieljames | 2008-01-07 11:46:27 -0800 (Mon, 07 Jan 2008) | 1 line Add support for multiple copyrights in the library info. ................ r42578 | danieljames | 2008-01-07 11:51:02 -0800 (Mon, 07 Jan 2008) | 1 line Reneame the set and map compile tests so they'll be adjacent in the test results. ................ r42580 | danieljames | 2008-01-07 12:06:15 -0800 (Mon, 07 Jan 2008) | 1 line Avoid some uses of an invalid pointer. ................ r42581 | danieljames | 2008-01-07 12:07:12 -0800 (Mon, 07 Jan 2008) | 1 line Use the default location for the reference documentation. ................ r42587 | danieljames | 2008-01-07 13:05:42 -0800 (Mon, 07 Jan 2008) | 5 lines Fix a bug which was causing the memory area stuff to fail. I should probably try to be less clever and use memory area's lower bounds as the key, and do the extra work required to get that working. ................ r42588 | danieljames | 2008-01-07 13:07:43 -0800 (Mon, 07 Jan 2008) | 1 line Fix an off by one error. ................ r42591 | danieljames | 2008-01-07 13:47:24 -0800 (Mon, 07 Jan 2008) | 1 line Merge in spell check. ................ r42596 | turkanis | 2008-01-07 15:13:26 -0800 (Mon, 07 Jan 2008) | 5 lines merged changes from branches/iostreams_dev, revisions 42565-42595: - Simplified implementation with the help to the C-runtime function _get_osfhandle so that on Windows only a single HANDLE is stored and the POSIX-style implementation is never needed; added the handle_type on POSIX systems (typedef for int) and a function returning the underlying handle as an instance of handle_type - fixed the bug described in ticket Ticket #1551 (stream_buffer::seekpos ignores openmode parameter) - fixed test/operation_sequence_test.cpp file description ................ r42598 | grafik | 2008-01-07 18:49:25 -0800 (Mon, 07 Jan 2008) | 1 line Mostly fix bad path calc for direct html from doxygen doc generation. (fixes #1562) ................ r42600 | turkanis | 2008-01-07 19:49:23 -0800 (Mon, 07 Jan 2008) | 1 line merged changes from branches/iostreams_dev revisions 42595-42599; applied Dinkumware implementation of positioning functions to IBM Visual Age; simplified and corrected implementation ................ r42602 | turkanis | 2008-01-07 20:20:38 -0800 (Mon, 07 Jan 2008) | 1 line removed unneeded headers, one of which (restrict.hpp) causes failures on IBM Visual Age ................ r42603 | turkanis | 2008-01-07 20:52:54 -0800 (Mon, 07 Jan 2008) | 1 line removed spurious '.cpp' extension from test names (iostreams) ................ r42612 | danieljames | 2008-01-08 05:59:01 -0800 (Tue, 08 Jan 2008) | 3 lines Merge in latest unordered developments (revisions 42607-42611). ................ r42613 | jurko | 2008-01-08 06:40:24 -0800 (Tue, 08 Jan 2008) | 1 line Added a new test making sure properties conditioned on multiple different feature values are handled correctly. This especially includes testing the case when one of those features is <toolset> and the value given for it includes a toolset version. ................ r42614 | jurko | 2008-01-08 07:21:15 -0800 (Tue, 08 Jan 2008) | 1 line Made some debugging messages more consistent. ................ r42615 | eric_niebler | 2008-01-08 09:42:20 -0800 (Tue, 08 Jan 2008) | 1 line support for LaTeX formulas in Doxygen comments ................ r42616 | eric_niebler | 2008-01-08 09:43:34 -0800 (Tue, 08 Jan 2008) | 1 line automatically generate png files from LaTeX formulas using doxygen ................ r42617 | jurko | 2008-01-08 09:51:30 -0800 (Tue, 08 Jan 2008) | 1 line Comment correction. ................ r42619 | danieljames | 2008-01-08 10:15:01 -0800 (Tue, 08 Jan 2008) | 1 line Merge: Another missing 'using namespace std' ................ r42620 | eric_niebler | 2008-01-08 10:43:43 -0800 (Tue, 08 Jan 2008) | 1 line fix signed/unsigned warnings, clean up trailing whitespace ................ r42624 | eric_niebler | 2008-01-08 13:40:52 -0800 (Tue, 08 Jan 2008) | 1 line disable iterator debugging for all msvc versions ................ r42625 | turkanis | 2008-01-08 14:25:01 -0800 (Tue, 08 Jan 2008) | 1 line merged changes from branches/iostreams_dev, revisions 42602-42624: adding missing included to fix #1550; fix for positioning on IBM; fix for file_descriptor on POSIX; restructed the version range for the Borland workaround in large_file_test.cpp ................ r42626 | jurko | 2008-01-08 17:09:26 -0800 (Tue, 08 Jan 2008) | 1 line Minor stylistic code indentation changes. ................ r42627 | jurko | 2008-01-08 17:11:03 -0800 (Tue, 08 Jan 2008) | 1 line Tried trailing spaces. Minor comment typo corrections. ................ r42628 | jurko | 2008-01-08 17:18:38 -0800 (Tue, 08 Jan 2008) | 1 line Remove trailing spaces. Removed an empty line. ................ r42629 | jurko | 2008-01-08 20:05:29 -0800 (Tue, 08 Jan 2008) | 8 lines Updated the __ACTION_RULE__ to not return its action command output as a single string but instead split it into a list of output lines. This allows Jam code using this output to work correctly independently of what newline character combinations are in use. This was causing problems with Boost Build unit tests which can now be updated to pass. Consequences & checks: * Final __ACTION_RULE__ rule parameter has changed from output ? to output-lines *. * Updated corresponding Jam documentation. * Updated the all related Boost Build code. * No code on the Boost trunk uses this rule except for Boost Build itself. ................ r42630 | jurko | 2008-01-08 20:15:35 -0800 (Tue, 08 Jan 2008) | 1 line Fixed a failing test by making it access action output using the __ACTION_RULE__ rule so it would not be affected by the level of debug output given by Boost Build/Jam. ................ r42631 | jurko | 2008-01-08 20:30:25 -0800 (Tue, 08 Jan 2008) | 1 line Fixed a failing test by making it access its action results using the __ACTION_RULE__ rule. Now it works with the default debug level settings (i.e. no action output displayed). ................ r42632 | grafik | 2008-01-08 20:31:58 -0800 (Tue, 08 Jan 2008) | 1 line Revert various changes that break backward compatibility, and also some minor edits. ................ r42633 | grafik | 2008-01-08 20:34:12 -0800 (Tue, 08 Jan 2008) | 1 line Revert various changes that break backward compatibility, and also some minor edits. ................ r42637 | jurko | 2008-01-09 06:36:37 -0800 (Wed, 09 Jan 2008) | 1 line Updated the test so it passes on Windows. Had to change it to enable action output logging and compensate for the fact that now action names are sent to the output as well. Minor stylistic changes. ................ r42639 | jurko | 2008-01-09 09:03:45 -0800 (Wed, 09 Jan 2008) | 1 line Updated the test so it passes on Windows. Had to change it to enable action output logging and compensate for the fact that now action names are sent to the output as well. Minor stylistic changes. ................ r42641 | eric_niebler | 2008-01-09 12:21:51 -0800 (Wed, 09 Jan 2008) | 1 line copy the png files to where fop will look for them when building pdf ................ r42642 | eric_niebler | 2008-01-09 12:33:05 -0800 (Wed, 09 Jan 2008) | 1 line fix more signed/unsigned warnings ................ r42644 | turkanis | 2008-01-09 15:13:57 -0800 (Wed, 09 Jan 2008) | 1 line marked stream_offset_64bit_test as an expected failure on vacpp (iostreams) ................ r42645 | turkanis | 2008-01-09 15:16:17 -0800 (Wed, 09 Jan 2008) | 1 line replaced 2 occurrences of the identifier 'restrict' with BOOST_IOSTREAMS_RESTRICT ................ r42646 | turkanis | 2008-01-09 19:27:51 -0800 (Wed, 09 Jan 2008) | 1 line added expected failures for Sun and IBM; removed a Borland intermittent failure; removed some obsolete toolsets (iostreams) ................ r42647 | troyer | 2008-01-10 01:49:16 -0800 (Thu, 10 Jan 2008) | 1 line Optimizations for Boost.MPI ................ r42648 | troyer | 2008-01-10 03:54:36 -0800 (Thu, 10 Jan 2008) | 1 line Undid backward-compatibility breaking change in pair serialization ................ r42651 | johnmaddock | 2008-01-10 04:10:37 -0800 (Thu, 10 Jan 2008) | 1 line Apply patch from Issue #1187. ................ r42657 | anthonyw | 2008-01-10 06:19:36 -0800 (Thu, 10 Jan 2008) | 1 line removed references to NULL ................ r42658 | turkanis | 2008-01-10 10:50:19 -0800 (Thu, 10 Jan 2008) | 1 line marked up two moe expected failures for sun-5.7-5.8 (iostreams) ................ r42664 | bgubenko | 2008-01-10 13:13:42 -0800 (Thu, 10 Jan 2008) | 1 line marked iostreams library compose_test for gcc-3.4.6_linux_ia64 : linking exceeds 10 min. limit ................ r42665 | danieljames | 2008-01-10 14:25:35 -0800 (Thu, 10 Jan 2008) | 2 lines Initialise svnmerge for merging changes for unordered. ................ r42666 | danieljames | 2008-01-10 14:30:46 -0800 (Thu, 10 Jan 2008) | 6 lines Merge latest unordered developments: Make simple_test test a little more. Use doubles for calculating max load factor. Some workarounds, mostly for Borland and running the tests. ................ r42670 | turkanis | 2008-01-10 16:02:36 -0800 (Thu, 10 Jan 2008) | 1 line merged changes from branches/iostreams_dev, revisions 42645=42660; fix for Intel-darwin; removed dependence of file_descriptor_test and mapped_file_test on library boost_iostreams ................ r42672 | turkanis | 2008-01-10 17:35:46 -0800 (Thu, 10 Jan 2008) | 1 line force static runtime-link for intel-darwin ................ r42674 | johnmaddock | 2008-01-11 01:55:43 -0800 (Fri, 11 Jan 2008) | 1 line Fix bugs reported by Will Drewry: certain invalid regexes can cause the library to access invalid memory, changed to ensure that the correct exception is thrown long before this happens. ................ r42676 | jurko | 2008-01-11 05:44:51 -0800 (Fri, 11 Jan 2008) | 1 line Removed the manual boost-build.jam file creation since that file already exists in the SVN repository and this only overwrote it with the same content minus the copyright notice. Removed a reference to the no longer existing boost_build_v2.html file. ................ r42677 | johnmaddock | 2008-01-11 05:48:57 -0800 (Fri, 11 Jan 2008) | 1 line Update for Intel-10.1. ................ r42684 | turkanis | 2008-01-11 11:12:22 -0800 (Fri, 11 Jan 2008) | 1 line another attempt to fix linking for compression tests on intel-darwin ................ r42688 | turkanis | 2008-01-11 14:58:21 -0800 (Fri, 11 Jan 2008) | 1 line merged changes from iostreams_dev; fixes for IBM and more documentation ................ r42689 | turkanis | 2008-01-11 18:45:55 -0800 (Fri, 11 Jan 2008) | 1 line more detailed note for vacpp (iostreams) ................ r42691 | eric_niebler | 2008-01-11 22:43:28 -0800 (Fri, 11 Jan 2008) | 1 line new style transforms a-la proto v3 ................ r42693 | nesotto | 2008-01-12 04:38:57 -0800 (Sat, 12 Jan 2008) | 1 line doc fixes ................ r42698 | danieljames | 2008-01-12 06:43:40 -0800 (Sat, 12 Jan 2008) | 9 lines Merge the latest unordered changes. These are concerned with getting the tests working on more compilers. The biggest change is that the exception tests have been changed to use a very simple exception testing mechanism on top of lightweight_test. This was because Boost.Test exception testing isn't working on several platforms. I'm trying to set this up so that I can use Boost.Test on compilers which it completely supports, and lightweight test on others. Boost.Test tests more than my simple exception testing code ever will so it's worth using where I can. ................ r42700 | eric_niebler | 2008-01-12 09:09:17 -0800 (Sat, 12 Jan 2008) | 1 line missing includes ................ r42701 | eric_niebler | 2008-01-12 09:40:40 -0800 (Sat, 12 Jan 2008) | 1 line more msvc-7.1-friendly default_context implementation, more missing headers ................ r42706 | turkanis | 2008-01-12 12:19:42 -0800 (Sat, 12 Jan 2008) | 1 line corrected use of feature detection macros for AIX; simplified implementation slightly; updated docs ................ r42707 | turkanis | 2008-01-12 12:20:35 -0800 (Sat, 12 Jan 2008) | 1 line removed intel-darwin sepcific code, since it didn't work ................ r42708 | eric_niebler | 2008-01-12 13:19:45 -0800 (Sat, 12 Jan 2008) | 1 line port toy_spirit example to proto v3 ................ r42713 | turkanis | 2008-01-12 23:17:07 -0800 (Sat, 12 Jan 2008) | 1 line improved docs ................ r42715 | nesotto | 2008-01-13 03:37:41 -0800 (Sun, 13 Jan 2008) | 1 line fixed #if to #ifdef ................ r42722 | bgubenko | 2008-01-13 07:52:12 -0800 (Sun, 13 Jan 2008) | 1 line better note for iostreams library test compose_test on gcc-3.4.6_linux_ia64 ................ r42723 | bgubenko | 2008-01-13 08:12:37 -0800 (Sun, 13 Jan 2008) | 1 line marked up random library test random_test for gcc-3.4.6_linux_ia64 ................ r42724 | danieljames | 2008-01-13 08:19:26 -0800 (Sun, 13 Jan 2008) | 3 lines Merge in latest changes to Boost.Unordered. Some compiler workarounds and starting to clean up the tests a little. ................ r42729 | eric_niebler | 2008-01-13 11:39:54 -0800 (Sun, 13 Jan 2008) | 1 line work around msvc-7.1 bug ................ r42741 | eric_niebler | 2008-01-13 13:56:56 -0800 (Sun, 13 Jan 2008) | 1 line boost template instantiation depth on darwin ................ r42745 | johnmaddock | 2008-01-14 01:46:12 -0800 (Mon, 14 Jan 2008) | 1 line Ooops, fix broken escape sequence. ................ r42747 | johnmaddock | 2008-01-14 01:58:36 -0800 (Mon, 14 Jan 2008) | 1 line Fix documentation typos. ................ r42750 | chris_kohlhoff | 2008-01-14 05:13:35 -0800 (Mon, 14 Jan 2008) | 2 lines Fix concept name in comment. ................ r42751 | johnmaddock | 2008-01-14 05:17:09 -0800 (Mon, 14 Jan 2008) | 1 line Patch regex concept checks and TR1 library to work with VC9 + MS TR1 feature pack. ................ r42752 | chris_kohlhoff | 2008-01-14 05:20:06 -0800 (Mon, 14 Jan 2008) | 2 lines Add missing broken pipe error. ................ r42753 | chris_kohlhoff | 2008-01-14 05:21:37 -0800 (Mon, 14 Jan 2008) | 3 lines Don't include sys/time.h when compiling with aCC, as that header does not supply pselect(), which is needed for HP-UX/aCC to work correctly. ................ r42754 | chris_kohlhoff | 2008-01-14 05:22:21 -0800 (Mon, 14 Jan 2008) | 2 lines Disable noisy and incorrect /Wp64 warnings generated by MSVC. ................ r42755 | chris_kohlhoff | 2008-01-14 05:24:28 -0800 (Mon, 14 Jan 2008) | 3 lines Don't call epoll_wait/kevent if there are no old operations (where old means added prior to the last epoll_wait/kevent call) needing to be demultiplexed. ................ r42756 | chris_kohlhoff | 2008-01-14 05:25:24 -0800 (Mon, 14 Jan 2008) | 2 lines Silence some integer truncation warnings. ................ r42758 | chris_kohlhoff | 2008-01-14 05:27:52 -0800 (Mon, 14 Jan 2008) | 8 lines Silence some integer truncation warnings. Only perform the windows-bug workaround where we use a short timeout with GetQueuedCompletionStatus from one thread, i.e. the timer thread. Keep track of the number of OVERLAPPED-derived operations to ensure that they all get cleaned up when the io_service is destroyed. ................ r42759 | chris_kohlhoff | 2008-01-14 05:29:08 -0800 (Mon, 14 Jan 2008) | 5 lines Check for truncation when converting buffer size from size_t to openssl's int argument. Try to fix possible thread-safety issues in SSL wrapper. ................ r42766 | eric_niebler | 2008-01-14 08:49:32 -0800 (Mon, 14 Jan 2008) | 1 line register mpl::bool_ with typeof ................ r42767 | dgregor | 2008-01-14 09:01:26 -0800 (Mon, 14 Jan 2008) | 1 line Improved suggestion for dealing with Qt MOC, from Niels Dekker ................ r42771 | niels_dekker | 2008-01-14 10:17:30 -0800 (Mon, 14 Jan 2008) | 1 line Documented value_init workaround to compiler issues, added new introduction, updated to 2003 edition of C++ Standard -- reviewed by Fernando Cacciola ................ r42773 | guwi17 | 2008-01-14 11:04:43 -0800 (Mon, 14 Jan 2008) | 2 lines - fixed typo ................ r42776 | eric_niebler | 2008-01-14 12:26:58 -0800 (Mon, 14 Jan 2008) | 1 line add skip(), for specifying a skip regex ................ r42778 | turkanis | 2008-01-14 12:47:17 -0800 (Mon, 14 Jan 2008) | 1 line overhaul of dual_use filters: close() is now called just once; suppressed Borland/Dinkumware warnings in mapped_file.hpp ................ r42779 | niels_dekker | 2008-01-14 13:46:20 -0800 (Mon, 14 Jan 2008) | 1 line Minor "beautifications" of value_init documentation, inc. placing references in order of appearance ................ r42780 | lbourdev | 2008-01-14 14:06:07 -0800 (Mon, 14 Jan 2008) | 3 lines Changed size_t to std::size_t ................ r42781 | lbourdev | 2008-01-14 15:25:10 -0800 (Mon, 14 Jan 2008) | 3 lines GIL: Changing size_t to std::size_t ................ r42788 | eric_niebler | 2008-01-14 22:46:39 -0800 (Mon, 14 Jan 2008) | 1 line code clean-up, begin updating the transform section in proto's docs ................ r42789 | eric_niebler | 2008-01-14 23:46:51 -0800 (Mon, 14 Jan 2008) | 1 line try disabling iterator debugging for intel-win toolset ................ r42797 | t_schwinger | 2008-01-15 11:46:10 -0800 (Tue, 15 Jan 2008) | 3 lines adds missing #include ................ r42798 | niels_dekker | 2008-01-15 11:53:28 -0800 (Tue, 15 Jan 2008) | 1 line value_init doc + test: Added revision date. ................ r42801 | jurko | 2008-01-15 13:13:52 -0800 (Tue, 15 Jan 2008) | 1 line Minor stylistic comment changes. Removed trailing spaces. ................ r42804 | eric_niebler | 2008-01-15 14:06:51 -0800 (Tue, 15 Jan 2008) | 1 line document call<>, make<> and bind<> ................ r42807 | turkanis | 2008-01-15 14:54:40 -0800 (Tue, 15 Jan 2008) | 1 line rewrote treatment of result_of in terms of a new (hopefully temporary) config macro BOOST_IOSTREAMS_NO_RESULT_OF; fixed docs ................ r42811 | turkanis | 2008-01-15 17:14:04 -0800 (Tue, 15 Jan 2008) | 1 line reverted last change except for doc fixes; regression was result of test runner's local patch ................ r42813 | turkanis | 2008-01-15 17:16:36 -0800 (Tue, 15 Jan 2008) | 1 line botched last commit ................ r42814 | djenkins | 2008-01-15 22:39:34 -0800 (Tue, 15 Jan 2008) | 1 line missing include ................ r42815 | niels_dekker | 2008-01-16 01:35:12 -0800 (Wed, 16 Jan 2008) | 1 line Added convenience class initialized_value, as announced at http://article.gmane.org/gmane.comp.lib.boost.devel/169833 ................ r42816 | niels_dekker | 2008-01-16 01:37:25 -0800 (Wed, 16 Jan 2008) | 1 line Added test and documentation for convenience class initialized_value, that was added with changeset [42815] ................ r42817 | chris_kohlhoff | 2008-01-16 05:46:01 -0800 (Wed, 16 Jan 2008) | 2 lines Set the openssl callback function for getting a thread ID. ................ r42818 | anthonyw | 2008-01-16 07:23:36 -0800 (Wed, 16 Jan 2008) | 1 line Provide tss_cleanup_implemented as a dummy function on Windows CE to allow tests to run ................ r42821 | t_schwinger | 2008-01-16 11:16:37 -0800 (Wed, 16 Jan 2008) | 3 lines works around MSVC7.1 problems (hopefully) ................ r42822 | t_schwinger | 2008-01-16 11:17:09 -0800 (Wed, 16 Jan 2008) | 3 lines attempts to fix Borland regressions ................ r42823 | eric_niebler | 2008-01-16 11:24:33 -0800 (Wed, 16 Jan 2008) | 1 line document when<> and is_callable<> ................ r42825 | turkanis | 2008-01-16 12:46:56 -0800 (Wed, 16 Jan 2008) | 1 line replaced __IBMCPP__ with _AIX ................ r42827 | turkanis | 2008-01-16 16:50:14 -0800 (Wed, 16 Jan 2008) | 1 line added pgi to toolsets expected to fail seekawble_file_test (iostreams) ................ r42836 | eric_niebler | 2008-01-17 14:47:54 -0800 (Thu, 17 Jan 2008) | 1 line stl_iterator does better error handling ................ r42837 | jurko | 2008-01-17 17:14:17 -0800 (Thu, 17 Jan 2008) | 1 line Stylistic changes. Removed trailing spaces. Removed empty lines. Corrected comment typos and wording. ................ r42839 | eric_niebler | 2008-01-17 23:56:31 -0800 (Thu, 17 Jan 2008) | 1 line tweaks for better doxygen-ated output ................ r42840 | eric_niebler | 2008-01-17 23:56:59 -0800 (Thu, 17 Jan 2008) | 1 line updated reference section ................ r42841 | eric_niebler | 2008-01-17 23:58:48 -0800 (Thu, 17 Jan 2008) | 1 line add back reference section, document user-defined transforms ................ r42843 | t_schwinger | 2008-01-18 06:37:41 -0800 (Fri, 18 Jan 2008) | 3 lines makes member object support work with BCC ................ r42851 | johnmaddock | 2008-01-18 08:56:57 -0800 (Fri, 18 Jan 2008) | 1 line Add needed <iostream> include. ................ r42852 | johnmaddock | 2008-01-18 09:05:35 -0800 (Fri, 18 Jan 2008) | 1 line We don't have a tr1::hash functor if the std lib is the Apache version. ................ r42853 | hkaiser | 2008-01-18 09:56:53 -0800 (Fri, 18 Jan 2008) | 1 line Wave: removed T_DEFINED token id from the library. ................ r42855 | johnmaddock | 2008-01-18 10:18:17 -0800 (Fri, 18 Jan 2008) | 1 line Needs to #include <cstring> in order to use std::memset. ................ r42856 | danieljames | 2008-01-18 11:35:55 -0800 (Fri, 18 Jan 2008) | 2 lines Merge in some changes to the unordered tests. ................ r42857 | t_schwinger | 2008-01-18 12:05:56 -0800 (Fri, 18 Jan 2008) | 3 lines simplifies function_types markup ................ r42858 | t_schwinger | 2008-01-18 12:52:06 -0800 (Fri, 18 Jan 2008) | 3 lines attempts to fix BCB 5.9 regression in synthesis/mem_func_ptr_cv_ptr_to_this test ................ r42859 | t_schwinger | 2008-01-18 13:06:44 -0800 (Fri, 18 Jan 2008) | 3 lines attempts to fix pathscale failure ................ r42868 | niels_dekker | 2008-01-19 12:21:18 -0800 (Sat, 19 Jan 2008) | 1 line value_init_test now works around Borland 5.82 bug ("Error E2015: Ambiguity..." when using initialized_value), that is fixed with a newer compiler version ................ r42869 | niels_dekker | 2008-01-19 12:52:04 -0800 (Sat, 19 Jan 2008) | 1 line Removed local named variable from value_initialized::operator=, as Fernando Cacciola suggested me to avoid unnecessary named variables. ................ r42873 | bemandawes | 2008-01-19 18:01:35 -0800 (Sat, 19 Jan 2008) | 1 line Remove extraneous defines since they are inherited from library build Jamfile ................ r42877 | johnmaddock | 2008-01-20 01:42:35 -0800 (Sun, 20 Jan 2008) | 1 line Add include of <eh.h> for msvc. ................ r42878 | igaztanaga | 2008-01-20 03:54:47 -0800 (Sun, 20 Jan 2008) | 5 lines Updated Interprocess and Intrusive: -> Added linear slist to intrusive -> Updated all allocators to version 2 allocators in Interprocess -> Optimized rbtree_best_fit size overhead to 1 std:size_t. ................ r42881 | danieljames | 2008-01-20 09:37:21 -0800 (Sun, 20 Jan 2008) | 1 line Include <new> to get std::bad_alloc. ................ r42882 | danieljames | 2008-01-20 10:55:57 -0800 (Sun, 20 Jan 2008) | 22 lines Merged revisions 42856-42881 via svnmerge from https://svn.boost.org/svn/boost/branches/unordered/trunk ........ r42880 | danieljames | 2008-01-20 16:10:43 +0000 (Sun, 20 Jan 2008) | 17 lines Simplify the tests a little: Add a parameter to random_values to control what sort of values it generates. This means that instead of using equivalent_object to test collisions (which was a total hack) we now just need another parameter. This requires some meta programming to act differently for maps and sets. Because of this pairs no longer need to be generated so remove the code for doing that (which doesn't work on some compilers). Remove the generator object, just call generate directly. Remove some of the tests using int containers, they didn't really add to anthing other than the compile time (some tests are timing out). ........ ................ r42884 | jurko | 2008-01-20 12:18:50 -0800 (Sun, 20 Jan 2008) | 5 lines Minor stylistic changes: * Removed trailing spaces. * Added a comment for code discovering the user's home-directories. * Removed a stale regex import. * Removed an old corpse 'identity' rule found inside the __test__ rule. ................ r42890 | johnmaddock | 2008-01-21 01:41:17 -0800 (Mon, 21 Jan 2008) | 1 line Only disable wide character support for HP aCC: for gcc the logic is already taken care of in libstdcpp3.hpp. ................ r42897 | hkaiser | 2008-01-21 08:13:31 -0800 (Mon, 21 Jan 2008) | 1 line Removed a duplicate entry. ................ r42898 | rogeeff | 2008-01-21 09:02:53 -0800 (Mon, 21 Jan 2008) | 1 line changed output of booleans ................ r42899 | johnmaddock | 2008-01-21 10:11:09 -0800 (Mon, 21 Jan 2008) | 1 line Updated type traits library so that everything compiles with -Wall -pedantic with GCC. ................ r42904 | davedeakins | 2008-01-21 11:38:44 -0800 (Mon, 21 Jan 2008) | 1 line Don't include <eh.h> for WinCE (since WinCE does not have this header) ................ r42906 | eric_niebler | 2008-01-21 12:39:35 -0800 (Mon, 21 Jan 2008) | 1 line minor clean-up ................ r42909 | rogeeff | 2008-01-21 19:41:23 -0800 (Mon, 21 Jan 2008) | 1 line missing header ................ r42911 | igaztanaga | 2008-01-22 08:49:22 -0800 (Tue, 22 Jan 2008) | 1 line Refactor some allocation code and fix instantiation problem in 64 bit platforms ................ r42916 | eric_niebler | 2008-01-22 12:42:18 -0800 (Tue, 22 Jan 2008) | 1 line add concepts section to proto reference ................ r42917 | hljin | 2008-01-22 14:10:48 -0800 (Tue, 22 Jan 2008) | 1 line GIL: fixed the problem with std::hex by adding #include <ios> ................ r42918 | eric_niebler | 2008-01-22 18:23:15 -0800 (Tue, 22 Jan 2008) | 1 line proto works with boost 1.34.1 ................ r42929 | johnmaddock | 2008-01-23 08:08:44 -0800 (Wed, 23 Jan 2008) | 1 line Applies fix for issue #1598: added missing #include. ................ r42931 | igaztanaga | 2008-01-23 11:34:39 -0800 (Wed, 23 Jan 2008) | 1 line Ticket #1593: [interprocess] 'streamoff' : is not a member of 'std' ................ r42934 | andreas_huber69 | 2008-01-23 13:46:58 -0800 (Wed, 23 Jan 2008) | 1 line Fixes #1594 ................ r42935 | eric_niebler | 2008-01-23 13:57:47 -0800 (Wed, 23 Jan 2008) | 1 line fix dependency issue in Jamfile ................ r42938 | jano_gaspar | 2008-01-23 15:04:57 -0800 (Wed, 23 Jan 2008) | 1 line circular_buffer: updated documentation ................ r42939 | eric_niebler | 2008-01-23 15:25:24 -0800 (Wed, 23 Jan 2008) | 1 line fix quickbook scanner to recognize the [import ...] block ................ r42943 | danieljames | 2008-01-23 15:39:59 -0800 (Wed, 23 Jan 2008) | 60 lines Merged revisions 42882-42941 via svnmerge from https://svn.boost.org/svn/boost/branches/unordered/trunk ................ r42887 | danieljames | 2008-01-20 21:32:04 +0000 (Sun, 20 Jan 2008) | 10 lines Merged revisions 42590-42664,42667-42697,42699-42723,42725-42855,42857-42881 via svnmerge from https://svn.boost.org/svn/boost/trunk ........ r42881 | danieljames | 2008-01-20 17:37:21 +0000 (Sun, 20 Jan 2008) | 1 line Include <new> to get std::bad_alloc. ........ ................ r42892 | danieljames | 2008-01-21 13:03:16 +0000 (Mon, 21 Jan 2008) | 1 line On some compilers the Rogue Wave/Apache stdcxx library doesn't have the normal std::distance, but instead has a variant that takes the result as the third parameter so it doesn't have to work out the type from the iterator. ................ r42893 | danieljames | 2008-01-21 13:07:58 +0000 (Mon, 21 Jan 2008) | 1 line Fix a typo in the last commit. ................ r42895 | danieljames | 2008-01-21 13:33:29 +0000 (Mon, 21 Jan 2008) | 1 line Remove tabs from the last checkin. ................ r42896 | danieljames | 2008-01-21 15:51:40 +0000 (Mon, 21 Jan 2008) | 1 line Use Boost config to tell when we have a std::distance function. Also, no need for a macro. ................ r42908 | danieljames | 2008-01-21 21:37:04 +0000 (Mon, 21 Jan 2008) | 1 line Use boost::long_long_type and boost::ulong_long_type. ................ r42921 | danieljames | 2008-01-23 11:43:35 +0000 (Wed, 23 Jan 2008) | 1 line Remove some tabs. ................ r42922 | danieljames | 2008-01-23 11:46:28 +0000 (Wed, 23 Jan 2008) | 2 lines Add missing include. Refs #1596 ................ r42923 | danieljames | 2008-01-23 11:52:47 +0000 (Wed, 23 Jan 2008) | 2 lines Always use void const* for the second parameter of allocate. Refs #1596. ................ r42936 | danieljames | 2008-01-23 22:22:16 +0000 (Wed, 23 Jan 2008) | 1 line Use Boost style library name in the documentation. ................ r42937 | danieljames | 2008-01-23 22:22:32 +0000 (Wed, 23 Jan 2008) | 1 line More tabs. ................ r42941 | danieljames | 2008-01-23 23:35:01 +0000 (Wed, 23 Jan 2008) | 1 line Fix all the allocators. ................ ................ r42948 | turkanis | 2008-01-23 22:50:32 -0800 (Wed, 23 Jan 2008) | 1 line merged changes from iostreams_dev, revisions 42825-42947 ................ r42950 | t_schwinger | 2008-01-24 10:56:27 -0800 (Thu, 24 Jan 2008) | 3 lines correctsbroken compiler support for MPL ................ r42951 | eric_niebler | 2008-01-24 13:06:23 -0800 (Thu, 24 Jan 2008) | 1 line peeker optimization looks inside independent sub-expressions ................ r42952 | nesotto | 2008-01-24 14:22:35 -0800 (Thu, 24 Jan 2008) | 1 line test of output iterators ................ r42953 | nesotto | 2008-01-24 14:26:36 -0800 (Thu, 24 Jan 2008) | 1 line output iterator test ................ r42954 | nesotto | 2008-01-24 14:27:27 -0800 (Thu, 24 Jan 2008) | 1 line output iterators for ptr_containers ................ r42957 | t_schwinger | 2008-01-24 16:26:16 -0800 (Thu, 24 Jan 2008) | 3 lines simplifies preprocessing code ................ r42958 | t_schwinger | 2008-01-24 16:28:15 -0800 (Thu, 24 Jan 2008) | 3 lines touched ................ r42960 | noel_belcourt | 2008-01-24 20:41:16 -0800 (Thu, 24 Jan 2008) | 6 lines Changed the -soname and -shared options in intel-darwin.jam to use -dynamiclib and -install_name, as done in darwin.jam. Apparently the Intel compilers on the Mac support the same options as gcc for setting the internal dynamic library name. ................ r42963 | nesotto | 2008-01-24 23:52:14 -0800 (Thu, 24 Jan 2008) | 1 line renaming ... ................ r42964 | nesotto | 2008-01-24 23:52:56 -0800 (Thu, 24 Jan 2008) | 1 line renaming ................ r42965 | nesotto | 2008-01-24 23:54:28 -0800 (Thu, 24 Jan 2008) | 1 line renaming ................ r42970 | turkanis | 2008-01-25 09:56:25 -0800 (Fri, 25 Jan 2008) | 1 line merged changes from iostreams_dev, revisions 42947-42962: fixed tickets 1003, 1139, 1140, 1149 ................ r42971 | noel_belcourt | 2008-01-25 11:52:47 -0800 (Fri, 25 Jan 2008) | 2 lines Fixed a typo to yesterdays patch. ................ r42972 | dgregor | 2008-01-25 13:07:14 -0800 (Fri, 25 Jan 2008) | 2 lines Include <ios> to get std::boolalpha. Fixes #1586 ................ r42974 | igaztanaga | 2008-01-25 15:07:51 -0800 (Fri, 25 Jan 2008) | 4 lines 1)Fixed gcc release mode warnings. 2)Replaced throw with BOOST_RETHROW when BOOST_TRY is used. 3)Fixed issues with singly linked lists ................ r42976 | hkaiser | 2008-01-25 17:24:21 -0800 (Fri, 25 Jan 2008) | 2 lines Wave: Fixed a problem in flex_string::compare() (#include_next was non-functional). ................ r42977 | hkaiser | 2008-01-25 17:36:20 -0800 (Fri, 25 Jan 2008) | 1 line Wave: Added new testcase. ................ r42980 | hkaiser | 2008-01-25 17:44:32 -0800 (Fri, 25 Jan 2008) | 1 line Wave: Tweaked new testcase. ................ r42982 | igaztanaga | 2008-01-26 03:52:25 -0800 (Sat, 26 Jan 2008) | 1 line Refactored common slist functions in a single class ................ r42984 | noel_belcourt | 2008-01-26 10:35:59 -0800 (Sat, 26 Jan 2008) | 7 lines Fixes #416 Fixed spelling of Jack Edmonds name and renamed files where necessary. Updated the documentation as well. Tested changes by building/running tests in libs/graph/test. ................ r42985 | noel_belcourt | 2008-01-26 10:51:28 -0800 (Sat, 26 Jan 2008) | 5 lines Fixes #640 Corrected the mpl push_front html documentation. ................ r42986 | eric_niebler | 2008-01-26 11:38:44 -0800 (Sat, 26 Jan 2008) | 1 line optimize repeated searches with patterns that have leading repeats ................ r42987 | t_schwinger | 2008-01-26 13:50:14 -0800 (Sat, 26 Jan 2008) | 3 lines attempts to allow some preprocessing with VACPP (IBM) ................ r42988 | noel_belcourt | 2008-01-26 14:21:57 -0800 (Sat, 26 Jan 2008) | 5 lines Fixes #1539 Fixed typo in the random documentation. ................ r42989 | noel_belcourt | 2008-01-26 15:06:24 -0800 (Sat, 26 Jan 2008) | 6 lines Fixes #965 Patched the XML and will check to ensure the html page reflects this change. ................ r42990 | eric_niebler | 2008-01-26 21:56:46 -0800 (Sat, 26 Jan 2008) | 1 line updated vcproj ................ r42991 | eric_niebler | 2008-01-26 21:57:08 -0800 (Sat, 26 Jan 2008) | 1 line fix typo ................ r42992 | johnmaddock | 2008-01-27 10:43:35 -0800 (Sun, 27 Jan 2008) | 1 line Extended leading repeat optimization to more cases. ................ r42997 | vladimir_prus | 2008-01-28 09:59:27 -0800 (Mon, 28 Jan 2008) | 1 line Correct speliing of --build-dir in --help output ................ r43000 | eric_niebler | 2008-01-28 12:03:41 -0800 (Mon, 28 Jan 2008) | 1 line update acknowledgement of john maddock ................ r43001 | bgubenko | 2008-01-28 13:27:13 -0800 (Mon, 28 Jan 2008) | 1 line marked 2 asio library tests for gcc-4.2.1_hpux_ia64 (HP-UX 11.23 with gcc) ................ r43002 | eric_niebler | 2008-01-28 14:55:30 -0800 (Mon, 28 Jan 2008) | 1 line doc more concepts, misc clean-up ................ r43003 | eric_niebler | 2008-01-28 14:56:46 -0800 (Mon, 28 Jan 2008) | 1 line proto doxygen comments, misc clean-up ................ r43006 | eric_niebler | 2008-01-28 18:20:45 -0800 (Mon, 28 Jan 2008) | 1 line more proto doxygen comments, update copyright ................ r43007 | vladimir_prus | 2008-01-28 22:28:09 -0800 (Mon, 28 Jan 2008) | 1 line Retain top-level boost-build.jam ................ r43008 | vladimir_prus | 2008-01-28 22:40:06 -0800 (Mon, 28 Jan 2008) | 4 lines Disable relinking when <target-os> is either windows or cygwin. Fixes #1062. ................ r43009 | eric_niebler | 2008-01-28 23:03:03 -0800 (Mon, 28 Jan 2008) | 1 line add tests for deep_copy, make_expr, unpack_expr; fix bugs; update more copyrights ................ r43012 | djenkins | 2008-01-29 08:41:12 -0800 (Tue, 29 Jan 2008) | 1 line fix typo ................ r43013 | djenkins | 2008-01-29 08:43:51 -0800 (Tue, 29 Jan 2008) | 1 line update copyright and misc cleanup ................ r43014 | bgubenko | 2008-01-29 09:47:01 -0800 (Tue, 29 Jan 2008) | 1 line marked interprocess library unusable on gcc-4.2.1_hpux_ia64 (until it is ported to HP-UX platform) ................ r43016 | eric_niebler | 2008-01-29 13:02:52 -0800 (Tue, 29 Jan 2008) | 1 line make_expr and unpack_expr improvements, fix scary transform::arg_c bug ................ r43018 | djenkins | 2008-01-29 19:39:02 -0800 (Tue, 29 Jan 2008) | 1 line use skip directive to simplify example ................ r43023 | eric_niebler | 2008-01-30 14:10:13 -0800 (Wed, 30 Jan 2008) | 1 line finally, a make_expr() I can live with ................ r43024 | eric_niebler | 2008-01-30 14:26:34 -0800 (Wed, 30 Jan 2008) | 1 line regenerated boostbook reference ................ r43025 | niels_dekker | 2008-01-30 14:42:23 -0800 (Wed, 30 Jan 2008) | 1 line value_init: Removed aligned_storage::address() calls, to improve TR1 compatibility, as confirmed by John Maddock. Added internal helper function, wrapper_address(), as discussed with Fernando. ................ r43026 | eric_niebler | 2008-01-30 15:03:36 -0800 (Wed, 30 Jan 2008) | 1 line minor tweak to make_expr result_of return type calculation ................ r43031 | eric_niebler | 2008-01-30 23:36:28 -0800 (Wed, 30 Jan 2008) | 1 line simplify make_expr.hpp, user docs for make_expr() ................ r43035 | eric_niebler | 2008-01-31 10:44:17 -0800 (Thu, 31 Jan 2008) | 1 line minor tweak to fusion value_of and value_at for expressions, for better interop with proto::unpack_expr ................ r43037 | vladimir_prus | 2008-01-31 11:47:12 -0800 (Thu, 31 Jan 2008) | 1 line Build in MT mode (as long as wave links to boost.thread) ................ r43038 | hkaiser | 2008-01-31 12:57:47 -0800 (Thu, 31 Jan 2008) | 1 line Wave: fixed expanding_function_like_macro() ................ r43040 | eric_niebler | 2008-01-31 13:12:44 -0800 (Thu, 31 Jan 2008) | 1 line finish documentation for expression construction utilities ................ r43041 | hkaiser | 2008-01-31 14:33:43 -0800 (Thu, 31 Jan 2008) | 1 line Wave: Added additional configuration possibility to allow control threading support. ................ r43042 | hkaiser | 2008-01-31 14:48:56 -0800 (Thu, 31 Jan 2008) | 1 line Wave: Added additional configuration possibility to allow control threading support. Updated the documentation. ................ r43043 | jurko | 2008-01-31 16:27:31 -0800 (Thu, 31 Jan 2008) | 1 line Reverted changes made in rev 43038 which seem to have been committed by mistake and include some user specific settings in it local to the comitter's environment while this file is intended to be used as generic template for actual user-config.jam files and do nothing in case user does not specify his own settings there. ................ r43044 | jurko | 2008-01-31 16:44:23 -0800 (Thu, 31 Jan 2008) | 1 line Minor stylistic spacing changes. Remove trailing spaces. ................ r43045 | jurko | 2008-01-31 16:46:50 -0800 (Thu, 31 Jan 2008) | 1 line Corrected outputting native Windows paths so that it works correctly for absolute paths without the drive letter being explicitly specified, e.g. \aaa\bbb or /aaa/bbb. ................ r43046 | jurko | 2008-01-31 17:49:16 -0800 (Thu, 31 Jan 2008) | 1 line Added the missing end-of-line character when outputting DEBUG_SEARCH debug messages from file_build1(). This cleans up the -d+6 bjam output a lot. ................ r43050 | eric_niebler | 2008-02-01 12:30:29 -0800 (Fri, 01 Feb 2008) | 1 line add future group example ................ r43052 | noel_belcourt | 2008-02-01 18:41:23 -0800 (Fri, 01 Feb 2008) | 4 lines Fix a typo in pgi.jam that prevented shared libraries from being built correctly. ................ r43054 | chris_kohlhoff | 2008-02-02 03:37:45 -0800 (Sat, 02 Feb 2008) | 4 lines Ensure that the workaround for the MSVC secure iterator problem is only used when compiling with MSVC. The workaround causes g++'s library debug mode to report errors due to the assignment from a singular iterator. ................ r43055 | chris_kohlhoff | 2008-02-02 03:39:17 -0800 (Sat, 02 Feb 2008) | 2 lines Fix "possible loss of data" warning when building for Windows 2000 targets. ................ r43056 | chris_kohlhoff | 2008-02-02 04:02:23 -0800 (Sat, 02 Feb 2008) | 3 lines The latest Windows SDKs don't support IPv6 when building for Windows 2000, so we need to use the SDK emulation in that case. ................ r43057 | eric_niebler | 2008-02-02 04:27:16 -0800 (Sat, 02 Feb 2008) | 1 line port test to boost version 1.34.1 ................ r43061 | turkanis | 2008-02-02 14:10:46 -0800 (Sat, 02 Feb 2008) | 1 line merged changes from iostreams_dev, revisions 42962-43059: updated copyright notices ................ r43080 | eric_niebler | 2008-02-03 10:40:03 -0800 (Sun, 03 Feb 2008) | 1 line fix bug found by L. Evans re: fusion and stateful function objects ................ r43083 | johnmaddock | 2008-02-04 01:13:36 -0800 (Mon, 04 Feb 2008) | 1 line Added missing file. ................ r43085 | johnmaddock | 2008-02-04 01:17:35 -0800 (Mon, 04 Feb 2008) | 1 line Removed dead file. ................ r43087 | johnmaddock | 2008-02-04 01:20:46 -0800 (Mon, 04 Feb 2008) | 1 line Removed dead files. ................ r43089 | johnmaddock | 2008-02-04 01:23:28 -0800 (Mon, 04 Feb 2008) | 1 line Removed dead files. ................ r43094 | anthonyw | 2008-02-04 05:16:32 -0800 (Mon, 04 Feb 2008) | 1 line added test for duration overloads of timed_lock, and added missing implementation to win32 version ................ r43101 | hkaiser | 2008-02-04 11:21:46 -0800 (Mon, 04 Feb 2008) | 1 line Wave: trying to fix stdcxx_gcc regression. ................ r43103 | matias | 2008-02-04 13:01:06 -0800 (Mon, 04 Feb 2008) | 1 line hooking --> additional information in html docs ................ r43106 | eric_niebler | 2008-02-04 18:09:51 -0800 (Mon, 04 Feb 2008) | 1 line fleshing out evaluation.qbk, document transforms of if_, not_, and_ and or_ ................ r43107 | eric_niebler | 2008-02-04 21:33:12 -0800 (Mon, 04 Feb 2008) | 1 line eliminate warnings under msvc's -W4 ................ r43111 | eric_niebler | 2008-02-04 22:03:01 -0800 (Mon, 04 Feb 2008) | 1 line fix typo ................ r43112 | marshall | 2008-02-05 08:07:19 -0800 (Tue, 05 Feb 2008) | 1 line Fix typo (bug #1434) ................ r43113 | marshall | 2008-02-05 08:15:35 -0800 (Tue, 05 Feb 2008) | 1 line Applied patch (fixes bug #1307) ................ r43117 | dgregor | 2008-02-05 12:51:23 -0800 (Tue, 05 Feb 2008) | 1 line Fix add_vertex and add_vertices when the CSR graph has vertex properties ................ r43118 | danieljames | 2008-02-05 12:57:02 -0800 (Tue, 05 Feb 2008) | 13 lines Merged revisions 42942-43116 via svnmerge from https://svn.boost.org/svn/boost/branches/unordered/trunk ........ r42975 | danieljames | 2008-01-26 00:29:32 +0000 (Sat, 26 Jan 2008) | 1 line Typedef some types before using them, to make life easier for Borland. ........ r43116 | danieljames | 2008-02-05 20:47:44 +0000 (Tue, 05 Feb 2008) | 1 line Some compilers and libraries combinations have problems with deques of non-assingable types. Using a list instead. ........ ................ r43120 | eric_niebler | 2008-02-05 13:07:31 -0800 (Tue, 05 Feb 2008) | 1 line add missing #include ................ r43121 | bemandawes | 2008-02-05 18:01:46 -0800 (Tue, 05 Feb 2008) | 1 line Add circular_buffer to the alphabetic list ................ r43125 | t_schwinger | 2008-02-06 05:00:08 -0800 (Wed, 06 Feb 2008) | 3 lines attempts to make synthesis metafunctions work with sun compiler ................ r43129 | danieljames | 2008-02-06 11:02:38 -0800 (Wed, 06 Feb 2008) | 2 lines In the boostbook navbar, link FAQ and people to the website. ................ r43130 | eric_niebler | 2008-02-06 11:57:51 -0800 (Wed, 06 Feb 2008) | 1 line untabify ................ r43132 | nesotto | 2008-02-06 14:46:19 -0800 (Wed, 06 Feb 2008) | 1 line cleanup to pass inspection report ................ r43133 | nesotto | 2008-02-06 14:46:31 -0800 (Wed, 06 Feb 2008) | 1 line cleanup to pass inspection report ................ r43134 | eric_niebler | 2008-02-06 14:57:57 -0800 (Wed, 06 Feb 2008) | 1 line add handy get() accessors on literal<> wrapper ................ r43135 | nesotto | 2008-02-06 15:12:21 -0800 (Wed, 06 Feb 2008) | 1 line cleanup to pass inspection tool ................ r43136 | eric_niebler | 2008-02-06 16:05:01 -0800 (Wed, 06 Feb 2008) | 1 line reasonably complete user docs for expression evaluation ................ r43138 | eric_niebler | 2008-02-07 00:06:29 -0800 (Thu, 07 Feb 2008) | 1 line tweaks for doxygen 1.5.4, document matches<> ................ r43141 | johnmaddock | 2008-02-07 01:55:41 -0800 (Thu, 07 Feb 2008) | 1 line Fix last checked version. ................ r43143 | johnmaddock | 2008-02-07 02:03:16 -0800 (Thu, 07 Feb 2008) | 1 line Remove tabs. ................ r43145 | johnmaddock | 2008-02-07 02:13:31 -0800 (Thu, 07 Feb 2008) | 1 line Fix min/max usage violation. ................ r43147 | vladimir_prus | 2008-02-07 02:17:03 -0800 (Thu, 07 Feb 2008) | 2 lines Attempt to unbreak <library-file> ................ r43148 | johnmaddock | 2008-02-07 02:24:29 -0800 (Thu, 07 Feb 2008) | 1 line Added comment to suppress inspect warning. ................ r43150 | johnmaddock | 2008-02-07 02:29:59 -0800 (Thu, 07 Feb 2008) | 1 line Added fix for inspection report. ................ r43152 | vladimir_prus | 2008-02-07 03:04:30 -0800 (Thu, 07 Feb 2008) | 4 lines Fix <framework> with no path. Patch from Jon Olsson. ................ r43154 | bemandawes | 2008-02-07 05:22:34 -0800 (Thu, 07 Feb 2008) | 1 line Remove obsolete CVS scripts, add 1.35.0 SVN scripts, beginning of docs page ................ r43155 | nesotto | 2008-02-07 06:41:04 -0800 (Thu, 07 Feb 2008) | 6 lines iterator_range disables msvc warning 4996 <http://svn.boost.org/trac/boost/ticket/1565> [range] sub_range assignment issue <http://svn.boost.org/trac/boost/ticket/1284> ................ r43156 | nesotto | 2008-02-07 06:46:19 -0800 (Thu, 07 Feb 2008) | 1 line test ................ r43157 | joaquin | 2008-02-07 08:29:27 -0800 (Thu, 07 Feb 2008) | 1 line updated according to latest regression tests results, fixed a broken link, typo ................ r43159 | turkanis | 2008-02-07 09:07:28 -0800 (Thu, 07 Feb 2008) | 1 line added missing 'self.' qualification ................ r43165 | dgregor | 2008-02-07 13:08:09 -0800 (Thu, 07 Feb 2008) | 1 line Support for non-blocking MPI operations in Python, from Andreas Kloeckner ................ r43166 | dgregor | 2008-02-07 13:09:38 -0800 (Thu, 07 Feb 2008) | 1 line Note addition of nonblocking operations to the Python interface ................ r43171 | nesotto | 2008-02-08 01:58:35 -0800 (Fri, 08 Feb 2008) | 1 line silence of warnings for unused arguments ................ r43175 | nesotto | 2008-02-08 07:25:01 -0800 (Fri, 08 Feb 2008) | 1 line missing ) fixed ................ r43176 | noel_belcourt | 2008-02-08 08:32:35 -0800 (Fri, 08 Feb 2008) | 14 lines Force PPC Darwin to use fork instead of vfork. This change requires both the parent and child process to explicitly set the process group id. Vfork guarantees the child process runs to the exec before it releases the parent process. Now that we use fork instead of vfork, it's possible for the parent to wait on the child process without having the child setpgid on itself. This eliminates spurious hangs on ppc darwin caused by either a race condition between vfork and execvp, or a bug in the vfork implementation. Added a test to ensure we don't try to read from the stderr pipe descriptor if the descriptor's not valid. ................ r43177 | eric_niebler | 2008-02-08 09:11:57 -0800 (Fri, 08 Feb 2008) | 1 line reserve some c_type bits for dinkumware on windows, fixes #1625 ................ r43179 | noel_belcourt | 2008-02-08 09:53:50 -0800 (Fri, 08 Feb 2008) | 13 lines I've added the -single_module option to the intel-darwin.link.dll action to fix this linker error when linking dylibs: ld: common symbols not allowed with MH_DYLIB output format with the -multi_module option boost/bin.v2/libs/system/build/intel-darwin-9.1/debug/macosx-version-10.4/error_code.o definition of common __ZGVZNK5boost6system14error_category7messageEiE1s (size 16) boost/bin.v2/libs/system/build/intel-darwin-9.1/debug/macosx-version-10.4/error_code.o definition of common __ZZNK5boost6system14error_category7messageEiE1s (size 16) though I would note that the common symbols problem occurs in a number of other libraries (test, graph, spirit, ...) as well. ................ r43188 | danieljames | 2008-02-09 04:29:02 -0800 (Sat, 09 Feb 2008) | 2 lines Fix a link in the intrusive redirect. ................ r43189 | danieljames | 2008-02-09 04:37:00 -0800 (Sat, 09 Feb 2008) | 1 line Fix another redirect link. ................ r43190 | danieljames | 2008-02-09 04:38:19 -0800 (Sat, 09 Feb 2008) | 1 line Update link to Jamfile, to link to the version 2 jamfile. ................ r43191 | danieljames | 2008-02-09 04:39:06 -0800 (Sat, 09 Feb 2008) | 1 line Fix a link. ................ r43192 | danieljames | 2008-02-09 04:45:32 -0800 (Sat, 09 Feb 2008) | 2 lines Add a forwarding header for hash/custom.html as Boost.Bimap links to it. ................ r43193 | danieljames | 2008-02-09 05:02:45 -0800 (Sat, 09 Feb 2008) | 1 line Fix the link to the license. ................ r43199 | eric_niebler | 2008-02-09 12:32:27 -0800 (Sat, 09 Feb 2008) | 1 line more doxygen comments, const-correctness tweak for fusion::at() on proto expression ................ r43200 | eric_niebler | 2008-02-09 12:34:33 -0800 (Sat, 09 Feb 2008) | 1 line document how to access children of proto expressions ................ r43204 | eric_niebler | 2008-02-09 22:57:24 -0800 (Sat, 09 Feb 2008) | 1 line fix oops in proto fusion interface ................ r43205 | eric_niebler | 2008-02-09 23:02:54 -0800 (Sat, 09 Feb 2008) | 1 line suppress msvc warning ................ r43206 | danieljames | 2008-02-10 01:55:03 -0800 (Sun, 10 Feb 2008) | 1 line Fix some broken links. ................ r43207 | vladimir_prus | 2008-02-10 05:13:41 -0800 (Sun, 10 Feb 2008) | 4 lines Tolerate argc being zero. Patch from C. K. Jester-Young. ................ r43209 | danieljames | 2008-02-10 06:56:22 -0800 (Sun, 10 Feb 2008) | 1 line Link to people pages on the website, as they've been removed from the download. ................ r43210 | danieljames | 2008-02-10 07:02:17 -0800 (Sun, 10 Feb 2008) | 1 line Point links to the pages that used to be in 'more' to the site. ................ r43212 | danieljames | 2008-02-10 08:10:16 -0800 (Sun, 10 Feb 2008) | 1 line Fix links on the home page as well. ................ r43213 | danieljames | 2008-02-10 08:21:22 -0800 (Sun, 10 Feb 2008) | 1 line Generated documentation which is no longer generated. ................ r43220 | eric_niebler | 2008-02-10 19:48:41 -0800 (Sun, 10 Feb 2008) | 1 line include config.hpp and workaround.hpp before uses of BOOST_WORKAROUND and BOOST_MSVC ................ r43221 | chris_kohlhoff | 2008-02-11 05:59:44 -0800 (Mon, 11 Feb 2008) | 2 lines Need to define _XOPEN_SOURCE_EXTENDED when compiling for HP-UX. ................ r43226 | djenkins | 2008-02-11 12:49:19 -0800 (Mon, 11 Feb 2008) | 1 line cleanup using local<> and skip() ................ r43239 | turkanis | 2008-02-12 21:43:39 -0800 (Tue, 12 Feb 2008) | 1 line fixed return value of read(), to correctly handle eof ................ r43240 | turkanis | 2008-02-12 21:47:44 -0800 (Tue, 12 Feb 2008) | 1 line merged changes from iostreams_dev, revisions 43059-43238: better debug output for mapped file; fixed large_file_test.cpp under UNICODE on Windows ................ r43241 | turkanis | 2008-02-13 11:38:52 -0800 (Wed, 13 Feb 2008) | 1 line added markup for stdcxx failures (iostreams) ................ r43243 | turkanis | 2008-02-13 11:42:10 -0800 (Wed, 13 Feb 2008) | 1 line switched from <wchar.h> to <cwchar>, for stdcxx (which is conforming in this case) ................ r43246 | matias | 2008-02-14 09:33:12 -0800 (Thu, 14 Feb 2008) | 1 line remove local admonitions ................ r43247 | matias | 2008-02-14 09:43:52 -0800 (Thu, 14 Feb 2008) | 1 line optional docs fixes ................ r43248 | matias | 2008-02-14 09:44:21 -0800 (Thu, 14 Feb 2008) | 1 line redirect optional docs to new version ................ r43251 | matias | 2008-02-14 10:08:16 -0800 (Thu, 14 Feb 2008) | 1 line conversion docs fixes ................ r43252 | matias | 2008-02-14 10:09:34 -0800 (Thu, 14 Feb 2008) | 1 line redirect to new conversion docs ................ r43253 | matias | 2008-02-14 10:19:34 -0800 (Thu, 14 Feb 2008) | 1 line redirect optional and numeric/conversion docs to new version ................ r43254 | matias | 2008-02-14 11:03:55 -0800 (Thu, 14 Feb 2008) | 1 line bimap doc fixes ................ r43255 | matias | 2008-02-14 11:05:04 -0800 (Thu, 14 Feb 2008) | 1 line fix tabs in files ................ r43256 | matias | 2008-02-14 11:22:15 -0800 (Thu, 14 Feb 2008) | 1 line fix tabs in files ................ r43260 | matias | 2008-02-14 13:24:11 -0800 (Thu, 14 Feb 2008) | 1 line add missing images ................ r43262 | hkaiser | 2008-02-14 14:01:54 -0800 (Thu, 14 Feb 2008) | 1 line Fixed a whitespace insertion glitch, where whitespace got inserted unconditionally between two operators even if one of these was a comma. ................ r43264 | hkaiser | 2008-02-14 15:52:33 -0800 (Thu, 14 Feb 2008) | 1 line Wave: More fixes to whitespace insertion engine. ................ r43266 | hkaiser | 2008-02-15 06:35:36 -0800 (Fri, 15 Feb 2008) | 1 line Wave: More fixes to whitespace insertion engine. ................ r43269 | pdimov | 2008-02-15 10:40:36 -0800 (Fri, 15 Feb 2008) | 1 line Added support for &&, || ................ r43272 | andreas_huber69 | 2008-02-16 02:13:08 -0800 (Sat, 16 Feb 2008) | 1 line Updated statechart markup ................ r43274 | andreas_huber69 | 2008-02-16 02:19:49 -0800 (Sat, 16 Feb 2008) | 2 lines Silenced GCC 4.0.1 warning (patch supplied by Euan) <http://thread.gmane.org/gmane.comp.lib.boost.devel/171071> ................ r43280 | jurko | 2008-02-16 08:50:42 -0800 (Sat, 16 Feb 2008) | 1 line Corrected comments related to the allowed linker & linker-type values. Minor stylistic changes. ................ r43281 | jurko | 2008-02-16 08:53:33 -0800 (Sat, 16 Feb 2008) | 1 line Added support for compiling C++ programs without RTTI support using the gcc toolset. ................ r43282 | jurko | 2008-02-16 09:03:54 -0800 (Sat, 16 Feb 2008) | 1 line Made the msvc toolset always explicitly enable or disable rtti support based on the <rtti> feature value instead of only setting it if <rtti>on and depending on it being disabled by default. The original behaviour did not work well with msvc 8.0 for which there was not way to disable rtti support as that compiler enables rtti support by default. ................ r43283 | bemandawes | 2008-02-16 18:01:32 -0800 (Sat, 16 Feb 2008) | 1 line Show output of example program ................ r43290 | hkaiser | 2008-02-17 08:45:08 -0800 (Sun, 17 Feb 2008) | 1 line Wave: Extended a workaround to newest Intel compiler version (Linux V10.1) ................ r43292 | nesotto | 2008-02-17 08:49:38 -0800 (Sun, 17 Feb 2008) | 1 line support for comparinson operators ................ r43293 | nesotto | 2008-02-17 08:50:02 -0800 (Sun, 17 Feb 2008) | 1 line support for comparison operators ................ r43294 | hkaiser | 2008-02-17 09:00:20 -0800 (Sun, 17 Feb 2008) | 1 line Wave: Fixed test cases to reflect recent changes to whitespace insertion. ................ r43296 | eric_niebler | 2008-02-17 12:53:18 -0800 (Sun, 17 Feb 2008) | 1 line proto documentation improvements ................ r43299 | turkanis | 2008-02-17 21:48:13 -0800 (Sun, 17 Feb 2008) | 1 line merged changes from iostreams_dev, revisions 43243-43298: overhaul of category_of and close(): stringstream is now dual_seekable; standard file streams and string streams are closable; public Boost.Iostreams streams and streambufs are closable; close() pops filtering streams and streambufs ................ r43300 | eric_niebler | 2008-02-17 22:16:27 -0800 (Sun, 17 Feb 2008) | 1 line remove dependence on boost.lambda, make numeric function objects work with std binders ................ r43301 | chris_kohlhoff | 2008-02-18 05:31:26 -0800 (Mon, 18 Feb 2008) | 2 lines Fix printing of error messages. ................ r43302 | chris_kohlhoff | 2008-02-18 05:33:23 -0800 (Mon, 18 Feb 2008) | 2 lines Only define _XOPEN_SOURCE_EXTENDED when building with gcc on HP-UX. ................ r43303 | chris_kohlhoff | 2008-02-18 05:35:15 -0800 (Mon, 18 Feb 2008) | 3 lines Add missing #include of socket_types.hpp needed for the SSL unit tests to compile successfully on Windows. ................ r43306 | eric_niebler | 2008-02-18 10:29:29 -0800 (Mon, 18 Feb 2008) | 1 line remove post_construct docs, fix link to boost.parameter library ................ r43308 | niels_dekker | 2008-02-18 14:11:19 -0800 (Mon, 18 Feb 2008) | 1 line Fixed the assignment of value_initialized<T> for T being a C-style array. (The previous version would trigger a compile error in this case.) ................ r43309 | niels_dekker | 2008-02-18 14:13:21 -0800 (Mon, 18 Feb 2008) | 1 line Tested the assignment of value_initialized<T>, for T being a C-style array. Related to the fix of changeset [43308] ................ r43310 | eric_niebler | 2008-02-18 15:03:23 -0800 (Mon, 18 Feb 2008) | 1 line some doxygen comments for proto/traits.hpp ................ r43311 | eric_niebler | 2008-02-18 21:56:52 -0800 (Mon, 18 Feb 2008) | 1 line more proto documentation tweaks, remove unnecessary result_of::arg_c instantiation ................ r43312 | eric_niebler | 2008-02-18 23:14:37 -0800 (Mon, 18 Feb 2008) | 1 line fix droppable accumulators ................ r43314 | eric_niebler | 2008-02-18 23:33:30 -0800 (Mon, 18 Feb 2008) | 1 line darn, back out bad droppable changes ................ r43316 | pdimov | 2008-02-19 05:18:58 -0800 (Tue, 19 Feb 2008) | 1 line Fixes #1590. ................ r43317 | pdimov | 2008-02-19 06:01:13 -0800 (Tue, 19 Feb 2008) | 1 line Fixes #1444. ................ r43318 | pdimov | 2008-02-19 06:26:36 -0800 (Tue, 19 Feb 2008) | 1 line Fix #398, as long as the macros BOOST_NO_STD_TYPEINFO and BOOST_NO_IOSTREAM are defined. I don't know how Boost.Config needs to be changed to autodetect eVC4 and set these on its own. ................ r43319 | pdimov | 2008-02-19 06:51:10 -0800 (Tue, 19 Feb 2008) | 1 line Fix #1641. ................ r43320 | pdimov | 2008-02-19 06:59:28 -0800 (Tue, 19 Feb 2008) | 1 line Fix #1646. ................ r43321 | pdimov | 2008-02-19 07:09:10 -0800 (Tue, 19 Feb 2008) | 1 line Fix #1642. ................ r43322 | nesotto | 2008-02-19 07:10:05 -0800 (Tue, 19 Feb 2008) | 1 line fixed problem with operator()() when the value_type was abstract. ................ r43323 | pdimov | 2008-02-19 07:40:58 -0800 (Tue, 19 Feb 2008) | 1 line Fix #1643. ................ r43325 | turkanis | 2008-02-19 11:34:07 -0800 (Tue, 19 Feb 2008) | 1 line stringstreams are no longer closable; the semantics of close() for these devices was illconsidered ................ r43328 | turkanis | 2008-02-19 16:09:06 -0800 (Tue, 19 Feb 2008) | 1 line menu fix from iostreams_dev ................ r43329 | turkanis | 2008-02-19 19:20:17 -0800 (Tue, 19 Feb 2008) | 1 line markup for pgi-7.0 (iostreams) ................ r43330 | bemandawes | 2008-02-20 05:46:49 -0800 (Wed, 20 Feb 2008) | 1 line Add .z7 archive generation ................ r43332 | grafik | 2008-02-20 09:32:09 -0800 (Wed, 20 Feb 2008) | 1 line New readme page for now standalone release. ................ r43334 | grafik | 2008-02-20 11:15:16 -0800 (Wed, 20 Feb 2008) | 1 line Fix link to getting started docs. ................ r43335 | grafik | 2008-02-20 14:50:03 -0800 (Wed, 20 Feb 2008) | 1 line Add the <python.interpreter> to all requirements to allow other toolsets to use the currently configured python instead of relying on python being in the path. ................ r43336 | grafik | 2008-02-20 15:01:43 -0800 (Wed, 20 Feb 2008) | 1 line Use the configured python interpreter instead of assuming it's in the path. ................ r43337 | grafik | 2008-02-20 15:03:28 -0800 (Wed, 20 Feb 2008) | 1 line Add missing, and assumed, white background for screen rendering. ................ r43338 | grafik | 2008-02-20 15:26:58 -0800 (Wed, 20 Feb 2008) | 1 line Doc cleanups. ................ r43344 | eric_niebler | 2008-02-20 23:18:24 -0800 (Wed, 20 Feb 2008) | 1 line More Proto documentation ................ r43346 | johnmaddock | 2008-02-21 02:37:59 -0800 (Thu, 21 Feb 2008) | 3 lines Fix typo in example. Added links to PDF versions of the docs. Regenerated all the docs to fix people links. ................ r43347 | johnmaddock | 2008-02-21 03:53:59 -0800 (Thu, 21 Feb 2008) | 1 line Update main overview page. ................ r43349 | bemandawes | 2008-02-21 04:46:11 -0800 (Thu, 21 Feb 2008) | 1 line Fix typo; .z7 should be .7z ................ r43351 | johnmaddock | 2008-02-21 04:58:15 -0800 (Thu, 21 Feb 2008) | 1 line Added link to PDF docs, and regenerated. ................ r43354 | johnmaddock | 2008-02-21 05:51:18 -0800 (Thu, 21 Feb 2008) | 1 line Added link to PDF docs, and regenerated. ................ r43357 | johnmaddock | 2008-02-21 08:49:59 -0800 (Thu, 21 Feb 2008) | 1 line Added link to PDF docs. ................ r43359 | johnmaddock | 2008-02-21 09:01:26 -0800 (Thu, 21 Feb 2008) | 1 line Regenerated docs to fix links. ................ r43361 | bemandawes | 2008-02-21 12:11:32 -0800 (Thu, 21 Feb 2008) | 1 line Fix still another typo ................ r43362 | eric_niebler | 2008-02-21 12:12:02 -0800 (Thu, 21 Feb 2008) | 1 line doxygen comments for proto::when<> ................ r43363 | eric_niebler | 2008-02-21 16:42:12 -0800 (Thu, 21 Feb 2008) | 1 line fix crash when actions are in keep() expressions ................ r43364 | eric_niebler | 2008-02-21 18:01:46 -0800 (Thu, 21 Feb 2008) | 1 line doxygen comments ................ r43365 | grafik | 2008-02-21 21:26:39 -0800 (Thu, 21 Feb 2008) | 1 line Rename readme.html to index.html, and add forwarding index.htm for backward compatibility. ................ r43368 | danieljames | 2008-02-22 01:21:22 -0800 (Fri, 22 Feb 2008) | 2 lines Update the index.html link in the navbar. ................ r43371 | grafik | 2008-02-22 08:25:21 -0800 (Fri, 22 Feb 2008) | 1 line Remove obsolete getting started files. They where replaced by more/getting_started/*. ................ r43377 | chris_kohlhoff | 2008-02-22 14:43:54 -0800 (Fri, 22 Feb 2008) | 2 lines Use the correct vector of timer queues when dispatching timers. ................ r43390 | turkanis | 2008-02-22 16:05:49 -0800 (Fri, 22 Feb 2008) | 2 lines Ported change from iostreams_dev ................ r43391 | turkanis | 2008-02-22 16:06:24 -0800 (Fri, 22 Feb 2008) | 2 lines Ported changes from iostreams_dev ................ r43392 | turkanis | 2008-02-22 16:07:13 -0800 (Fri, 22 Feb 2008) | 1 line merged changes from iostreams_dev, revisions 43327-43389 ................ r43393 | turkanis | 2008-02-22 16:11:07 -0800 (Fri, 22 Feb 2008) | 1 line merged changes from iostreams_dev ................ r43395 | turkanis | 2008-02-22 22:07:59 -0800 (Fri, 22 Feb 2008) | 1 line updated to test close() on filtering streambufs ................ r43399 | turkanis | 2008-02-22 23:44:58 -0800 (Fri, 22 Feb 2008) | 1 line merged changes from iostreams_dev ................ r43402 | bemandawes | 2008-02-23 06:04:02 -0800 (Sat, 23 Feb 2008) | 1 line Give the 1st and 2nd level index.html files a common look-and-feel. ................ r43405 | vladimir_prus | 2008-02-24 04:59:04 -0800 (Sun, 24 Feb 2008) | 3 lines Recognize that fact, for that for intel-win, <runtime-debuggin> matters and should be added to the library name. ................ r43409 | bemandawes | 2008-02-24 16:53:26 -0800 (Sun, 24 Feb 2008) | 1 line Fix html boo boo ................ r43410 | schoepflin | 2008-02-25 00:37:10 -0800 (Mon, 25 Feb 2008) | 1 line Added missing template keyword. ................ r43411 | t_schwinger | 2008-02-25 03:45:51 -0800 (Mon, 25 Feb 2008) | 3 lines removes unnecessary escaping ................ r43412 | t_schwinger | 2008-02-25 03:47:59 -0800 (Mon, 25 Feb 2008) | 3 lines removes unnecessary comment ................ r43416 | hkaiser | 2008-02-26 11:25:05 -0800 (Tue, 26 Feb 2008) | 1 line Wave: Fixed expanding_function_like_macro preprocessing hook. ................ r43417 | danieljames | 2008-02-26 14:04:55 -0800 (Tue, 26 Feb 2008) | 2 lines Fix a link to Boost.Bimap. ................ r43418 | danieljames | 2008-02-26 14:07:25 -0800 (Tue, 26 Feb 2008) | 2 lines Change another link that's no longer in the repository to link to the website. ................ r43419 | hkaiser | 2008-02-26 14:36:36 -0800 (Tue, 26 Feb 2008) | 1 line Fixed a compilation problem on pathscale ................ r43421 | eric_niebler | 2008-02-27 10:48:22 -0800 (Wed, 27 Feb 2008) | 1 line partially revert breaking change to independent sub-expressions until I can make a proper fix ................ r43422 | danieljames | 2008-02-27 10:51:14 -0800 (Wed, 27 Feb 2008) | 1 line Fix broken copyright urls. Fixes #1573. ................ r43423 | danieljames | 2008-02-27 11:22:01 -0800 (Wed, 27 Feb 2008) | 1 line Fix incorrect links to copyright of the form 'http:#www.boost.org ................ r43424 | eric_niebler | 2008-02-27 11:39:43 -0800 (Wed, 27 Feb 2008) | 1 line fix bug in use_simple_repeat calculation ................ r43428 | eric_niebler | 2008-02-27 16:03:15 -0800 (Wed, 27 Feb 2008) | 1 line add test case for use_simple_repeat fix ................ r43433 | eric_niebler | 2008-02-28 14:47:12 -0800 (Thu, 28 Feb 2008) | 1 line fix oops ................ r43434 | johnmaddock | 2008-02-29 01:49:42 -0800 (Fri, 29 Feb 2008) | 1 line Apply fixes to issue #1658 which fixes some broken URL's. ................ r43435 | johnmaddock | 2008-02-29 01:58:30 -0800 (Fri, 29 Feb 2008) | 1 line Fix broken link as per report #1658. ................ r43437 | chris_kohlhoff | 2008-02-29 04:57:57 -0800 (Fri, 29 Feb 2008) | 2 lines Add missing tie(). ................ r43438 | schoepflin | 2008-02-29 07:13:41 -0800 (Fri, 29 Feb 2008) | 2 lines Added expected failure markup for the test weighted_tail_variate_means on Tru64/CXX. ................ r43441 | eric_niebler | 2008-03-01 11:32:56 -0800 (Sat, 01 Mar 2008) | 1 line add map_assign example ................ r43458 | turkanis | 2008-03-02 22:20:14 -0800 (Sun, 02 Mar 2008) | 1 line merged changes from iostreams_dev, revisions 43399-43457 ................ r43461 | anthonyw | 2008-03-03 00:44:42 -0800 (Mon, 03 Mar 2008) | 1 line Test and fix for issue #1665 ................ r43464 | anthonyw | 2008-03-03 02:52:44 -0800 (Mon, 03 Mar 2008) | 1 line thread constructor now accepts up to three additional arguments to pass to thread function ................ r43467 | danieljames | 2008-03-03 04:10:35 -0800 (Mon, 03 Mar 2008) | 2 lines Tell subversion that date_time.doc is a text file, not a word document. ................ r43468 | danieljames | 2008-03-03 04:11:25 -0800 (Mon, 03 Mar 2008) | 1 line Fix license link in date_time.doc ................ r43469 | chris_kohlhoff | 2008-03-03 05:21:05 -0800 (Mon, 03 Mar 2008) | 4 lines Disable use of CancelIo by default, due to the possibility of silent failure on some system configurations. Swallow error returned by CancelIoEx if there are no operations to be cancelled. ................ r43470 | chris_kohlhoff | 2008-03-03 05:27:06 -0800 (Mon, 03 Mar 2008) | 2 lines Add missing 'boost_' prefix to helper namespace. ................ r43471 | chris_kohlhoff | 2008-03-03 05:36:35 -0800 (Mon, 03 Mar 2008) | 2 lines Regenerate documentation. ................ r43472 | chris_kohlhoff | 2008-03-03 06:05:35 -0800 (Mon, 03 Mar 2008) | 1 line Update copyright notices. ................ r43473 | chris_kohlhoff | 2008-03-03 06:13:01 -0800 (Mon, 03 Mar 2008) | 2 lines Update copyright notices. ................ r43476 | eric_niebler | 2008-03-03 11:44:54 -0800 (Mon, 03 Mar 2008) | 1 line add Map Assign example to documentation ................ r43478 | eric_niebler | 2008-03-03 11:47:47 -0800 (Mon, 03 Mar 2008) | 1 line second attempt at fixing actions in independent expressions ................ r43484 | eric_niebler | 2008-03-03 15:48:17 -0800 (Mon, 03 Mar 2008) | 1 line handle static regexes with actions nested in dynamic independent subexpressions ................ r43485 | emildotchevski | 2008-03-03 17:41:17 -0800 (Mon, 03 Mar 2008) | 1 line boost exception ................ r43496 | eric_niebler | 2008-03-04 10:51:07 -0800 (Tue, 04 Mar 2008) | 1 line rename numeric::empty to numeric::default_, fixes #1650 ................ r43501 | eric_niebler | 2008-03-04 11:31:57 -0800 (Tue, 04 Mar 2008) | 1 line eliminate msvc level 4 warnings, fixes #1631 ................ r43502 | eric_niebler | 2008-03-04 11:42:36 -0800 (Tue, 04 Mar 2008) | 1 line add Dave Jenkin's evil static/dynamic actions in keep test case ................ r43503 | eric_niebler | 2008-03-04 13:09:47 -0800 (Tue, 04 Mar 2008) | 1 line work around msvc bug 331418, fixes #1652 ................ r43506 | eric_niebler | 2008-03-04 15:01:17 -0800 (Tue, 04 Mar 2008) | 1 line fix bad interaction between boyer-moore optimization and partial match feature, fixes #1564 ................ r43508 | eric_niebler | 2008-03-04 22:32:39 -0800 (Tue, 04 Mar 2008) | 1 line add BOOST_REVERSE_FOREACH, fixes #1071 ................ r43509 | eric_niebler | 2008-03-04 23:12:03 -0800 (Tue, 04 Mar 2008) | 1 line fix bug iterating over abstract base ................ [SVN r43519]
6823 lines
257 KiB
HTML
6823 lines
257 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
|
||
"http://www.w3.org/TR/html4/loose.dtd">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||
<title>
|
||
Templated Circular Buffer Container
|
||
</title>
|
||
<link rel="stylesheet" href="../../../boost.css" type="text/css">
|
||
</head>
|
||
<body>
|
||
<table id="title" border="0">
|
||
<tr>
|
||
<td>
|
||
<h1>
|
||
Templated Circular Buffer Container
|
||
</h1>
|
||
<h1>
|
||
circular_buffer<T, Alloc>
|
||
</h1>
|
||
</td>
|
||
<td>
|
||
<a href="../../../"><img src="../../../boost.png" width="277" height="86" border="0" alt="Boost"></a>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<h2>
|
||
Contents
|
||
</h2><a href="#description">Description</a><br>
|
||
<a href="#briefexample">Introductory Example</a><br>
|
||
<a href="#synopsis">Synopsis</a><br>
|
||
<a href="#rationale">Rationale</a><br>
|
||
- <a href="#threadsafety">Thread-Safety</a><br>
|
||
- <a href="#overwrite">Overwrite Operation</a><br>
|
||
- <a href="#fullbuffer">Writing to a Full Buffer</a><br>
|
||
- <a href="#emptybuffer">Reading/Removing from an Empty Buffer</a><br>
|
||
- <a href="#iteratorinvalidation">Iterator Invalidation</a><br>
|
||
<a href="#caveats">Caveats</a><br>
|
||
<a href="#debug">Debug Support</a><br>
|
||
<a href="#examples">More Examples</a><br>
|
||
<a href="#header">Header Files</a><br>
|
||
<a href="#model">Modelled Concepts</a><br>
|
||
<a href="#parameters">Template Parameters</a><br>
|
||
<a href="#types">Public Types</a><br>
|
||
<a href="#constructors">Constructors and Destructor</a><br>
|
||
<a href="#methods">Public Member Functions</a><br>
|
||
<a href="#functions">Standalone Functions</a><br>
|
||
<a href="#notes">Notes</a><br>
|
||
<a href="#see">See also</a><br>
|
||
<a href="#ack">Acknowledgements</a>
|
||
<table id="table_figure" align="right" border="0">
|
||
<tr>
|
||
<td>
|
||
<img src="circular_buffer.png" width="300" height="332" alt="Circular Buffer">
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td width="300">
|
||
<table id="table_figure_desc" cellpadding="5" align="right" border="0">
|
||
<tr>
|
||
<td valign="top">
|
||
<b>Figure:</b>
|
||
</td>
|
||
<td valign="top">
|
||
The circular buffer (for someone known as <i>ring</i> or <i>cyclic buffer</i>).
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<h2>
|
||
<a name="description" id="description">Description</a>
|
||
</h2>
|
||
<p>
|
||
In general the term <i>circular buffer</i> refers to an area in memory which is used to store incoming data. When
|
||
the buffer is filled, new data is written starting at the beginning of the buffer and overwriting the old. (Also
|
||
see the Figure.)
|
||
</p>
|
||
<p>
|
||
The <code>circular_buffer</code> is a STL compliant container. It is a kind of sequence similar to <code><a href=
|
||
"http://www.sgi.com/tech/stl/List.html">std::list</a></code> or <code><a href=
|
||
"http://www.sgi.com/tech/stl/Deque.html">std::deque</a></code>. It supports random access iterators, constant
|
||
time insert and erase operations at the beginning or the end of the buffer and interoperability with
|
||
<code>std</code> algorithms. The <code>circular_buffer</code> is especially designed to provide fixed capacity
|
||
storage. When its capacity is exhausted, newly inserted elements will cause elements either at the beginning or
|
||
end of the buffer (depending on what insert operation is used) to be overwritten.
|
||
</p>
|
||
<p>
|
||
The <code>circular_buffer</code> only allocates memory when created, when the capacity is adjusted explicitly, or
|
||
as necessary to accommodate resizing or assign operations. On the other hand, there is also a <code><a href=
|
||
"space_optimized.html">circular_buffer_space_optimized</a></code> available. It is an adaptor of the
|
||
<code>circular_buffer</code> which does not allocate memory at once when created, rather it allocates memory as
|
||
needed.
|
||
</p>
|
||
<h2>
|
||
<a name="briefexample" id="briefexample">Introductory Example</a>
|
||
</h2>
|
||
<p>
|
||
A brief example using the <code>circular_buffer</code>:
|
||
</p>
|
||
<pre>
|
||
#include <boost/circular_buffer.hpp>
|
||
|
||
int main(int /*argc*/, char* /*argv*/[]) {
|
||
|
||
// Create a circular buffer with a capacity for 3 integers.
|
||
boost::circular_buffer<int> cb(3);
|
||
|
||
// Insert some elements into the buffer.
|
||
cb.push_back(1);
|
||
cb.push_back(2);
|
||
cb.push_back(3);
|
||
|
||
int a = cb[0]; // a == 1
|
||
int b = cb[1]; // b == 2
|
||
int c = cb[2]; // c == 3
|
||
|
||
// The buffer is full now, pushing subsequent
|
||
// elements will overwrite the front-most elements.
|
||
|
||
cb.push_back(4); // Overwrite 1 with 4.
|
||
cb.push_back(5); // Overwrite 2 with 5.
|
||
|
||
// The buffer now contains 3, 4 and 5.
|
||
|
||
a = cb[0]; // a == 3
|
||
b = cb[1]; // b == 4
|
||
c = cb[2]; // c == 5
|
||
|
||
// Elements can be popped from either the front or the back.
|
||
|
||
cb.pop_back(); // 5 is removed.
|
||
cb.pop_front(); // 3 is removed.
|
||
|
||
int d = cb[0]; // d == 4
|
||
|
||
return 0;
|
||
}
|
||
</pre>
|
||
<h2>
|
||
<a name="synopsis" id="synopsis">Synopsis</a>
|
||
</h2>
|
||
<div id="srcdoc_synopsis">
|
||
<table id="table_synopsis" border="0" cellpadding="10">
|
||
<tr>
|
||
<td>
|
||
<pre>
|
||
namespace boost {
|
||
|
||
template <class <a href="#templateparam_T">T</a>, class <a href="#templateparam_Alloc">Alloc</a>>
|
||
class circular_buffer
|
||
{
|
||
public:
|
||
typedef typename Alloc::value_type <a href=
|
||
"#classboost_1_1circular__buffer_1cbdd7ca87e147c08cd2be267eefd6540">value_type</a>;
|
||
typedef typename Alloc::pointer <a href=
|
||
"#classboost_1_1circular__buffer_14ff917f8a6131ec18e91606727592a9c">pointer</a>;
|
||
typedef typename Alloc::const_pointer <a href=
|
||
"#classboost_1_1circular__buffer_190f7c6bcb624ad507de546366f49028a">const_pointer</a>;
|
||
typedef typename Alloc::reference <a href=
|
||
"#classboost_1_1circular__buffer_1f38a9bc64d84757c661c2542ff9a7f65">reference</a>;
|
||
typedef typename Alloc::const_reference <a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a>;
|
||
typedef typename Alloc::difference_type <a href=
|
||
"#classboost_1_1circular__buffer_15313e723fa85d73db5826f8b722aa2a9">difference_type</a>;
|
||
typedef typename Alloc::size_type <a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a>;
|
||
typedef Alloc <a href="#classboost_1_1circular__buffer_14e07c6ddfe89debe384e59bed06e7cb7">allocator_type</a>;
|
||
typedef <i>implementation-defined</i> <a href=
|
||
"#classboost_1_1circular__buffer_15cab6d46f03c40d1e52d41843319ddb9">const_iterator</a>;
|
||
typedef <i>implementation-defined</i> <a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a>;
|
||
typedef boost::reverse_iterator<const_iterator> <a href=
|
||
"#classboost_1_1circular__buffer_1c7317701b511bc5f7a663b06b53e2b73">const_reverse_iterator</a>;
|
||
typedef boost::reverse_iterator<iterator> <a href=
|
||
"#classboost_1_1circular__buffer_1002fb890dded89e75dfeb6f021fb58a5">reverse_iterator</a>;
|
||
typedef std::pair<pointer, size_type> <a href=
|
||
"#classboost_1_1circular__buffer_126d279f91fef717e25459a0817ff242f">array_range</a>;
|
||
typedef std::pair<const_pointer, size_type> <a href=
|
||
"#classboost_1_1circular__buffer_11885d7f475b7e7a74c95b2448d243025">const_array_range</a>;
|
||
typedef size_type <a href="#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a>;
|
||
|
||
explicit <a href=
|
||
"#classboost_1_1circular__buffer_1e53e744d2f94a2bcbfcdb219a9d93300">circular_buffer</a>(const allocator_type& alloc = allocator_type());
|
||
explicit <a href=
|
||
"#classboost_1_1circular__buffer_1862a64cbc6a49376ecbb8321c3b44974">circular_buffer</a>(capacity_type capacity, const allocator_type& alloc = allocator_type());
|
||
<a href=
|
||
"#classboost_1_1circular__buffer_1fdace8f110d5b7a17c02020757f06fe8">circular_buffer</a>(size_type n, const_reference item, const allocator_type& alloc = allocator_type());
|
||
<a href=
|
||
"#classboost_1_1circular__buffer_10c7e9286d8270357d7e369b183124239">circular_buffer</a>(capacity_type capacity, size_type n, const_reference item, const allocator_type& alloc = allocator_type());
|
||
<a href=
|
||
"#classboost_1_1circular__buffer_1e515d8a951eeb18b8cc930300e7e13bd">circular_buffer</a>(const circular_buffer<T, Alloc>& cb);
|
||
template <class InputIterator>
|
||
<a href=
|
||
"#classboost_1_1circular__buffer_1744ec06b06a5a723386b645a29cb8ed2">circular_buffer</a>(InputIterator first, InputIterator last, const allocator_type& alloc = allocator_type());
|
||
template <class InputIterator>
|
||
<a href=
|
||
"#classboost_1_1circular__buffer_1a64dcad327971194a706d52487151eb7">circular_buffer</a>(capacity_type capacity, InputIterator first, InputIterator last, const allocator_type& alloc = allocator_type());
|
||
<a href="#classboost_1_1circular__buffer_164250ffbbbdbc62b99e8301fc195b80c">~circular_buffer</a>();
|
||
|
||
allocator_type <a href=
|
||
"#classboost_1_1circular__buffer_15693ba52e58ef90f1d914cbb63143cd3">get_allocator</a>() const;
|
||
allocator_type& <a href="#classboost_1_1circular__buffer_1af7758a36ac2f84a3024b50b4fc7e098">get_allocator</a>();
|
||
iterator <a href="#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin</a>();
|
||
iterator <a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end</a>();
|
||
const_iterator <a href="#classboost_1_1circular__buffer_1ee6c38b2ecdc8dfec79975dbc685c80b">begin</a>() const;
|
||
const_iterator <a href="#classboost_1_1circular__buffer_19813e1d191cd04c4cfc100bbc4733e92">end</a>() const;
|
||
reverse_iterator <a href="#classboost_1_1circular__buffer_1db3d6b10b6763549f54d2627228fa7aa">rbegin</a>();
|
||
reverse_iterator <a href="#classboost_1_1circular__buffer_1cff9236a50107188b8942847a4dc2697">rend</a>();
|
||
const_reverse_iterator <a href=
|
||
"#classboost_1_1circular__buffer_146a8356a1aec6abca9c44cfc60b3bb10">rbegin</a>() const;
|
||
const_reverse_iterator <a href="#classboost_1_1circular__buffer_1a09f7111dde9f52a4d8babfcdef7e798">rend</a>() const;
|
||
reference <a href=
|
||
"#classboost_1_1circular__buffer_1d219f0d3203fb43b964a8cf63f1865cd">operator[]</a>(size_type index);
|
||
const_reference <a href=
|
||
"#classboost_1_1circular__buffer_1eb0a7fe7f8a56a4dc4c933b93adfcef4">operator[]</a>(size_type index) const;
|
||
reference <a href="#classboost_1_1circular__buffer_1cd84838cb4fffb6c113fd0297e502edc">at</a>(size_type index);
|
||
const_reference <a href=
|
||
"#classboost_1_1circular__buffer_1b233a298f5845a0fcf2ecc56f4170810">at</a>(size_type index) const;
|
||
reference <a href="#classboost_1_1circular__buffer_10d5fdeabeb352f47d1f7bb1ea8d9819f">front</a>();
|
||
reference <a href="#classboost_1_1circular__buffer_1d985d974020f88bb4255d8edbae0a30a">back</a>();
|
||
const_reference <a href="#classboost_1_1circular__buffer_13261c47e81bb5e447fb0d70f096728b8">front</a>() const;
|
||
const_reference <a href="#classboost_1_1circular__buffer_14cd3a019a9d99b4e29918b51c2181a07">back</a>() const;
|
||
array_range <a href="#classboost_1_1circular__buffer_1957cccdcb0c4ef7d80a34a990065818d">array_one</a>();
|
||
array_range <a href="#classboost_1_1circular__buffer_1f5081a54afbc2dfc1a7fb20329df7d5b">array_two</a>();
|
||
const_array_range <a href="#classboost_1_1circular__buffer_1586cfbdef335f1d3d31faacec63f7b04">array_one</a>() const;
|
||
const_array_range <a href="#classboost_1_1circular__buffer_191a0e2c33c0e5b4d7b8c497847bc29ce">array_two</a>() const;
|
||
pointer <a href="#classboost_1_1circular__buffer_1ea728bf57f91aa8946eddf76ce816a4e">linearize</a>();
|
||
size_type <a href="#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size</a>() const;
|
||
size_type <a href="#classboost_1_1circular__buffer_195158ed4d4b03794068e259f85291995">max_size</a>() const;
|
||
bool <a href="#classboost_1_1circular__buffer_105acab2b9a0b41044b5241cfc9d87663">empty</a>() const;
|
||
bool <a href="#classboost_1_1circular__buffer_174a305e473c0bba9dcf30abb68bff909">full</a>() const;
|
||
size_type <a href="#classboost_1_1circular__buffer_17e144e8c7acd8e30c08bfb03391a2338">reserve</a>() const;
|
||
capacity_type <a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity</a>() const;
|
||
void <a href=
|
||
"#classboost_1_1circular__buffer_161714204ef5172d156e2c7eccd04998f">set_capacity</a>(capacity_type new_capacity);
|
||
void <a href=
|
||
"#classboost_1_1circular__buffer_180c2e2e66a8fa9d0b7adc1b54921a8c3">resize</a>(size_type new_size, const_reference item = value_type());
|
||
void <a href=
|
||
"#classboost_1_1circular__buffer_1477715e9d31d2cc5b02ad8ecf3c68c46">rset_capacity</a>(capacity_type new_capacity);
|
||
void <a href=
|
||
"#classboost_1_1circular__buffer_144ecd9ec5f54a2d61c7d132e445d3483">rresize</a>(size_type new_size, const_reference item = value_type());
|
||
circular_buffer<T, Alloc>& <a href=
|
||
"#classboost_1_1circular__buffer_1db1558911b2e251a587aeb3d8b3d797d">operator=</a>(const circular_buffer<T, Alloc>& cb);
|
||
void <a href=
|
||
"#classboost_1_1circular__buffer_19ba4a81df16f386d31b04b49c82d1ada">assign</a>(size_type n, const_reference item);
|
||
void <a href=
|
||
"#classboost_1_1circular__buffer_1aa10b4e4ec1f1c5918931b04b31d43ca">assign</a>(capacity_type capacity, size_type n, const_reference item);
|
||
template <class InputIterator>
|
||
void <a href=
|
||
"#classboost_1_1circular__buffer_1253302d9bda5d7efbc4a6c311de3790c">assign</a>(InputIterator first, InputIterator last);
|
||
template <class InputIterator>
|
||
void <a href=
|
||
"#classboost_1_1circular__buffer_11edb80acdf1f7f1df8217d57256e41f6">assign</a>(capacity_type capacity, InputIterator first, InputIterator last);
|
||
void <a href=
|
||
"#classboost_1_1circular__buffer_1270ab7074c365663a6f18808024fd88b">swap</a>(circular_buffer<T, Alloc>& cb);
|
||
void <a href=
|
||
"#classboost_1_1circular__buffer_1aa35dd7ef8eb1d04508494d1835cc82e">push_back</a>(const_reference item = value_type());
|
||
void <a href=
|
||
"#classboost_1_1circular__buffer_10ef57e73c193682a649d8eb4a1096dce">push_front</a>(const_reference item = value_type());
|
||
void <a href="#classboost_1_1circular__buffer_1df0da00cb501bea75afbbfab9f546a07">pop_back</a>();
|
||
void <a href="#classboost_1_1circular__buffer_18ac972dc24ef7236faa1875de92b9dd8">pop_front</a>();
|
||
iterator <a href=
|
||
"#classboost_1_1circular__buffer_128c92740fee1b9deb8c69816e389de95">insert</a>(iterator pos, const_reference item = value_type());
|
||
void <a href=
|
||
"#classboost_1_1circular__buffer_1b2f197c99d47138db777f0a46783b140">insert</a>(iterator pos, size_type n, const_reference item);
|
||
template <class InputIterator>
|
||
void <a href=
|
||
"#classboost_1_1circular__buffer_1d00091d1d794cab3264b3674e99b33f6">insert</a>(iterator pos, InputIterator first, InputIterator last);
|
||
iterator <a href=
|
||
"#classboost_1_1circular__buffer_12c9332f457bf5bb3128463cf528c058c">rinsert</a>(iterator pos, const_reference item = value_type());
|
||
void <a href=
|
||
"#classboost_1_1circular__buffer_1a47a5358db1b7d7e4925c16db13d2fc5">rinsert</a>(iterator pos, size_type n, const_reference item);
|
||
template <class InputIterator>
|
||
void <a href=
|
||
"#classboost_1_1circular__buffer_1d6479cbc43a304bdbf04262f957fa323">rinsert</a>(iterator pos, InputIterator first, InputIterator last);
|
||
iterator <a href="#classboost_1_1circular__buffer_197155de712db1759e1698455b49a0be3">erase</a>(iterator pos);
|
||
iterator <a href=
|
||
"#classboost_1_1circular__buffer_1a96415389509a18bd7d7b5d8e4dda9bd">erase</a>(iterator first, iterator last);
|
||
iterator <a href="#classboost_1_1circular__buffer_1b6d4ae77d7445f844e30e78592f1e06f">rerase</a>(iterator pos);
|
||
iterator <a href=
|
||
"#classboost_1_1circular__buffer_1b0f98ae303584ded5397f067bbfc911f">rerase</a>(iterator first, iterator last);
|
||
void <a href="#classboost_1_1circular__buffer_1826f5770a40b8b752eb9587378464d1e">clear</a>();
|
||
};
|
||
|
||
template <class T, class Alloc>
|
||
bool <a href=
|
||
"#namespaceboost_1d35871e838359b5215e1cbb353663207">operator==</a>(const circular_buffer<T, Alloc>& lhs, const circular_buffer<T, Alloc>& rhs);
|
||
template <class T, class Alloc>
|
||
bool <a href=
|
||
"#namespaceboost_195b08213f201c2067d8acb024756329d">operator<</a>(const circular_buffer<T, Alloc>& lhs, const circular_buffer<T, Alloc>& rhs);
|
||
template <class T, class Alloc>
|
||
bool <a href=
|
||
"#namespaceboost_1f5717e2f6532581a6492ff1839b18f6d">operator!=</a>(const circular_buffer<T, Alloc>& lhs, const circular_buffer<T, Alloc>& rhs);
|
||
template <class T, class Alloc>
|
||
bool <a href=
|
||
"#namespaceboost_1f575d7a9741c2044424de50c966c12f3">operator></a>(const circular_buffer<T, Alloc>& lhs, const circular_buffer<T, Alloc>& rhs);
|
||
template <class T, class Alloc>
|
||
bool <a href=
|
||
"#namespaceboost_179abcbacd24b67f08185db54aec8600d">operator<=</a>(const circular_buffer<T, Alloc>& lhs, const circular_buffer<T, Alloc>& rhs);
|
||
template <class T, class Alloc>
|
||
bool <a href=
|
||
"#namespaceboost_11c31150380272af67deebef578c80b05">operator>=</a>(const circular_buffer<T, Alloc>& lhs, const circular_buffer<T, Alloc>& rhs);
|
||
template <class T, class Alloc>
|
||
void <a href=
|
||
"#namespaceboost_14aa8f6a2c9640f3f22e266f0fca85777">swap</a>(circular_buffer<T, Alloc>& lhs, circular_buffer<T, Alloc>& rhs);
|
||
|
||
} // namespace boost
|
||
</pre>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<h2>
|
||
<a name="rationale" id="rationale">Rationale</a>
|
||
</h2>
|
||
<p>
|
||
The basic motivation behind the <code>circular_buffer</code> was to create a container which would work
|
||
seamlessly with STL. Additionally, the design of the <code>circular_buffer</code> was guided by the following
|
||
principles:
|
||
</p>
|
||
<ol>
|
||
<li>Maximum <em>efficiency</em> for envisaged applications.
|
||
</li>
|
||
<li>Suitable for <em>general purpose</em> use.
|
||
</li>
|
||
<li>The behaviour of the buffer as <em>intuitive</em> as possible.
|
||
</li>
|
||
<li>Suitable for <em>specialization</em> by means of adaptors. (The <code><a href=
|
||
"space_optimized.html">circular_buffer_space_optimized</a></code> is such an example of the adaptor.)
|
||
</li>
|
||
<li>Easy to <em>debug</em>. (See <a href="#debug">Debug Support</a> for details.)
|
||
</li>
|
||
</ol>
|
||
<p>
|
||
In order to achieve maximum efficiency, the <code>circular_buffer</code> stores its elements in a <em>contiguous
|
||
region of memory</em>, which then enables:
|
||
</p>
|
||
<ol>
|
||
<li>Use of fixed memory and no implicit or unexpected memory allocation.
|
||
</li>
|
||
<li>Fast constant-time insertion and removal of elements from the front and back.
|
||
</li>
|
||
<li>Fast constant-time random access of elements.
|
||
</li>
|
||
<li>Suitability for real-time and performance critical applications.
|
||
</li>
|
||
</ol>
|
||
<p>
|
||
Possible applications of the <code>circular_buffer</code> include:
|
||
</p>
|
||
<ul>
|
||
<li>Storage of the most recently received samples, overwriting the oldest as new samples arrive.
|
||
</li>
|
||
<li>As an underlying container for a <i>bounded buffer</i> (see the <a href="#boundedbuffer">Bounded Buffer
|
||
Example</a>).
|
||
</li>
|
||
<li>A kind of cache storing a specified number of last inserted elements.
|
||
</li>
|
||
<li>Efficient fixed capacity FIFO (First In, First Out) or LIFO (Last In, First Out) queue which removes the
|
||
oldest (inserted as first) elements when full.
|
||
</li>
|
||
</ul>
|
||
<p>
|
||
The following paragraphs describe issues that had to be considered during the implementation of the
|
||
<code>circular_buffer</code>:
|
||
</p>
|
||
<h4>
|
||
<a name="threadsafety" id="threadsafety">Thread-Safety</a>
|
||
</h4>
|
||
<p>
|
||
The thread-safety of the <code>circular_buffer</code> is the same as the thread-safety of containers in most STL
|
||
implementations. This means the <code>circular_buffer</code> is <b>not</b> thread-safe. The thread-safety is
|
||
guarantied only in the sense that simultaneous accesses to <b>distinct</b> instances of the
|
||
<code>circular_buffer</code> are safe, and simultaneous read accesses to a shared <code>circular_buffer</code>
|
||
are safe.
|
||
</p>
|
||
<p>
|
||
If multiple threads access a single <code>circular_buffer</code>, and at least one of the threads may potentially
|
||
write, then the user is responsible for ensuring mutual exclusion between the threads during the container
|
||
accesses. The mutual exclusion between the threads can be achieved by wrapping operations of the underlying
|
||
<code>circular_buffer</code> with a lock acquisition and release. (See the <a href="#boundedbuffer">Bounded
|
||
Buffer Example</a>.)
|
||
</p>
|
||
<h4>
|
||
<a name="overwrite" id="overwrite">Overwrite Operation</a>
|
||
</h4>
|
||
<p>
|
||
Overwrite operation occurs when an element is inserted into a full <code>circular_buffer</code> - the old element
|
||
is being overwritten by the new one. There was a discussion what exactly "overwriting of an element" means during
|
||
the formal review. It may be either a destruction of the original element and a consequent inplace construction
|
||
of a new element or it may be an assignment of a new element into an old one. The <code>circular_buffer</code>
|
||
implements <b>assignment</b> because it is more effective.
|
||
</p>
|
||
<p>
|
||
From the point of business logic of a stored element, the destruction/construction operation and assignment
|
||
usually mean the same. However, in very rare cases (if in any) they may differ. If there is a requirement for
|
||
elements to be destructed/constructed instead of being assigned, consider implementing a wrapper of the element
|
||
which would implement the assign operator, and store the wrappers instead. It is necessary to note that storing
|
||
such wrappers has a drawback. The destruction/construction will be invoked on every assignment of the wrapper -
|
||
not only when a wrapper is being overwritten (when the buffer is full) but also when the stored wrappers are
|
||
being shifted (e.g. as a result of insertion into the middle of container).
|
||
</p>
|
||
<h4>
|
||
<a name="fullbuffer" id="fullbuffer">Writing to a Full Buffer</a>
|
||
</h4>
|
||
<p>
|
||
There are several options how to cope with the case if a data source produces more data than can fit in the
|
||
fixed-sized buffer:
|
||
</p>
|
||
<ol>
|
||
<li>Inform the data source to wait until there is room in the buffer (e.g. by throwing an overflow exception).
|
||
</li>
|
||
<li>If the oldest data is the most important, ignore new data from the source until there is room in the buffer
|
||
again.
|
||
</li>
|
||
<li>If the latest data is the most important, write over the oldest data.
|
||
</li>
|
||
<li>Let the producer to be responsible for checking the size of the buffer prior writing into it.
|
||
</li>
|
||
</ol>
|
||
<p>
|
||
It is apparent that the <code>circular_buffer</code> implements the third option. But it may be less apparent it
|
||
<b>does not</b> implement any other option - especially the first two. One can get an impression that the
|
||
<code>circular_buffer</code> should implement first three options and offer a mechanism of choosing among them.
|
||
This impression is wrong. The <code>circular_buffer</code> was designed and optimized to be circular (which means
|
||
overwriting the oldest data when full). If such a controlling mechanism had been enabled, it would just
|
||
complicate the matters and the usage of the <code>circular_buffer</code> would be probably less straightforward.
|
||
</p>
|
||
<p>
|
||
Moreover, the first two options (and the fourth option as well) do not require the buffer to be circular at all.
|
||
If there is a need for the first or second option, consider implementing an adaptor of e.g.
|
||
<code>std::vector</code>. In this case the <code>circular_buffer</code> is not suitable for adapting, because, in
|
||
contrary to <code>std::vector</code>, it bears an overhead for its circular behaviour.
|
||
</p>
|
||
<h4>
|
||
<a name="emptybuffer" id="emptybuffer">Reading/Removing from an Empty Buffer</a>
|
||
</h4>
|
||
<p>
|
||
When reading or removing an element from an empty buffer, the buffer should be able to notify the data consumer
|
||
(e.g. by throwing underflow exception) that there are no elements stored in it. The <code>circular_buffer</code>
|
||
does not implement such a behaviour for two reasons:
|
||
</p>
|
||
<ol>
|
||
<li>It would introduce performance overhead.
|
||
</li>
|
||
<li>No other <code>std</code> container implements it this way.
|
||
</li>
|
||
</ol>
|
||
<p>
|
||
It is considered to be a bug to read or remove an element (e.g. by calling <code>front()</code> or
|
||
<code>pop_back()</code>) from an empty <code>std</code> container and from an empty <code>circular_buffer</code>
|
||
as well. The data consumer has to test if the container is not empty before reading/removing from it. However,
|
||
when reading from the <code>circular_buffer</code>, there is an option to rely on the <code>at()</code> method
|
||
which throws an exception when the index is out of range.
|
||
</p>
|
||
<h4>
|
||
<a name="iteratorinvalidation" id="iteratorinvalidation">Iterator Invalidation</a>
|
||
</h4>
|
||
<p>
|
||
An iterator is usually considered to be invalidated if an element, the iterator pointed to, had been removed or
|
||
overwritten by an another element. This definition is enforced by the <a href="#debug">Debug Support</a> and is
|
||
documented for every method. However, some applications utilizing <code>circular_buffer</code> may require less
|
||
strict definition: an iterator is invalid only if it points to an uninitialized memory. Consider following
|
||
example:
|
||
</p>
|
||
<pre>
|
||
#define BOOST_CB_DISABLE_DEBUG // The Debug Support has to be disabled, otherwise the code produces a runtime error.
|
||
|
||
#include <boost/circular_buffer.hpp>
|
||
#include <assert.h>
|
||
|
||
int main(int /*argc*/, char* /*argv*/[]) {
|
||
|
||
boost::circular_buffer<int> cb(3);
|
||
|
||
cb.push_back(1);
|
||
cb.push_back(2);
|
||
cb.push_back(3);
|
||
|
||
boost::circular_buffer<int>::iterator it = cb.begin();
|
||
|
||
assert(*it == 1);
|
||
|
||
cb.push_back(4);
|
||
|
||
assert(*it == 4); // The iterator still points to the initialized memory.
|
||
|
||
return 0;
|
||
}
|
||
</pre>
|
||
<p>
|
||
The iterator does not point to the original element any more (and is considered to be invalid from the "strict"
|
||
point of view) but it still points to the same <em>valid</em> place in the memory. This "soft" definition of
|
||
iterator invalidation is supported by the <code>circular_buffer</code> but should be considered as an
|
||
implementation detail rather than a full-fledged feature. The rules when the iterator is still valid can be
|
||
inferred from the code in <code><a href=
|
||
"../test/soft_iterator_invalidation.cpp">soft_iterator_invalidation.cpp</a></code>.
|
||
</p>
|
||
<h2>
|
||
<a name="caveats" id="caveats">Caveats</a>
|
||
</h2>
|
||
<p>
|
||
The <code>circular_buffer</code> should not be used for storing pointers to dynamically allocated objects. When a
|
||
<code>circular_buffer</code> becomes full, further insertion will overwrite the stored pointers - resulting in a
|
||
<b>memory leak</b>. One recommend alternative is the use of smart pointers <a href="#note1">[1]</a>. (Any
|
||
container of <code>std::auto_ptr</code> is considered particularly hazardous. <a href="#note2">[2]</a> )
|
||
</p>
|
||
<p>
|
||
While internals of a <code>circular_buffer</code> are circular, iterators are <b>not</b>. Iterators of a
|
||
<code>circular_buffer</code> are only valid for the range <code>[begin(), end()]</code>. E.g. iterators
|
||
<code>(begin() - 1)</code> and <code>(end() + 1)</code> are invalid.
|
||
</p>
|
||
<h2>
|
||
<a name="debug" id="debug">Debug Support</a>
|
||
</h2>
|
||
<p>
|
||
In order to help a programmer to avoid and find common bugs, the <code>circular_buffer</code> contains a kind of
|
||
debug support.
|
||
</p>
|
||
<p>
|
||
The <code>circular_buffer</code> maintains a list of valid iterators. As soon as any element gets destroyed all
|
||
iterators pointing to this element are removed from this list and explicitly invalidated (an invalidation flag is
|
||
set). The debug support also consists of many assertions (<a href=
|
||
"../../utility/assert.html"><code>BOOST_ASSERT</code></a> macros) which ensure the <code>circular_buffer</code>
|
||
and its iterators are used in the correct manner at runtime. In case an invalid iterator is used the assertion
|
||
will report an error. The connection of explicit iterator invalidation and assertions makes a very robust debug
|
||
technique which catches most of the errors.
|
||
</p>
|
||
<p>
|
||
Moreover, the uninitialized memory allocated by <code>circular_buffer</code> is filled with the value
|
||
<code>0xcc</code> in the debug mode. This can help the programmer when debugging the code to recognize the
|
||
initialized memory from the uninitialized. For details refer the source code.
|
||
</p>
|
||
<p>
|
||
The debug support is enabled only in the debug mode (when the <code>NDEBUG</code> is not defined). It can also be
|
||
explicitly disabled by defining <code>BOOST_CB_DISABLE_DEBUG</code> macro.
|
||
</p>
|
||
<h2>
|
||
<a name="examples" id="examples">More Examples</a>
|
||
</h2>
|
||
<p>
|
||
The following example includes various usage of the <code>circular_buffer</code>.
|
||
</p>
|
||
<pre>
|
||
#include <boost/circular_buffer.hpp>
|
||
#include <numeric>
|
||
#include <assert.h>
|
||
|
||
int main(int /*argc*/, char* /*argv*/[])
|
||
{
|
||
// create a circular buffer of capacity 3
|
||
boost::circular_buffer<int> cb(3);
|
||
|
||
// insert some elements into the circular buffer
|
||
cb.push_back(1);
|
||
cb.push_back(2);
|
||
|
||
// assertions
|
||
assert(cb[0] == 1);
|
||
assert(cb[1] == 2);
|
||
assert(!cb.full());
|
||
assert(cb.size() == 2);
|
||
assert(cb.capacity() == 3);
|
||
|
||
// insert some other elements
|
||
cb.push_back(3);
|
||
cb.push_back(4);
|
||
|
||
// evaluate the sum
|
||
int sum = std::accumulate(cb.begin(), cb.end(), 0);
|
||
|
||
// assertions
|
||
assert(cb[0] == 2);
|
||
assert(cb[1] == 3);
|
||
assert(cb[2] == 4);
|
||
assert(*cb.begin() == 2);
|
||
assert(cb.front() == 2);
|
||
assert(cb.back() == 4);
|
||
assert(sum == 9);
|
||
assert(cb.full());
|
||
assert(cb.size() == 3);
|
||
assert(cb.capacity() == 3);
|
||
|
||
return 0;
|
||
}
|
||
</pre>
|
||
<p>
|
||
The <code>circular_buffer</code> has a capacity of three <code>int</code>. Therefore, the size of the buffer will
|
||
not exceed three. The <code><a href="http://www.sgi.com/tech/stl/accumulate.html">accumulate</a></code> algorithm
|
||
evaluates the sum of the stored elements. The semantics of the <code>circular_buffer</code> can be inferred from
|
||
the assertions.
|
||
</p>
|
||
<h4>
|
||
<a name="boundedbuffer" id="boundedbuffer">Bounded Buffer Example</a>
|
||
</h4>
|
||
<p>
|
||
The bounded buffer is normally used in a producer-consumer mode when producer threads produce items and store
|
||
them in the container and consumer threads remove these items and process them. The bounded buffer has to
|
||
guarantee that producers do not insert items into the container when the container is full, that consumers do not
|
||
try to remove items when the container is empty, and that each produced item is consumed by exactly one consumer.
|
||
</p>
|
||
<p>
|
||
The example below shows how the <code>circular_buffer</code> can be utilized as an underlying container of the
|
||
bounded buffer.
|
||
</p>
|
||
<pre>
|
||
#include <boost/circular_buffer.hpp>
|
||
#include <boost/thread/mutex.hpp>
|
||
#include <boost/thread/condition.hpp>
|
||
#include <boost/thread/thread.hpp>
|
||
#include <boost/progress.hpp>
|
||
#include <boost/bind.hpp>
|
||
|
||
template <class T>
|
||
class bounded_buffer {
|
||
public:
|
||
|
||
typedef boost::circular_buffer<T> container_type;
|
||
typedef typename container_type::size_type size_type;
|
||
typedef typename container_type::value_type value_type;
|
||
|
||
explicit bounded_buffer(size_type capacity) : m_unread(0), m_container(capacity) {}
|
||
|
||
void push_front(const value_type& item) {
|
||
boost::mutex::scoped_lock lock(m_mutex);
|
||
m_not_full.wait(lock, boost::bind(&bounded_buffer<value_type>::is_not_full, this));
|
||
m_container.push_front(item);
|
||
++m_unread;
|
||
lock.unlock();
|
||
m_not_empty.notify_one();
|
||
}
|
||
|
||
void pop_back(value_type* pItem) {
|
||
boost::mutex::scoped_lock lock(m_mutex);
|
||
m_not_empty.wait(lock, boost::bind(&bounded_buffer<value_type>::is_not_empty, this));
|
||
*pItem = m_container[--m_unread];
|
||
lock.unlock();
|
||
m_not_full.notify_one();
|
||
}
|
||
|
||
private:
|
||
bounded_buffer(const bounded_buffer&); // Disabled copy constructor
|
||
bounded_buffer& operator = (const bounded_buffer&); // Disabled assign operator
|
||
|
||
bool is_not_empty() const { return m_unread > 0; }
|
||
bool is_not_full() const { return m_unread < m_container.capacity(); }
|
||
|
||
size_type m_unread;
|
||
container_type m_container;
|
||
boost::mutex m_mutex;
|
||
boost::condition m_not_empty;
|
||
boost::condition m_not_full;
|
||
};
|
||
</pre>
|
||
<p>
|
||
The <code>bounded_buffer</code> uses <a href="../../thread/doc/">Boost Threads</a> and <a href=
|
||
"../../bind/bind.html">Boost Bind</a> libraries.
|
||
</p>
|
||
<p>
|
||
The <code>push_front()</code> method is called by the producer thread in order to insert a new item into the
|
||
buffer. The method locks the mutex and waits until there is a space for the new item. (The mutex is unlocked
|
||
during the waiting stage and has to be regained when the condition is met.) If there is a space in the buffer
|
||
available, the execution continues and the method inserts the item at the end of the
|
||
<code>circular_buffer</code>. Then it increments the number of unread items and unlocks the mutex (in case an
|
||
exception is thrown before the mutex is unlocked, the mutex is unlocked automatically by the destructor of the
|
||
<code>scoped_lock</code>). At last the method notifies one of the consumer threads waiting for a new item to be
|
||
inserted into the buffer.
|
||
</p>
|
||
<p>
|
||
The <code>pop_back()</code> method is called by the consumer thread in order to read the next item from the
|
||
buffer. The method locks the mutex and waits until there is an unread item in the buffer. If there is at least
|
||
one unread item, the method decrements the number of unread items and reads the next item from the
|
||
<code>circular_buffer</code>. Then it unlocks the mutex and notifies one of the producer threads waiting for the
|
||
buffer to free a space for the next item.
|
||
</p>
|
||
<p>
|
||
The <code>pop_back()</code> method does not remove the item but the item is left in the
|
||
<code>circular_buffer</code> which then replaces it with a new one (inserted by a producer) when the
|
||
<code>circular_buffer</code> is full. This technique is more effective than removing the item explicitly by
|
||
calling the <code>pop_back()</code> method of the <code>circular_buffer</code>. This claim is based on the
|
||
assumption that an assignment (replacement) of a new item into an old one is more effective than a destruction
|
||
(removal) of an old item and a consequent inplace construction (insertion) of a new item.
|
||
</p>
|
||
<p>
|
||
For comparison of bounded buffers based on different containers compile and run <a href=
|
||
"../test/bounded_buffer_comparison.cpp">bounded_buffer_comparison.cpp</a>. The test should reveal the bounded
|
||
buffer based on the <code>circular_buffer</code> is most effective closely followed by the
|
||
<code>std::deque</code> based bounded buffer. (In praxis the result may be different because the test is affected
|
||
by external factors such as immediate CPU load.)
|
||
</p>
|
||
<h2>
|
||
<a name="header" id="header">Header Files</a>
|
||
</h2>
|
||
<p>
|
||
The <code>circular_buffer</code> is defined in the file <code><a href=
|
||
"../../../boost/circular_buffer.hpp">boost/circular_buffer.hpp</a></code>. There is also a forward declaration
|
||
for the <code>circular_buffer</code> in the header file <code><a href=
|
||
"../../../boost/circular_buffer_fwd.hpp">boost/circular_buffer_fwd.hpp</a></code>.
|
||
</p>
|
||
<h2>
|
||
<a name="model" id="model">Modelled Concepts</a>
|
||
</h2>
|
||
<p>
|
||
<a href="http://www.sgi.com/tech/stl/RandomAccessContainer.html">Random Access Container</a>, <a href=
|
||
"http://www.sgi.com/tech/stl/FrontInsertionSequence.html">Front Insertion Sequence</a> and <a href=
|
||
"http://www.sgi.com/tech/stl/BackInsertionSequence.html">Back Insertion Sequence</a>.
|
||
</p>
|
||
<h2>
|
||
<a name="parameters" id="parameters">Template Parameters</a>
|
||
</h2>
|
||
<div id="srcdoc_params">
|
||
<table id="table_template_params" border="1" cellpadding="3">
|
||
<tr>
|
||
<th>
|
||
Parameter
|
||
</th>
|
||
<th>
|
||
Description
|
||
</th>
|
||
<th>
|
||
Default
|
||
</th>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<h2>
|
||
<a name="types" id="types">Public Types</a>
|
||
</h2>
|
||
<div id="srcdoc_types">
|
||
<table id="table_public_types" border="1" cellpadding="3">
|
||
<tr>
|
||
<th>
|
||
Type
|
||
</th>
|
||
<th>
|
||
Description
|
||
</th>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1cbdd7ca87e147c08cd2be267eefd6540" name=
|
||
"classboost_1_1circular__buffer_1cbdd7ca87e147c08cd2be267eefd6540"><code>value_type</code></a>
|
||
</td>
|
||
<td>
|
||
The type of elements stored in the <code>circular_buffer</code>.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_14ff917f8a6131ec18e91606727592a9c" name=
|
||
"classboost_1_1circular__buffer_14ff917f8a6131ec18e91606727592a9c"><code>pointer</code></a>
|
||
</td>
|
||
<td>
|
||
A pointer to an element.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_190f7c6bcb624ad507de546366f49028a" name=
|
||
"classboost_1_1circular__buffer_190f7c6bcb624ad507de546366f49028a"><code>const_pointer</code></a>
|
||
</td>
|
||
<td>
|
||
A const pointer to the element.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1f38a9bc64d84757c661c2542ff9a7f65" name=
|
||
"classboost_1_1circular__buffer_1f38a9bc64d84757c661c2542ff9a7f65"><code>reference</code></a>
|
||
</td>
|
||
<td>
|
||
A reference to an element.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910" name=
|
||
"classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910"><code>const_reference</code></a>
|
||
</td>
|
||
<td>
|
||
A const reference to an element.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_15313e723fa85d73db5826f8b722aa2a9" name=
|
||
"classboost_1_1circular__buffer_15313e723fa85d73db5826f8b722aa2a9"><code>difference_type</code></a>
|
||
</td>
|
||
<td>
|
||
The distance type. (A signed integral type used to represent the distance between two iterators.)
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00" name=
|
||
"classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00"><code>size_type</code></a>
|
||
</td>
|
||
<td>
|
||
The size type. (An unsigned integral type that can represent any non-negative value of the container's
|
||
distance type.)
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_14e07c6ddfe89debe384e59bed06e7cb7" name=
|
||
"classboost_1_1circular__buffer_14e07c6ddfe89debe384e59bed06e7cb7"><code>allocator_type</code></a>
|
||
</td>
|
||
<td>
|
||
The type of an allocator used in the <code>circular_buffer</code>.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_15cab6d46f03c40d1e52d41843319ddb9" name=
|
||
"classboost_1_1circular__buffer_15cab6d46f03c40d1e52d41843319ddb9"><code>const_iterator</code></a>
|
||
</td>
|
||
<td>
|
||
A const (random access) iterator used to iterate through the <code>circular_buffer</code>.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532" name=
|
||
"classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532"><code>iterator</code></a>
|
||
</td>
|
||
<td>
|
||
A (random access) iterator used to iterate through the <code>circular_buffer</code>.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1c7317701b511bc5f7a663b06b53e2b73" name=
|
||
"classboost_1_1circular__buffer_1c7317701b511bc5f7a663b06b53e2b73"><code>const_reverse_iterator</code></a>
|
||
</td>
|
||
<td>
|
||
A const iterator used to iterate backwards through a <code>circular_buffer</code>.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1002fb890dded89e75dfeb6f021fb58a5" name=
|
||
"classboost_1_1circular__buffer_1002fb890dded89e75dfeb6f021fb58a5"><code>reverse_iterator</code></a>
|
||
</td>
|
||
<td>
|
||
An iterator used to iterate backwards through a <code>circular_buffer</code>.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_126d279f91fef717e25459a0817ff242f" name=
|
||
"classboost_1_1circular__buffer_126d279f91fef717e25459a0817ff242f"><code>array_range</code></a>
|
||
</td>
|
||
<td>
|
||
An array range. (A typedef for the <a href=
|
||
"http://www.sgi.com/tech/stl/pair.html"><code>std::pair</code></a> where its first element is a pointer to
|
||
a beginning of an array and its second element represents a size of the array.)
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_11885d7f475b7e7a74c95b2448d243025" name=
|
||
"classboost_1_1circular__buffer_11885d7f475b7e7a74c95b2448d243025"><code>const_array_range</code></a>
|
||
</td>
|
||
<td>
|
||
A range of a const array. (A typedef for the <a href=
|
||
"http://www.sgi.com/tech/stl/pair.html"><code>std::pair</code></a> where its first element is a pointer to
|
||
a beginning of a const array and its second element represents a size of the const array.)
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595" name=
|
||
"classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595"><code>capacity_type</code></a>
|
||
</td>
|
||
<td>
|
||
The capacity type. (Same as <code>size_type</code> - defined for consistency with the <a href=
|
||
"space_optimized.html"><code>circular_buffer_space_optimized</code></a>.)
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<h2>
|
||
<a name="constructors" id="constructors">Constructors and Destructor</a>
|
||
</h2>
|
||
<div id="srcdoc_constructors">
|
||
<table id="table_constructors" border="1" cellpadding="3">
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1e53e744d2f94a2bcbfcdb219a9d93300" name=
|
||
"classboost_1_1circular__buffer_1e53e744d2f94a2bcbfcdb219a9d93300"></a><code><b>explicit
|
||
circular_buffer(const <a href=
|
||
"#classboost_1_1circular__buffer_14e07c6ddfe89debe384e59bed06e7cb7">allocator_type</a>& alloc =
|
||
allocator_type());</b></code><br>
|
||
<br>
|
||
Create an empty <code>circular_buffer</code> with a maximum capacity.
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a> ==
|
||
<a href="#classboost_1_1circular__buffer_195158ed4d4b03794068e259f85291995">max_size()</a> &&
|
||
<a href="#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> == 0</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>alloc</code>
|
||
</dt>
|
||
<dd>
|
||
The allocator.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Warning:</b>
|
||
</dt>
|
||
<dd>
|
||
This constructor has been defined only due to compatibility with the STL container definition. Avoid
|
||
using it because it may allocate <b>very large</b> amount of memory.
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1862a64cbc6a49376ecbb8321c3b44974" name=
|
||
"classboost_1_1circular__buffer_1862a64cbc6a49376ecbb8321c3b44974"></a><code><b>explicit
|
||
circular_buffer(<a href=
|
||
"#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a> capacity, const
|
||
<a href="#classboost_1_1circular__buffer_14e07c6ddfe89debe384e59bed06e7cb7">allocator_type</a>& alloc =
|
||
allocator_type());</b></code><br>
|
||
<br>
|
||
Create an empty <code>circular_buffer</code> with the specified capacity.
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a> ==
|
||
capacity && <a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> == 0</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>capacity</code>
|
||
</dt>
|
||
<dd>
|
||
The maximum number of elements which can be stored in the <code>circular_buffer</code>.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>alloc</code>
|
||
</dt>
|
||
<dd>
|
||
The allocator.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant.
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1fdace8f110d5b7a17c02020757f06fe8" name=
|
||
"classboost_1_1circular__buffer_1fdace8f110d5b7a17c02020757f06fe8"></a><code><b>circular_buffer(<a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> n, <a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a> item, const
|
||
<a href="#classboost_1_1circular__buffer_14e07c6ddfe89debe384e59bed06e7cb7">allocator_type</a>& alloc =
|
||
allocator_type());</b></code><br>
|
||
<br>
|
||
Create a full <code>circular_buffer</code> with the specified capacity and filled with <code>n</code>
|
||
copies of <code>item</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a> == n
|
||
&& <a href="#classboost_1_1circular__buffer_174a305e473c0bba9dcf30abb68bff909">full()</a>
|
||
&& (*this)[0] == item && (*this)[1] == item && ... && (*this)[n - 1] ==
|
||
item</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>n</code>
|
||
</dt>
|
||
<dd>
|
||
The number of elements the created <code>circular_buffer</code> will be filled with.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>item</code>
|
||
</dt>
|
||
<dd>
|
||
The element the created <code>circular_buffer</code> will be filled with.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>alloc</code>
|
||
</dt>
|
||
<dd>
|
||
The allocator.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the <code>n</code>).
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_10c7e9286d8270357d7e369b183124239" name=
|
||
"classboost_1_1circular__buffer_10c7e9286d8270357d7e369b183124239"></a><code><b>circular_buffer(<a href=
|
||
"#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a> capacity, <a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> n, <a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a> item, const
|
||
<a href="#classboost_1_1circular__buffer_14e07c6ddfe89debe384e59bed06e7cb7">allocator_type</a>& alloc =
|
||
allocator_type());</b></code><br>
|
||
<br>
|
||
Create a <code>circular_buffer</code> with the specified capacity and filled with <code>n</code> copies of
|
||
<code>item</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>capacity >= n</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a> ==
|
||
capacity && <a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> == n &&
|
||
(*this)[0] == item && (*this)[1] == item && ... && (*this)[n - 1] ==
|
||
item</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>capacity</code>
|
||
</dt>
|
||
<dd>
|
||
The capacity of the created <code>circular_buffer</code>.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>n</code>
|
||
</dt>
|
||
<dd>
|
||
The number of elements the created <code>circular_buffer</code> will be filled with.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>item</code>
|
||
</dt>
|
||
<dd>
|
||
The element the created <code>circular_buffer</code> will be filled with.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>alloc</code>
|
||
</dt>
|
||
<dd>
|
||
The allocator.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the <code>n</code>).
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1e515d8a951eeb18b8cc930300e7e13bd" name=
|
||
"classboost_1_1circular__buffer_1e515d8a951eeb18b8cc930300e7e13bd"></a><code><b>circular_buffer(const
|
||
circular_buffer<T,Alloc>& cb);</b></code><br>
|
||
<br>
|
||
The copy constructor.
|
||
<p>
|
||
Creates a copy of the specified <code>circular_buffer</code>.
|
||
</p>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>*this == cb</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>cb</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> to be copied.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the size of <code>cb</code>).
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1744ec06b06a5a723386b645a29cb8ed2" name=
|
||
"classboost_1_1circular__buffer_1744ec06b06a5a723386b645a29cb8ed2"></a> <code><b>template <class
|
||
InputIterator><br>
|
||
circular_buffer(InputIterator first, InputIterator last, const <a href=
|
||
"#classboost_1_1circular__buffer_14e07c6ddfe89debe384e59bed06e7cb7">allocator_type</a>& alloc =
|
||
allocator_type());</b></code><br>
|
||
<br>
|
||
Create a full <code>circular_buffer</code> filled with a copy of the range.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
Valid range <code>[first, last)</code>.<br>
|
||
<code>first</code> and <code>last</code> have to meet the requirements of <a href=
|
||
"http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a> ==
|
||
std::distance(first, last) && <a href=
|
||
"#classboost_1_1circular__buffer_174a305e473c0bba9dcf30abb68bff909">full()</a> && (*this)[0]==
|
||
*first && (*this)[1] == *(first + 1) && ... && (*this)[std::distance(first,
|
||
last) - 1] == *(last - 1)</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>first</code>
|
||
</dt>
|
||
<dd>
|
||
The beginning of the range to be copied.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>last</code>
|
||
</dt>
|
||
<dd>
|
||
The end of the range to be copied.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>alloc</code>
|
||
</dt>
|
||
<dd>
|
||
The allocator.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the <code>std::distance(first, last)</code>).
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1a64dcad327971194a706d52487151eb7" name=
|
||
"classboost_1_1circular__buffer_1a64dcad327971194a706d52487151eb7"></a> <code><b>template <class
|
||
InputIterator><br>
|
||
circular_buffer(<a href=
|
||
"#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a> capacity,
|
||
InputIterator first, InputIterator last, const <a href=
|
||
"#classboost_1_1circular__buffer_14e07c6ddfe89debe384e59bed06e7cb7">allocator_type</a>& alloc =
|
||
allocator_type());</b></code><br>
|
||
<br>
|
||
Create a <code>circular_buffer</code> with the specified capacity and filled with a copy of the range.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
Valid range <code>[first, last)</code>.<br>
|
||
<code>first</code> and <code>last</code> have to meet the requirements of <a href=
|
||
"http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a> ==
|
||
capacity && <a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> <=
|
||
std::distance(first, last) && (*this)[0]== *(last - capacity) && (*this)[1] == *(last -
|
||
capacity + 1) && ... && (*this)[capacity - 1] == *(last - 1)</code><br>
|
||
<br>
|
||
If the number of items to be copied from the range <code>[first, last)</code> is greater than the
|
||
specified <code>capacity</code> then only elements from the range <code>[last - capacity, last)</code>
|
||
will be copied.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>capacity</code>
|
||
</dt>
|
||
<dd>
|
||
The capacity of the created <code>circular_buffer</code>.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>first</code>
|
||
</dt>
|
||
<dd>
|
||
The beginning of the range to be copied.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>last</code>
|
||
</dt>
|
||
<dd>
|
||
The end of the range to be copied.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>alloc</code>
|
||
</dt>
|
||
<dd>
|
||
The allocator.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in <code>std::distance(first, last)</code>; in <code>min[capacity, std::distance(first,
|
||
last)]</code> if the <code>InputIterator</code> is a <a href=
|
||
"http://www.sgi.com/tech/stl/RandomAccessIterator.html">RandomAccessIterator</a>).
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_164250ffbbbdbc62b99e8301fc195b80c" name=
|
||
"classboost_1_1circular__buffer_164250ffbbbdbc62b99e8301fc195b80c"></a><code><b>~circular_buffer();</b></code><br>
|
||
|
||
<br>
|
||
The destructor.
|
||
<p>
|
||
Destroys the <code>circular_buffer</code>.
|
||
</p>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates all iterators pointing to the <code>circular_buffer</code> (including iterators equal to
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1826f5770a40b8b752eb9587378464d1e">clear()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<h2>
|
||
<a name="methods" id="methods">Public Member Functions</a>
|
||
</h2>
|
||
<div id="srcdoc_methods">
|
||
<table id="table_methods" border="1" cellpadding="3">
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_15693ba52e58ef90f1d914cbb63143cd3" name=
|
||
"classboost_1_1circular__buffer_15693ba52e58ef90f1d914cbb63143cd3"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_14e07c6ddfe89debe384e59bed06e7cb7">allocator_type</a> get_allocator()
|
||
const;</b></code><br>
|
||
<br>
|
||
Get the allocator.
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
The allocator.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1af7758a36ac2f84a3024b50b4fc7e098">get_allocator()</a></code> for
|
||
obtaining an allocator reference.
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1af7758a36ac2f84a3024b50b4fc7e098" name=
|
||
"classboost_1_1circular__buffer_1af7758a36ac2f84a3024b50b4fc7e098"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_14e07c6ddfe89debe384e59bed06e7cb7">allocator_type</a>&
|
||
get_allocator();</b></code><br>
|
||
<br>
|
||
Get the allocator reference.
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A reference to the allocator.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Note:</b>
|
||
</dt>
|
||
<dd>
|
||
This method was added in order to optimize obtaining of the allocator with a state, although use of
|
||
stateful allocators in STL is discouraged.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_15693ba52e58ef90f1d914cbb63143cd3">get_allocator()
|
||
const</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0" name=
|
||
"classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> begin();</b></code><br>
|
||
<br>
|
||
Get the iterator pointing to the beginning of the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A random access iterator pointing to the first element of the <code>circular_buffer</code>. If the
|
||
<code>circular_buffer</code> is empty it returns an iterator equal to the one returned by
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1db3d6b10b6763549f54d2627228fa7aa">rbegin()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1cff9236a50107188b8942847a4dc2697">rend()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1" name=
|
||
"classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> end();</b></code><br>
|
||
<br>
|
||
Get the iterator pointing to the end of the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A random access iterator pointing to the element "one behind" the last element of the
|
||
<code>circular_buffer</code>. If the <code>circular_buffer</code> is empty it returns an iterator equal
|
||
to the one returned by <code><a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a></code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1db3d6b10b6763549f54d2627228fa7aa">rbegin()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1cff9236a50107188b8942847a4dc2697">rend()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1ee6c38b2ecdc8dfec79975dbc685c80b" name=
|
||
"classboost_1_1circular__buffer_1ee6c38b2ecdc8dfec79975dbc685c80b"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_15cab6d46f03c40d1e52d41843319ddb9">const_iterator</a> begin()
|
||
const;</b></code><br>
|
||
<br>
|
||
Get the const iterator pointing to the beginning of the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A const random access iterator pointing to the first element of the <code>circular_buffer</code>. If
|
||
the <code>circular_buffer</code> is empty it returns an iterator equal to the one returned by
|
||
<code><a href="#classboost_1_1circular__buffer_19813e1d191cd04c4cfc100bbc4733e92">end()
|
||
const</a></code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_19813e1d191cd04c4cfc100bbc4733e92">end()
|
||
const</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_146a8356a1aec6abca9c44cfc60b3bb10">rbegin() const</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1a09f7111dde9f52a4d8babfcdef7e798">rend()
|
||
const</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_19813e1d191cd04c4cfc100bbc4733e92" name=
|
||
"classboost_1_1circular__buffer_19813e1d191cd04c4cfc100bbc4733e92"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_15cab6d46f03c40d1e52d41843319ddb9">const_iterator</a> end()
|
||
const;</b></code><br>
|
||
<br>
|
||
Get the const iterator pointing to the end of the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A const random access iterator pointing to the element "one behind" the last element of the
|
||
<code>circular_buffer</code>. If the <code>circular_buffer</code> is empty it returns an iterator equal
|
||
to the one returned by <code><a href=
|
||
"#classboost_1_1circular__buffer_1ee6c38b2ecdc8dfec79975dbc685c80b">begin() const</a></code> const.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1ee6c38b2ecdc8dfec79975dbc685c80b">begin()
|
||
const</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_146a8356a1aec6abca9c44cfc60b3bb10">rbegin() const</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1a09f7111dde9f52a4d8babfcdef7e798">rend()
|
||
const</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1db3d6b10b6763549f54d2627228fa7aa" name=
|
||
"classboost_1_1circular__buffer_1db3d6b10b6763549f54d2627228fa7aa"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_1002fb890dded89e75dfeb6f021fb58a5">reverse_iterator</a>
|
||
rbegin();</b></code><br>
|
||
<br>
|
||
Get the iterator pointing to the beginning of the "reversed" <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A reverse random access iterator pointing to the last element of the <code>circular_buffer</code>. If
|
||
the <code>circular_buffer</code> is empty it returns an iterator equal to the one returned by
|
||
<code><a href="#classboost_1_1circular__buffer_1cff9236a50107188b8942847a4dc2697">rend()</a></code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1cff9236a50107188b8942847a4dc2697">rend()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1cff9236a50107188b8942847a4dc2697" name=
|
||
"classboost_1_1circular__buffer_1cff9236a50107188b8942847a4dc2697"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_1002fb890dded89e75dfeb6f021fb58a5">reverse_iterator</a>
|
||
rend();</b></code><br>
|
||
<br>
|
||
Get the iterator pointing to the end of the "reversed" <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A reverse random access iterator pointing to the element "one before" the first element of the
|
||
<code>circular_buffer</code>. If the <code>circular_buffer</code> is empty it returns an iterator equal
|
||
to the one returned by <code><a href=
|
||
"#classboost_1_1circular__buffer_1db3d6b10b6763549f54d2627228fa7aa">rbegin()</a></code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1db3d6b10b6763549f54d2627228fa7aa">rbegin()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_146a8356a1aec6abca9c44cfc60b3bb10" name=
|
||
"classboost_1_1circular__buffer_146a8356a1aec6abca9c44cfc60b3bb10"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_1c7317701b511bc5f7a663b06b53e2b73">const_reverse_iterator</a> rbegin()
|
||
const;</b></code><br>
|
||
<br>
|
||
Get the const iterator pointing to the beginning of the "reversed" <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A const reverse random access iterator pointing to the last element of the
|
||
<code>circular_buffer</code>. If the <code>circular_buffer</code> is empty it returns an iterator equal
|
||
to the one returned by <code><a href=
|
||
"#classboost_1_1circular__buffer_1a09f7111dde9f52a4d8babfcdef7e798">rend() const</a></code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1a09f7111dde9f52a4d8babfcdef7e798">rend()
|
||
const</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1ee6c38b2ecdc8dfec79975dbc685c80b">begin() const</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_19813e1d191cd04c4cfc100bbc4733e92">end()
|
||
const</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1a09f7111dde9f52a4d8babfcdef7e798" name=
|
||
"classboost_1_1circular__buffer_1a09f7111dde9f52a4d8babfcdef7e798"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_1c7317701b511bc5f7a663b06b53e2b73">const_reverse_iterator</a> rend()
|
||
const;</b></code><br>
|
||
<br>
|
||
Get the const iterator pointing to the end of the "reversed" <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A const reverse random access iterator pointing to the element "one before" the first element of the
|
||
<code>circular_buffer</code>. If the <code>circular_buffer</code> is empty it returns an iterator equal
|
||
to the one returned by <code><a href=
|
||
"#classboost_1_1circular__buffer_146a8356a1aec6abca9c44cfc60b3bb10">rbegin() const</a></code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_146a8356a1aec6abca9c44cfc60b3bb10">rbegin()
|
||
const</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1ee6c38b2ecdc8dfec79975dbc685c80b">begin() const</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_19813e1d191cd04c4cfc100bbc4733e92">end()
|
||
const</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1d219f0d3203fb43b964a8cf63f1865cd" name=
|
||
"classboost_1_1circular__buffer_1d219f0d3203fb43b964a8cf63f1865cd"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_1f38a9bc64d84757c661c2542ff9a7f65">reference</a> operator[](<a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> index);</b></code><br>
|
||
<br>
|
||
Get the element at the <code>index</code> position.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>0 <= index && index < <a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a></code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>index</code>
|
||
</dt>
|
||
<dd>
|
||
The position of the element.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A reference to the element at the <code>index</code> position.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1cd84838cb4fffb6c113fd0297e502edc">at()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1eb0a7fe7f8a56a4dc4c933b93adfcef4" name=
|
||
"classboost_1_1circular__buffer_1eb0a7fe7f8a56a4dc4c933b93adfcef4"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a> operator[](<a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> index)
|
||
const;</b></code><br>
|
||
<br>
|
||
Get the element at the <code>index</code> position.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>0 <= index && index < <a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a></code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>index</code>
|
||
</dt>
|
||
<dd>
|
||
The position of the element.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A const reference to the element at the <code>index</code> position.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1b233a298f5845a0fcf2ecc56f4170810">at() const</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1cd84838cb4fffb6c113fd0297e502edc" name=
|
||
"classboost_1_1circular__buffer_1cd84838cb4fffb6c113fd0297e502edc"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_1f38a9bc64d84757c661c2542ff9a7f65">reference</a> at(<a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> index);</b></code><br>
|
||
<br>
|
||
Get the element at the <code>index</code> position.
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>index</code>
|
||
</dt>
|
||
<dd>
|
||
The position of the element.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A reference to the element at the <code>index</code> position.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>std::out_of_range</code> when the <code>index</code> is invalid (when <code>index >= <a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a></code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Strong.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1d219f0d3203fb43b964a8cf63f1865cd">operator[]</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1b233a298f5845a0fcf2ecc56f4170810" name=
|
||
"classboost_1_1circular__buffer_1b233a298f5845a0fcf2ecc56f4170810"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a> at(<a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> index)
|
||
const;</b></code><br>
|
||
<br>
|
||
Get the element at the <code>index</code> position.
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>index</code>
|
||
</dt>
|
||
<dd>
|
||
The position of the element.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A const reference to the element at the <code>index</code> position.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>std::out_of_range</code> when the <code>index</code> is invalid (when <code>index >= <a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a></code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Strong.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1eb0a7fe7f8a56a4dc4c933b93adfcef4">operator[]
|
||
const</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_10d5fdeabeb352f47d1f7bb1ea8d9819f" name=
|
||
"classboost_1_1circular__buffer_10d5fdeabeb352f47d1f7bb1ea8d9819f"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_1f38a9bc64d84757c661c2542ff9a7f65">reference</a> front();</b></code><br>
|
||
<br>
|
||
Get the first element.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>!empty()</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A reference to the first element of the <code>circular_buffer</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1d985d974020f88bb4255d8edbae0a30a">back()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1d985d974020f88bb4255d8edbae0a30a" name=
|
||
"classboost_1_1circular__buffer_1d985d974020f88bb4255d8edbae0a30a"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_1f38a9bc64d84757c661c2542ff9a7f65">reference</a> back();</b></code><br>
|
||
<br>
|
||
Get the last element.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>!empty()</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A reference to the last element of the <code>circular_buffer</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_10d5fdeabeb352f47d1f7bb1ea8d9819f">front()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_13261c47e81bb5e447fb0d70f096728b8" name=
|
||
"classboost_1_1circular__buffer_13261c47e81bb5e447fb0d70f096728b8"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a> front()
|
||
const;</b></code><br>
|
||
<br>
|
||
Get the first element.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>!empty()</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A const reference to the first element of the <code>circular_buffer</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_14cd3a019a9d99b4e29918b51c2181a07">back()
|
||
const</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_14cd3a019a9d99b4e29918b51c2181a07" name=
|
||
"classboost_1_1circular__buffer_14cd3a019a9d99b4e29918b51c2181a07"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a> back()
|
||
const;</b></code><br>
|
||
<br>
|
||
Get the last element.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>!empty()</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A const reference to the last element of the <code>circular_buffer</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_13261c47e81bb5e447fb0d70f096728b8">front()
|
||
const</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1957cccdcb0c4ef7d80a34a990065818d" name=
|
||
"classboost_1_1circular__buffer_1957cccdcb0c4ef7d80a34a990065818d"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_126d279f91fef717e25459a0817ff242f">array_range</a>
|
||
array_one();</b></code><br>
|
||
<br>
|
||
Get the first continuous array of the internal buffer.
|
||
<p>
|
||
This method in combination with <code><a href=
|
||
"#classboost_1_1circular__buffer_1f5081a54afbc2dfc1a7fb20329df7d5b">array_two()</a></code> can be useful
|
||
when passing the stored data into a legacy C API as an array. Suppose there is a
|
||
<code>circular_buffer</code> of capacity 10, containing 7 characters <code>'a', 'b', ..., 'g'</code>
|
||
where <code>buff[0] == 'a'</code>, <code>buff[1] == 'b'</code>, ... and <code>buff[6] == 'g'</code>:<br>
|
||
<br>
|
||
<code>circular_buffer<char> buff(10);</code><br>
|
||
<br>
|
||
The internal representation is often not linear and the state of the internal buffer may look like
|
||
this:<br>
|
||
<br>
|
||
<code>|e|f|g| | | |a|b|c|d|<br>
|
||
end ---^<br>
|
||
begin -------^</code><br>
|
||
<br>
|
||
where <code>|a|b|c|d|</code> represents the "array one", <code>|e|f|g|</code> represents the "array two"
|
||
and <code>| | | |</code> is a free space.<br>
|
||
Now consider a typical C style function for writing data into a file:<br>
|
||
<br>
|
||
<code>int write(int file_desc, char* buff, int num_bytes);</code><br>
|
||
<br>
|
||
There are two ways how to write the content of the <code>circular_buffer</code> into a file. Either
|
||
relying on <code><a href=
|
||
"#classboost_1_1circular__buffer_1957cccdcb0c4ef7d80a34a990065818d">array_one()</a></code> and
|
||
<code><a href="#classboost_1_1circular__buffer_1f5081a54afbc2dfc1a7fb20329df7d5b">array_two()</a></code>
|
||
methods and calling the write function twice:<br>
|
||
<br>
|
||
<code>array_range ar = buff.array_one();<br>
|
||
write(file_desc, ar.first, ar.second);<br>
|
||
ar = buff.array_two();<br>
|
||
write(file_desc, ar.first, ar.second);</code><br>
|
||
<br>
|
||
Or relying on the <code><a href=
|
||
"#classboost_1_1circular__buffer_1ea728bf57f91aa8946eddf76ce816a4e">linearize()</a></code> method:<br>
|
||
<br>
|
||
<code>write(file_desc, buff.linearize(), buff.size());</code><br>
|
||
<br>
|
||
Since the complexity of <code><a href=
|
||
"#classboost_1_1circular__buffer_1957cccdcb0c4ef7d80a34a990065818d">array_one()</a></code> and
|
||
<code><a href="#classboost_1_1circular__buffer_1f5081a54afbc2dfc1a7fb20329df7d5b">array_two()</a></code>
|
||
methods is constant the first option is suitable when calling the write method is "cheap". On the other
|
||
hand the second option is more suitable when calling the write method is more "expensive" than calling
|
||
the <code><a href=
|
||
"#classboost_1_1circular__buffer_1ea728bf57f91aa8946eddf76ce816a4e">linearize()</a></code> method whose
|
||
complexity is linear.
|
||
</p>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
The array range of the first continuous array of the internal buffer. In the case the
|
||
<code>circular_buffer</code> is empty the size of the returned array is <code>0</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Warning:</b>
|
||
</dt>
|
||
<dd>
|
||
In general invoking any method which modifies the internal state of the circular_buffer may delinearize
|
||
the internal buffer and invalidate the array ranges returned by <code><a href=
|
||
"#classboost_1_1circular__buffer_1957cccdcb0c4ef7d80a34a990065818d">array_one()</a></code> and
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1f5081a54afbc2dfc1a7fb20329df7d5b">array_two()</a></code> (and their
|
||
const versions).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Note:</b>
|
||
</dt>
|
||
<dd>
|
||
In the case the internal buffer is linear e.g. <code>|a|b|c|d|e|f|g| | | |</code> the "array one" is
|
||
represented by <code>|a|b|c|d|e|f|g|</code> and the "array two" does not exist (the <code><a href=
|
||
"#classboost_1_1circular__buffer_1f5081a54afbc2dfc1a7fb20329df7d5b">array_two()</a></code> method
|
||
returns an array with the size <code>0</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1f5081a54afbc2dfc1a7fb20329df7d5b">array_two()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1ea728bf57f91aa8946eddf76ce816a4e">linearize()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1f5081a54afbc2dfc1a7fb20329df7d5b" name=
|
||
"classboost_1_1circular__buffer_1f5081a54afbc2dfc1a7fb20329df7d5b"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_126d279f91fef717e25459a0817ff242f">array_range</a>
|
||
array_two();</b></code><br>
|
||
<br>
|
||
Get the second continuous array of the internal buffer.
|
||
<p>
|
||
This method in combination with <code><a href=
|
||
"#classboost_1_1circular__buffer_1957cccdcb0c4ef7d80a34a990065818d">array_one()</a></code> can be useful
|
||
when passing the stored data into a legacy C API as an array.
|
||
</p>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
The array range of the second continuous array of the internal buffer. In the case the internal buffer
|
||
is linear or the <code>circular_buffer</code> is empty the size of the returned array is
|
||
<code>0</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1957cccdcb0c4ef7d80a34a990065818d">array_one()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1586cfbdef335f1d3d31faacec63f7b04" name=
|
||
"classboost_1_1circular__buffer_1586cfbdef335f1d3d31faacec63f7b04"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_11885d7f475b7e7a74c95b2448d243025">const_array_range</a> array_one()
|
||
const;</b></code><br>
|
||
<br>
|
||
Get the first continuous array of the internal buffer.
|
||
<p>
|
||
This method in combination with <code><a href=
|
||
"#classboost_1_1circular__buffer_191a0e2c33c0e5b4d7b8c497847bc29ce">array_two() const</a></code> can be
|
||
useful when passing the stored data into a legacy C API as an array.
|
||
</p>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
The array range of the first continuous array of the internal buffer. In the case the
|
||
<code>circular_buffer</code> is empty the size of the returned array is <code>0</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_191a0e2c33c0e5b4d7b8c497847bc29ce">array_two()
|
||
const</a></code>; <code><a href=
|
||
"#classboost_1_1circular__buffer_1957cccdcb0c4ef7d80a34a990065818d">array_one()</a></code> for more
|
||
details how to pass data into a legacy C API.
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_191a0e2c33c0e5b4d7b8c497847bc29ce" name=
|
||
"classboost_1_1circular__buffer_191a0e2c33c0e5b4d7b8c497847bc29ce"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_11885d7f475b7e7a74c95b2448d243025">const_array_range</a> array_two()
|
||
const;</b></code><br>
|
||
<br>
|
||
Get the second continuous array of the internal buffer.
|
||
<p>
|
||
This method in combination with <code><a href=
|
||
"#classboost_1_1circular__buffer_1586cfbdef335f1d3d31faacec63f7b04">array_one() const</a></code> can be
|
||
useful when passing the stored data into a legacy C API as an array.
|
||
</p>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
The array range of the second continuous array of the internal buffer. In the case the internal buffer
|
||
is linear or the <code>circular_buffer</code> is empty the size of the returned array is
|
||
<code>0</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1586cfbdef335f1d3d31faacec63f7b04">array_one()
|
||
const</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1ea728bf57f91aa8946eddf76ce816a4e" name=
|
||
"classboost_1_1circular__buffer_1ea728bf57f91aa8946eddf76ce816a4e"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_14ff917f8a6131ec18e91606727592a9c">pointer</a> linearize();</b></code><br>
|
||
<br>
|
||
Linearize the internal buffer into a continuous array.
|
||
<p>
|
||
This method can be useful when passing the stored data into a legacy C API as an array.
|
||
</p>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>&(*this)[0] < &(*this)[1] < ... < &(*this)[<a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> - 1]</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
A pointer to the beginning of the array or <code>0</code> if empty.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::operator = (const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic; no-throw if the operations in the <i>Throws</i> section do not throw anything.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates all iterators pointing to the <code>circular_buffer</code> (except iterators equal to
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>);
|
||
does not invalidate any iterators if the postcondition (the <i>Effect</i>) is already met prior calling
|
||
this method.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the size of the <code>circular_buffer</code>); constant if the postcondition (the
|
||
<i>Effect</i>) is already met.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Warning:</b>
|
||
</dt>
|
||
<dd>
|
||
In general invoking any method which modifies the internal state of the <code>circular_buffer</code>
|
||
may delinearize the internal buffer and invalidate the returned pointer.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1957cccdcb0c4ef7d80a34a990065818d">array_one()</a></code> and
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1f5081a54afbc2dfc1a7fb20329df7d5b">array_two()</a></code> for the
|
||
other option how to pass data into a legacy C API.
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213" name=
|
||
"classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> size()
|
||
const;</b></code><br>
|
||
<br>
|
||
Get the number of elements currently stored in the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
The number of elements stored in the <code>circular_buffer</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_195158ed4d4b03794068e259f85291995">max_size()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_17e144e8c7acd8e30c08bfb03391a2338">reserve()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_180c2e2e66a8fa9d0b7adc1b54921a8c3">resize()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_195158ed4d4b03794068e259f85291995" name=
|
||
"classboost_1_1circular__buffer_195158ed4d4b03794068e259f85291995"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> max_size()
|
||
const;</b></code><br>
|
||
<br>
|
||
Get the largest possible size or capacity of the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
The maximum size/capacity the <code>circular_buffer</code> can be set to.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_17e144e8c7acd8e30c08bfb03391a2338">reserve()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_105acab2b9a0b41044b5241cfc9d87663" name=
|
||
"classboost_1_1circular__buffer_105acab2b9a0b41044b5241cfc9d87663"></a><code><b>bool empty()
|
||
const;</b></code><br>
|
||
<br>
|
||
Is the <code>circular_buffer</code> empty?
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>true</code> if there are no elements stored in the <code>circular_buffer</code>;
|
||
<code>false</code> otherwise.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_174a305e473c0bba9dcf30abb68bff909">full()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_174a305e473c0bba9dcf30abb68bff909" name=
|
||
"classboost_1_1circular__buffer_174a305e473c0bba9dcf30abb68bff909"></a><code><b>bool full()
|
||
const;</b></code><br>
|
||
<br>
|
||
Is the <code>circular_buffer</code> full?
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>true</code> if the number of elements stored in the <code>circular_buffer</code> equals the
|
||
capacity of the <code>circular_buffer</code>; <code>false</code> otherwise.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_105acab2b9a0b41044b5241cfc9d87663">empty()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_17e144e8c7acd8e30c08bfb03391a2338" name=
|
||
"classboost_1_1circular__buffer_17e144e8c7acd8e30c08bfb03391a2338"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> reserve()
|
||
const;</b></code><br>
|
||
<br>
|
||
Get the maximum number of elements which can be inserted into the <code>circular_buffer</code> without
|
||
overwriting any of already stored elements.
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a> -
|
||
<a href="#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a></code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_195158ed4d4b03794068e259f85291995">max_size()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035" name=
|
||
"classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a> capacity()
|
||
const;</b></code><br>
|
||
<br>
|
||
Get the capacity of the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
The maximum number of elements which can be stored in the <code>circular_buffer</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_17e144e8c7acd8e30c08bfb03391a2338">reserve()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_195158ed4d4b03794068e259f85291995">max_size()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_161714204ef5172d156e2c7eccd04998f">set_capacity()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_161714204ef5172d156e2c7eccd04998f" name=
|
||
"classboost_1_1circular__buffer_161714204ef5172d156e2c7eccd04998f"></a><code><b>void set_capacity(<a href=
|
||
"#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a>
|
||
new_capacity);</b></code><br>
|
||
<br>
|
||
Change the capacity of the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a> ==
|
||
new_capacity && <a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> <=
|
||
new_capacity</code><br>
|
||
<br>
|
||
If the current number of elements stored in the <code>circular_buffer</code> is greater than the
|
||
desired new capacity then number of <code>[<a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> - new_capacity]</code>
|
||
<b>last</b> elements will be removed and the new size will be equal to <code>new_capacity</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>new_capacity</code>
|
||
</dt>
|
||
<dd>
|
||
The new capacity.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Strong.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates all iterators pointing to the <code>circular_buffer</code> (except iterators equal to
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>) if
|
||
the new capacity is different from the original.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in <code>min[<a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a>, new_capacity]</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1477715e9d31d2cc5b02ad8ecf3c68c46">rset_capacity()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_180c2e2e66a8fa9d0b7adc1b54921a8c3">resize()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_180c2e2e66a8fa9d0b7adc1b54921a8c3" name=
|
||
"classboost_1_1circular__buffer_180c2e2e66a8fa9d0b7adc1b54921a8c3"></a><code><b>void resize(<a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> new_size, <a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a> item =
|
||
value_type());</b></code><br>
|
||
<br>
|
||
Change the size of the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> ==
|
||
new_size && <a href=
|
||
"#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a> >=
|
||
new_size</code><br>
|
||
<br>
|
||
If the new size is greater than the current size, copies of <code>item</code> will be inserted at the
|
||
<b>back</b> of the of the <code>circular_buffer</code> in order to achieve the desired size. In the
|
||
case the resulting size exceeds the current capacity the capacity will be set to
|
||
<code>new_size</code>.<br>
|
||
If the current number of elements stored in the <code>circular_buffer</code> is greater than the
|
||
desired new size then number of <code>[<a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> - new_size]</code>
|
||
<b>last</b> elements will be removed. (The capacity will remain unchanged.)
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>new_size</code>
|
||
</dt>
|
||
<dd>
|
||
The new size.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>item</code>
|
||
</dt>
|
||
<dd>
|
||
The element the <code>circular_buffer</code> will be filled with in order to gain the requested
|
||
size. (See the <i>Effect</i>.)
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates all iterators pointing to the <code>circular_buffer</code> (except iterators equal to
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>) if
|
||
the new size is greater than the current capacity. Invalidates iterators pointing to the removed
|
||
elements if the new size is lower that the original size. Otherwise it does not invalidate any
|
||
iterator.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the new size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_144ecd9ec5f54a2d61c7d132e445d3483">rresize()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_161714204ef5172d156e2c7eccd04998f">set_capacity()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1477715e9d31d2cc5b02ad8ecf3c68c46" name=
|
||
"classboost_1_1circular__buffer_1477715e9d31d2cc5b02ad8ecf3c68c46"></a><code><b>void rset_capacity(<a href=
|
||
"#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a>
|
||
new_capacity);</b></code><br>
|
||
<br>
|
||
Change the capacity of the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a> ==
|
||
new_capacity && <a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> <=
|
||
new_capacity</code><br>
|
||
<br>
|
||
If the current number of elements stored in the <code>circular_buffer</code> is greater than the
|
||
desired new capacity then number of <code>[<a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> - new_capacity]</code>
|
||
<b>first</b> elements will be removed and the new size will be equal to <code>new_capacity</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>new_capacity</code>
|
||
</dt>
|
||
<dd>
|
||
The new capacity.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Strong.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates all iterators pointing to the <code>circular_buffer</code> (except iterators equal to
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>) if
|
||
the new capacity is different from the original.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in <code>min[<a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a>, new_capacity]</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_161714204ef5172d156e2c7eccd04998f">set_capacity()</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_144ecd9ec5f54a2d61c7d132e445d3483">rresize()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_144ecd9ec5f54a2d61c7d132e445d3483" name=
|
||
"classboost_1_1circular__buffer_144ecd9ec5f54a2d61c7d132e445d3483"></a><code><b>void rresize(<a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> new_size, <a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a> item =
|
||
value_type());</b></code><br>
|
||
<br>
|
||
Change the size of the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> ==
|
||
new_size && <a href=
|
||
"#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a> >=
|
||
new_size</code><br>
|
||
<br>
|
||
If the new size is greater than the current size, copies of <code>item</code> will be inserted at the
|
||
<b>front</b> of the of the <code>circular_buffer</code> in order to achieve the desired size. In the
|
||
case the resulting size exceeds the current capacity the capacity will be set to
|
||
<code>new_size</code>.<br>
|
||
If the current number of elements stored in the <code>circular_buffer</code> is greater than the
|
||
desired new size then number of <code>[<a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> - new_size]</code>
|
||
<b>first</b> elements will be removed. (The capacity will remain unchanged.)
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>new_size</code>
|
||
</dt>
|
||
<dd>
|
||
The new size.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>item</code>
|
||
</dt>
|
||
<dd>
|
||
The element the <code>circular_buffer</code> will be filled with in order to gain the requested
|
||
size. (See the <i>Effect</i>.)
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates all iterators pointing to the <code>circular_buffer</code> (except iterators equal to
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>) if
|
||
the new size is greater than the current capacity. Invalidates iterators pointing to the removed
|
||
elements if the new size is lower that the original size. Otherwise it does not invalidate any
|
||
iterator.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the new size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_144ecd9ec5f54a2d61c7d132e445d3483">rresize()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_161714204ef5172d156e2c7eccd04998f">set_capacity()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1db1558911b2e251a587aeb3d8b3d797d" name=
|
||
"classboost_1_1circular__buffer_1db1558911b2e251a587aeb3d8b3d797d"></a><code><b>circular_buffer<T,Alloc>&
|
||
operator=(const circular_buffer<T,Alloc>& cb);</b></code><br>
|
||
<br>
|
||
The assign operator.
|
||
<p>
|
||
Makes this <code>circular_buffer</code> to become a copy of the specified <code>circular_buffer</code>.
|
||
</p>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>*this == cb</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>cb</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> to be copied.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Strong.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates all iterators pointing to this <code>circular_buffer</code> (except iterators equal to
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the size of <code>cb</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_19ba4a81df16f386d31b04b49c82d1ada">assign(size_type,
|
||
const_reference)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1aa10b4e4ec1f1c5918931b04b31d43ca">assign(capacity_type, size_type,
|
||
const_reference)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1253302d9bda5d7efbc4a6c311de3790c">assign(InputIterator,
|
||
InputIterator)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_11edb80acdf1f7f1df8217d57256e41f6">assign(capacity_type,
|
||
InputIterator, InputIterator)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_19ba4a81df16f386d31b04b49c82d1ada" name=
|
||
"classboost_1_1circular__buffer_19ba4a81df16f386d31b04b49c82d1ada"></a><code><b>void assign(<a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> n, <a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a>
|
||
item);</b></code><br>
|
||
<br>
|
||
Assign <code>n</code> items into the <code>circular_buffer</code>.
|
||
<p>
|
||
The content of the <code>circular_buffer</code> will be removed and replaced with <code>n</code> copies
|
||
of the <code>item</code>.
|
||
</p>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a> == n
|
||
&& <a href="#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> == n
|
||
&& (*this)[0] == item && (*this)[1] == item && ... && (*this) [n - 1]
|
||
== item</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>n</code>
|
||
</dt>
|
||
<dd>
|
||
The number of elements the <code>circular_buffer</code> will be filled with.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>item</code>
|
||
</dt>
|
||
<dd>
|
||
The element the <code>circular_buffer</code> will be filled with.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates all iterators pointing to the <code>circular_buffer</code> (except iterators equal to
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the <code>n</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1db1558911b2e251a587aeb3d8b3d797d">operator=</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1aa10b4e4ec1f1c5918931b04b31d43ca">assign(capacity_type,
|
||
size_type, const_reference)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1253302d9bda5d7efbc4a6c311de3790c">assign(InputIterator,
|
||
InputIterator)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_11edb80acdf1f7f1df8217d57256e41f6">assign(capacity_type,
|
||
InputIterator, InputIterator)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1aa10b4e4ec1f1c5918931b04b31d43ca" name=
|
||
"classboost_1_1circular__buffer_1aa10b4e4ec1f1c5918931b04b31d43ca"></a><code><b>void assign(<a href=
|
||
"#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a> capacity, <a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> n, <a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a>
|
||
item);</b></code><br>
|
||
<br>
|
||
Assign <code>n</code> items into the <code>circular_buffer</code> specifying the capacity.
|
||
<p>
|
||
The capacity of the <code>circular_buffer</code> will be set to the specified value and the content of
|
||
the <code>circular_buffer</code> will be removed and replaced with <code>n</code> copies of the
|
||
<code>item</code>.
|
||
</p>
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>capacity >= n</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a> ==
|
||
capacity && <a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> == n &&
|
||
(*this)[0] == item && (*this)[1] == item && ... && (*this) [n - 1] ==
|
||
item</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>capacity</code>
|
||
</dt>
|
||
<dd>
|
||
The new capacity.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>n</code>
|
||
</dt>
|
||
<dd>
|
||
The number of elements the <code>circular_buffer</code> will be filled with.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>item</code>
|
||
</dt>
|
||
<dd>
|
||
The element the <code>circular_buffer</code> will be filled with.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates all iterators pointing to the <code>circular_buffer</code> (except iterators equal to
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the <code>n</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1db1558911b2e251a587aeb3d8b3d797d">operator=</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_19ba4a81df16f386d31b04b49c82d1ada">assign(size_type,
|
||
const_reference)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1253302d9bda5d7efbc4a6c311de3790c">assign(InputIterator,
|
||
InputIterator)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_11edb80acdf1f7f1df8217d57256e41f6">assign(capacity_type,
|
||
InputIterator, InputIterator)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1253302d9bda5d7efbc4a6c311de3790c" name=
|
||
"classboost_1_1circular__buffer_1253302d9bda5d7efbc4a6c311de3790c"></a> <code><b>template <class
|
||
InputIterator><br>
|
||
void assign(InputIterator first, InputIterator last);</b></code><br>
|
||
<br>
|
||
Assign a copy of the range into the <code>circular_buffer</code>.
|
||
<p>
|
||
The content of the <code>circular_buffer</code> will be removed and replaced with copies of elements from
|
||
the specified range.
|
||
</p>
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
Valid range <code>[first, last)</code>.<br>
|
||
<code>first</code> and <code>last</code> have to meet the requirements of <a href=
|
||
"http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a> ==
|
||
std::distance(first, last) && <a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> == std::distance(first,
|
||
last) && (*this)[0]== *first && (*this)[1] == *(first + 1) && ... &&
|
||
(*this)[std::distance(first, last) - 1] == *(last - 1)</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>first</code>
|
||
</dt>
|
||
<dd>
|
||
The beginning of the range to be copied.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>last</code>
|
||
</dt>
|
||
<dd>
|
||
The end of the range to be copied.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates all iterators pointing to the <code>circular_buffer</code> (except iterators equal to
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the <code>std::distance(first, last)</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1db1558911b2e251a587aeb3d8b3d797d">operator=</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_19ba4a81df16f386d31b04b49c82d1ada">assign(size_type,
|
||
const_reference)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1aa10b4e4ec1f1c5918931b04b31d43ca">assign(capacity_type, size_type,
|
||
const_reference)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_11edb80acdf1f7f1df8217d57256e41f6">assign(capacity_type,
|
||
InputIterator, InputIterator)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_11edb80acdf1f7f1df8217d57256e41f6" name=
|
||
"classboost_1_1circular__buffer_11edb80acdf1f7f1df8217d57256e41f6"></a> <code><b>template <class
|
||
InputIterator><br>
|
||
void assign(<a href=
|
||
"#classboost_1_1circular__buffer_1dc642ff2be4db0be1a457810e5d09595">capacity_type</a> capacity,
|
||
InputIterator first, InputIterator last);</b></code><br>
|
||
<br>
|
||
Assign a copy of the range into the <code>circular_buffer</code> specifying the capacity.
|
||
<p>
|
||
The capacity of the <code>circular_buffer</code> will be set to the specified value and the content of
|
||
the <code>circular_buffer</code> will be removed and replaced with copies of elements from the specified
|
||
range.
|
||
</p>
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
Valid range <code>[first, last)</code>.<br>
|
||
<code>first</code> and <code>last</code> have to meet the requirements of <a href=
|
||
"http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a> ==
|
||
capacity && <a href=
|
||
"#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> <=
|
||
std::distance(first, last) && (*this)[0]== *(last - capacity) && (*this)[1] == *(last -
|
||
capacity + 1) && ... && (*this)[capacity - 1] == *(last - 1)</code><br>
|
||
<br>
|
||
If the number of items to be copied from the range <code>[first, last)</code> is greater than the
|
||
specified <code>capacity</code> then only elements from the range <code>[last - capacity, last)</code>
|
||
will be copied.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>capacity</code>
|
||
</dt>
|
||
<dd>
|
||
The new capacity.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>first</code>
|
||
</dt>
|
||
<dd>
|
||
The beginning of the range to be copied.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>last</code>
|
||
</dt>
|
||
<dd>
|
||
The end of the range to be copied.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
An allocation error if memory is exhausted (<code>std::bad_alloc</code> if the standard allocator is
|
||
used).
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates all iterators pointing to the <code>circular_buffer</code> (except iterators equal to
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in <code>std::distance(first, last)</code>; in <code>min[capacity, std::distance(first,
|
||
last)]</code> if the <code>InputIterator</code> is a <a href=
|
||
"http://www.sgi.com/tech/stl/RandomAccessIterator.html">RandomAccessIterator</a>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1db1558911b2e251a587aeb3d8b3d797d">operator=</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_19ba4a81df16f386d31b04b49c82d1ada">assign(size_type,
|
||
const_reference)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1aa10b4e4ec1f1c5918931b04b31d43ca">assign(capacity_type, size_type,
|
||
const_reference)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1253302d9bda5d7efbc4a6c311de3790c">assign(InputIterator,
|
||
InputIterator)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1270ab7074c365663a6f18808024fd88b" name=
|
||
"classboost_1_1circular__buffer_1270ab7074c365663a6f18808024fd88b"></a><code><b>void
|
||
swap(circular_buffer<T,Alloc>& cb);</b></code><br>
|
||
<br>
|
||
Swap the contents of two <code>circular_buffer</code>s.
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>this</code> contains elements of <code>cb</code> and vice versa; the capacity of
|
||
<code>this</code> equals to the capacity of <code>cb</code> and vice versa.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>cb</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> whose content will be swapped.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates all iterators of both <code>circular_buffer</code>s. (On the other hand the iterators still
|
||
point to the same elements but within another container. If you want to rely on this feature you have
|
||
to turn the <a href="#debug">Debug Support</a> off otherwise an assertion will report an error if such
|
||
invalidated iterator is used.)
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#namespaceboost_14aa8f6a2c9640f3f22e266f0fca85777">swap(circular_buffer<T,
|
||
Alloc>&, circular_buffer<T, Alloc>&)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1aa35dd7ef8eb1d04508494d1835cc82e" name=
|
||
"classboost_1_1circular__buffer_1aa35dd7ef8eb1d04508494d1835cc82e"></a><code><b>void push_back(<a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a> item =
|
||
value_type());</b></code><br>
|
||
<br>
|
||
Insert a new element at the end of the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
if <code><a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a>
|
||
> 0</code> then <code><a href=
|
||
"#classboost_1_1circular__buffer_1d985d974020f88bb4255d8edbae0a30a">back()</a> == item</code><br>
|
||
If the <code>circular_buffer</code> is full, the first element will be removed. If the capacity is
|
||
<code>0</code>, nothing will be inserted.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>item</code>
|
||
</dt>
|
||
<dd>
|
||
The element to be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic; no-throw if the operation in the <i>Throws</i> section does not throw anything.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators with the exception of iterators pointing to the overwritten element.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_10ef57e73c193682a649d8eb4a1096dce">push_front()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1df0da00cb501bea75afbbfab9f546a07">pop_back()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_18ac972dc24ef7236faa1875de92b9dd8">pop_front()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_10ef57e73c193682a649d8eb4a1096dce" name=
|
||
"classboost_1_1circular__buffer_10ef57e73c193682a649d8eb4a1096dce"></a><code><b>void push_front(<a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a> item =
|
||
value_type());</b></code><br>
|
||
<br>
|
||
Insert a new element at the beginning of the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
if <code><a href="#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a>
|
||
> 0</code> then <code><a href=
|
||
"#classboost_1_1circular__buffer_10d5fdeabeb352f47d1f7bb1ea8d9819f">front()</a> == item</code><br>
|
||
If the <code>circular_buffer</code> is full, the last element will be removed. If the capacity is
|
||
<code>0</code>, nothing will be inserted.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>item</code>
|
||
</dt>
|
||
<dd>
|
||
The element to be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic; no-throw if the operation in the <i>Throws</i> section does not throw anything.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators with the exception of iterators pointing to the overwritten element.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1aa35dd7ef8eb1d04508494d1835cc82e">push_back()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1df0da00cb501bea75afbbfab9f546a07">pop_back()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_18ac972dc24ef7236faa1875de92b9dd8">pop_front()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1df0da00cb501bea75afbbfab9f546a07" name=
|
||
"classboost_1_1circular__buffer_1df0da00cb501bea75afbbfab9f546a07"></a><code><b>void
|
||
pop_back();</b></code><br>
|
||
<br>
|
||
Remove the last element from the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>!empty()</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
The last element is removed from the <code>circular_buffer</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates only iterators pointing to the removed element.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_18ac972dc24ef7236faa1875de92b9dd8">pop_front()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1aa35dd7ef8eb1d04508494d1835cc82e">push_back()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_10ef57e73c193682a649d8eb4a1096dce">push_front()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_18ac972dc24ef7236faa1875de92b9dd8" name=
|
||
"classboost_1_1circular__buffer_18ac972dc24ef7236faa1875de92b9dd8"></a><code><b>void
|
||
pop_front();</b></code><br>
|
||
<br>
|
||
Remove the first element from the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>!empty()</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
The first element is removed from the <code>circular_buffer</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates only iterators pointing to the removed element.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1df0da00cb501bea75afbbfab9f546a07">pop_back()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1aa35dd7ef8eb1d04508494d1835cc82e">push_back()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_10ef57e73c193682a649d8eb4a1096dce">push_front()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_128c92740fee1b9deb8c69816e389de95" name=
|
||
"classboost_1_1circular__buffer_128c92740fee1b9deb8c69816e389de95"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> insert(<a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> pos, <a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a> item =
|
||
value_type());</b></code><br>
|
||
<br>
|
||
Insert an element at the specified position.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>pos</code> is a valid iterator pointing to the <code>circular_buffer</code> or its end.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
The <code>item</code> will be inserted at the position <code>pos</code>.<br>
|
||
If the <code>circular_buffer</code> is full, the first element will be overwritten. If the
|
||
<code>circular_buffer</code> is full and the <code>pos</code> points to <code><a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a></code>, then the
|
||
<code>item</code> will not be inserted. If the capacity is <code>0</code>, nothing will be inserted.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>pos</code>
|
||
</dt>
|
||
<dd>
|
||
An iterator specifying the position where the <code>item</code> will be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>item</code>
|
||
</dt>
|
||
<dd>
|
||
The element to be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
Iterator to the inserted element or <code><a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a></code> if the
|
||
<code>item</code> is not inserted. (See the <i>Effect</i>.)
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::operator = (const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic; no-throw if the operation in the <i>Throws</i> section does not throw anything.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates iterators pointing to the elements at the insertion point (including <code>pos</code>) and
|
||
iterators behind the insertion point (towards the end; except iterators equal to <code><a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>). It also
|
||
invalidates iterators pointing to the overwritten element.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in <code>std::distance(pos, <a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a>)</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1b2f197c99d47138db777f0a46783b140">insert(iterator,
|
||
size_type, value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1d00091d1d794cab3264b3674e99b33f6">insert(iterator, InputIterator,
|
||
InputIterator)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_12c9332f457bf5bb3128463cf528c058c">rinsert(iterator,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1a47a5358db1b7d7e4925c16db13d2fc5">rinsert(iterator, size_type,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1d6479cbc43a304bdbf04262f957fa323">rinsert(iterator, InputIterator,
|
||
InputIterator)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1b2f197c99d47138db777f0a46783b140" name=
|
||
"classboost_1_1circular__buffer_1b2f197c99d47138db777f0a46783b140"></a><code><b>void insert(<a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> pos, <a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> n, <a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a>
|
||
item);</b></code><br>
|
||
<br>
|
||
Insert <code>n</code> copies of the <code>item</code> at the specified position.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>pos</code> is a valid iterator pointing to the <code>circular_buffer</code> or its end.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
The number of <code>min[n, (pos - <a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>) + <a href=
|
||
"#classboost_1_1circular__buffer_17e144e8c7acd8e30c08bfb03391a2338">reserve()</a>]</code> elements will
|
||
be inserted at the position <code>pos</code>.<br>
|
||
The number of <code>min[pos - <a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>, max[0, n - <a href=
|
||
"#classboost_1_1circular__buffer_17e144e8c7acd8e30c08bfb03391a2338">reserve()</a>]]</code> elements
|
||
will be overwritten at the beginning of the <code>circular_buffer</code>.<br>
|
||
(See <i>Example</i> for the explanation.)
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>pos</code>
|
||
</dt>
|
||
<dd>
|
||
An iterator specifying the position where the <code>item</code>s will be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>n</code>
|
||
</dt>
|
||
<dd>
|
||
The number of <code>item</code>s the to be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>item</code>
|
||
</dt>
|
||
<dd>
|
||
The element whose copies will be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::operator = (const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic; no-throw if the operations in the <i>Throws</i> section do not throw anything.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates iterators pointing to the elements at the insertion point (including <code>pos</code>) and
|
||
iterators behind the insertion point (towards the end; except iterators equal to <code><a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>). It also
|
||
invalidates iterators pointing to the overwritten elements.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in <code>min[<a href=
|
||
"#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a>, std::distance(pos,
|
||
<a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a>) + n]</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Example:</b>
|
||
</dt>
|
||
<dd>
|
||
Consider a <code>circular_buffer</code> with the capacity of 6 and the size of 4. Its internal buffer
|
||
may look like the one below.<br>
|
||
<br>
|
||
<code>|1|2|3|4| | |</code><br>
|
||
<code>p ---^</code><br>
|
||
<br>
|
||
After inserting 5 elements at the position <code>p</code>:<br>
|
||
<br>
|
||
<code>insert(p, (size_t)5, 0);</code><br>
|
||
<br>
|
||
actually only 4 elements get inserted and elements <code>1</code> and <code>2</code> are overwritten.
|
||
This is due to the fact the insert operation preserves the capacity. After insertion the internal
|
||
buffer looks like this:<br>
|
||
<br>
|
||
<code>|0|0|0|0|3|4|</code><br>
|
||
<br>
|
||
For comparison if the capacity would not be preserved the internal buffer would then result in
|
||
<code>|1|2|0|0|0|0|0|3|4|</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_128c92740fee1b9deb8c69816e389de95">insert(iterator,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1d00091d1d794cab3264b3674e99b33f6">insert(iterator, InputIterator,
|
||
InputIterator)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_12c9332f457bf5bb3128463cf528c058c">rinsert(iterator,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1a47a5358db1b7d7e4925c16db13d2fc5">rinsert(iterator, size_type,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1d6479cbc43a304bdbf04262f957fa323">rinsert(iterator, InputIterator,
|
||
InputIterator)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1d00091d1d794cab3264b3674e99b33f6" name=
|
||
"classboost_1_1circular__buffer_1d00091d1d794cab3264b3674e99b33f6"></a> <code><b>template <class
|
||
InputIterator><br>
|
||
void insert(<a href="#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a>
|
||
pos, InputIterator first, InputIterator last);</b></code><br>
|
||
<br>
|
||
Insert the range <code>[first, last)</code> at the specified position.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>pos</code> is a valid iterator pointing to the <code>circular_buffer</code> or its end.<br>
|
||
Valid range <code>[first, last)</code> where <code>first</code> and <code>last</code> meet the
|
||
requirements of an <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
Elements from the range <code>[first + max[0, distance(first, last) - (pos - <a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>) - <a href=
|
||
"#classboost_1_1circular__buffer_17e144e8c7acd8e30c08bfb03391a2338">reserve()</a>], last)</code> will
|
||
be inserted at the position <code>pos</code>.<br>
|
||
The number of <code>min[pos - <a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>, max[0, distance(first,
|
||
last) - <a href=
|
||
"#classboost_1_1circular__buffer_17e144e8c7acd8e30c08bfb03391a2338">reserve()</a>]]</code> elements
|
||
will be overwritten at the beginning of the <code>circular_buffer</code>.<br>
|
||
(See <i>Example</i> for the explanation.)
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>pos</code>
|
||
</dt>
|
||
<dd>
|
||
An iterator specifying the position where the range will be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>first</code>
|
||
</dt>
|
||
<dd>
|
||
The beginning of the range to be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>last</code>
|
||
</dt>
|
||
<dd>
|
||
The end of the range to be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::operator = (const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic; no-throw if the operations in the <i>Throws</i> section do not throw anything.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates iterators pointing to the elements at the insertion point (including <code>pos</code>) and
|
||
iterators behind the insertion point (towards the end; except iterators equal to <code><a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>). It also
|
||
invalidates iterators pointing to the overwritten elements.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in <code>[std::distance(pos, <a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a>) + std::distance(first,
|
||
last)]</code>; in <code>min[<a href=
|
||
"#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a>, std::distance(pos,
|
||
<a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a>) +
|
||
std::distance(first, last)]</code> if the <code>InputIterator</code> is a <a href=
|
||
"http://www.sgi.com/tech/stl/RandomAccessIterator.html">RandomAccessIterator</a>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Example:</b>
|
||
</dt>
|
||
<dd>
|
||
Consider a <code>circular_buffer</code> with the capacity of 6 and the size of 4. Its internal buffer
|
||
may look like the one below.<br>
|
||
<br>
|
||
<code>|1|2|3|4| | |</code><br>
|
||
<code>p ---^</code><br>
|
||
<br>
|
||
After inserting a range of elements at the position <code>p</code>:<br>
|
||
<br>
|
||
<code>int array[] = { 5, 6, 7, 8, 9 };</code><br>
|
||
<code>insert(p, array, array + 5);</code><br>
|
||
<br>
|
||
actually only elements <code>6</code>, <code>7</code>, <code>8</code> and <code>9</code> from the
|
||
specified range get inserted and elements <code>1</code> and <code>2</code> are overwritten. This is
|
||
due to the fact the insert operation preserves the capacity. After insertion the internal buffer looks
|
||
like this:<br>
|
||
<br>
|
||
<code>|6|7|8|9|3|4|</code><br>
|
||
<br>
|
||
For comparison if the capacity would not be preserved the internal buffer would then result in
|
||
<code>|1|2|5|6|7|8|9|3|4|</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_128c92740fee1b9deb8c69816e389de95">insert(iterator,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1b2f197c99d47138db777f0a46783b140">insert(iterator, size_type,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_12c9332f457bf5bb3128463cf528c058c">rinsert(iterator,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1a47a5358db1b7d7e4925c16db13d2fc5">rinsert(iterator, size_type,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1d6479cbc43a304bdbf04262f957fa323">rinsert(iterator, InputIterator,
|
||
InputIterator)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_12c9332f457bf5bb3128463cf528c058c" name=
|
||
"classboost_1_1circular__buffer_12c9332f457bf5bb3128463cf528c058c"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> rinsert(<a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> pos, <a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a> item =
|
||
value_type());</b></code><br>
|
||
<br>
|
||
Insert an element before the specified position.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>pos</code> is a valid iterator pointing to the <code>circular_buffer</code> or its end.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
The <code>item</code> will be inserted before the position <code>pos</code>.<br>
|
||
If the <code>circular_buffer</code> is full, the last element will be overwritten. If the
|
||
<code>circular_buffer</code> is full and the <code>pos</code> points to <code><a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>, then the
|
||
<code>item</code> will not be inserted. If the capacity is <code>0</code>, nothing will be inserted.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>pos</code>
|
||
</dt>
|
||
<dd>
|
||
An iterator specifying the position before which the <code>item</code> will be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>item</code>
|
||
</dt>
|
||
<dd>
|
||
The element to be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
Iterator to the inserted element or <code><a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code> if the
|
||
<code>item</code> is not inserted. (See the <i>Effect</i>.)
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::operator = (const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic; no-throw if the operations in the <i>Throws</i> section do not throw anything.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates iterators pointing to the elements before the insertion point (towards the beginning and
|
||
excluding <code>pos</code>). It also invalidates iterators pointing to the overwritten element.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in <code>std::distance(<a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>, pos)</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1a47a5358db1b7d7e4925c16db13d2fc5">rinsert(iterator,
|
||
size_type, value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1d6479cbc43a304bdbf04262f957fa323">rinsert(iterator, InputIterator,
|
||
InputIterator)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_128c92740fee1b9deb8c69816e389de95">insert(iterator,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1b2f197c99d47138db777f0a46783b140">insert(iterator, size_type,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1d00091d1d794cab3264b3674e99b33f6">insert(iterator, InputIterator,
|
||
InputIterator)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1a47a5358db1b7d7e4925c16db13d2fc5" name=
|
||
"classboost_1_1circular__buffer_1a47a5358db1b7d7e4925c16db13d2fc5"></a><code><b>void rinsert(<a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> pos, <a href=
|
||
"#classboost_1_1circular__buffer_19ba12c0142a21a7d960877c22fa3ea00">size_type</a> n, <a href=
|
||
"#classboost_1_1circular__buffer_1a8397191092f5bacee991b623ca4b910">const_reference</a>
|
||
item);</b></code><br>
|
||
<br>
|
||
Insert <code>n</code> copies of the <code>item</code> before the specified position.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>pos</code> is a valid iterator pointing to the <code>circular_buffer</code> or its end.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
The number of <code>min[n, (<a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a> - pos) + <a href=
|
||
"#classboost_1_1circular__buffer_17e144e8c7acd8e30c08bfb03391a2338">reserve()</a>]</code> elements will
|
||
be inserted before the position <code>pos</code>.<br>
|
||
The number of <code>min[<a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a> - pos, max[0, n -
|
||
<a href="#classboost_1_1circular__buffer_17e144e8c7acd8e30c08bfb03391a2338">reserve()</a>]]</code>
|
||
elements will be overwritten at the end of the <code>circular_buffer</code>.<br>
|
||
(See <i>Example</i> for the explanation.)
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>pos</code>
|
||
</dt>
|
||
<dd>
|
||
An iterator specifying the position where the <code>item</code>s will be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>n</code>
|
||
</dt>
|
||
<dd>
|
||
The number of <code>item</code>s the to be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>item</code>
|
||
</dt>
|
||
<dd>
|
||
The element whose copies will be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::operator = (const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic; no-throw if the operations in the <i>Throws</i> section do not throw anything.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates iterators pointing to the elements before the insertion point (towards the beginning and
|
||
excluding <code>pos</code>). It also invalidates iterators pointing to the overwritten elements.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in <code>min[<a href=
|
||
"#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a>,
|
||
std::distance(<a href="#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>,
|
||
pos) + n]</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Example:</b>
|
||
</dt>
|
||
<dd>
|
||
Consider a <code>circular_buffer</code> with the capacity of 6 and the size of 4. Its internal buffer
|
||
may look like the one below.<br>
|
||
<br>
|
||
<code>|1|2|3|4| | |</code><br>
|
||
<code>p ---^</code><br>
|
||
<br>
|
||
After inserting 5 elements before the position <code>p</code>:<br>
|
||
<br>
|
||
<code>rinsert(p, (size_t)5, 0);</code><br>
|
||
<br>
|
||
actually only 4 elements get inserted and elements <code>3</code> and <code>4</code> are overwritten.
|
||
This is due to the fact the rinsert operation preserves the capacity. After insertion the internal
|
||
buffer looks like this:<br>
|
||
<br>
|
||
<code>|1|2|0|0|0|0|</code><br>
|
||
<br>
|
||
For comparison if the capacity would not be preserved the internal buffer would then result in
|
||
<code>|1|2|0|0|0|0|0|3|4|</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_12c9332f457bf5bb3128463cf528c058c">rinsert(iterator,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1d6479cbc43a304bdbf04262f957fa323">rinsert(iterator, InputIterator,
|
||
InputIterator)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_128c92740fee1b9deb8c69816e389de95">insert(iterator,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1b2f197c99d47138db777f0a46783b140">insert(iterator, size_type,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1d00091d1d794cab3264b3674e99b33f6">insert(iterator, InputIterator,
|
||
InputIterator)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1d6479cbc43a304bdbf04262f957fa323" name=
|
||
"classboost_1_1circular__buffer_1d6479cbc43a304bdbf04262f957fa323"></a> <code><b>template <class
|
||
InputIterator><br>
|
||
void rinsert(<a href="#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a>
|
||
pos, InputIterator first, InputIterator last);</b></code><br>
|
||
<br>
|
||
Insert the range <code>[first, last)</code> before the specified position.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>pos</code> is a valid iterator pointing to the <code>circular_buffer</code> or its end.<br>
|
||
Valid range <code>[first, last)</code> where <code>first</code> and <code>last</code> meet the
|
||
requirements of an <a href="http://www.sgi.com/tech/stl/InputIterator.html">InputIterator</a>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
Elements from the range <code>[first, last - max[0, distance(first, last) - (<a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a> - pos) - <a href=
|
||
"#classboost_1_1circular__buffer_17e144e8c7acd8e30c08bfb03391a2338">reserve()</a>])</code> will be
|
||
inserted before the position <code>pos</code>.<br>
|
||
The number of <code>min[<a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a> - pos, max[0,
|
||
distance(first, last) - <a href=
|
||
"#classboost_1_1circular__buffer_17e144e8c7acd8e30c08bfb03391a2338">reserve()</a>]]</code> elements
|
||
will be overwritten at the end of the <code>circular_buffer</code>.<br>
|
||
(See <i>Example</i> for the explanation.)
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>pos</code>
|
||
</dt>
|
||
<dd>
|
||
An iterator specifying the position where the range will be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>first</code>
|
||
</dt>
|
||
<dd>
|
||
The beginning of the range to be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>last</code>
|
||
</dt>
|
||
<dd>
|
||
The end of the range to be inserted.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Whatever <code>T::T(const T&)</code> throws.
|
||
</dd>
|
||
<dd>
|
||
Whatever <code>T::operator = (const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic; no-throw if the operations in the <i>Throws</i> section do not throw anything.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates iterators pointing to the elements before the insertion point (towards the beginning and
|
||
excluding <code>pos</code>). It also invalidates iterators pointing to the overwritten elements.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in <code>[std::distance(<a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>, pos) +
|
||
std::distance(first, last)]</code>; in <code>min[<a href=
|
||
"#classboost_1_1circular__buffer_1da435a5884cad746ed5cd55bcb892035">capacity()</a>,
|
||
std::distance(<a href="#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>,
|
||
pos) + std::distance(first, last)]</code> if the <code>InputIterator</code> is a <a href=
|
||
"http://www.sgi.com/tech/stl/RandomAccessIterator.html">RandomAccessIterator</a>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Example:</b>
|
||
</dt>
|
||
<dd>
|
||
Consider a <code>circular_buffer</code> with the capacity of 6 and the size of 4. Its internal buffer
|
||
may look like the one below.<br>
|
||
<br>
|
||
<code>|1|2|3|4| | |</code><br>
|
||
<code>p ---^</code><br>
|
||
<br>
|
||
After inserting a range of elements before the position <code>p</code>:<br>
|
||
<br>
|
||
<code>int array[] = { 5, 6, 7, 8, 9 };</code><br>
|
||
<code>insert(p, array, array + 5);</code><br>
|
||
<br>
|
||
actually only elements <code>5</code>, <code>6</code>, <code>7</code> and <code>8</code> from the
|
||
specified range get inserted and elements <code>3</code> and <code>4</code> are overwritten. This is
|
||
due to the fact the rinsert operation preserves the capacity. After insertion the internal buffer looks
|
||
like this:<br>
|
||
<br>
|
||
<code>|1|2|5|6|7|8|</code><br>
|
||
<br>
|
||
For comparison if the capacity would not be preserved the internal buffer would then result in
|
||
<code>|1|2|5|6|7|8|9|3|4|</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_12c9332f457bf5bb3128463cf528c058c">rinsert(iterator,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1a47a5358db1b7d7e4925c16db13d2fc5">rinsert(iterator, size_type,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_128c92740fee1b9deb8c69816e389de95">insert(iterator,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1b2f197c99d47138db777f0a46783b140">insert(iterator, size_type,
|
||
value_type)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1d00091d1d794cab3264b3674e99b33f6">insert(iterator, InputIterator,
|
||
InputIterator)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_197155de712db1759e1698455b49a0be3" name=
|
||
"classboost_1_1circular__buffer_197155de712db1759e1698455b49a0be3"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> erase(<a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> pos);</b></code><br>
|
||
<br>
|
||
Remove an element at the specified position.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>pos</code> is a valid iterator pointing to the <code>circular_buffer</code> (but not an
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
The element at the position <code>pos</code> is removed.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>pos</code>
|
||
</dt>
|
||
<dd>
|
||
An iterator pointing at the element to be removed.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
Iterator to the first element remaining beyond the removed element or <code><a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code> if no such element
|
||
exists.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Whatever <code>T::operator = (const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic; no-throw if the operation in the <i>Throws</i> section does not throw anything.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates iterators pointing to the erased element and iterators pointing to the elements behind the
|
||
erased element (towards the end; except iterators equal to <code><a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in <code>std::distance(pos, <a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a>)</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1a96415389509a18bd7d7b5d8e4dda9bd">erase(iterator,
|
||
iterator)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1b6d4ae77d7445f844e30e78592f1e06f">rerase(iterator)</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1b0f98ae303584ded5397f067bbfc911f">rerase(iterator,
|
||
iterator)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1826f5770a40b8b752eb9587378464d1e">clear()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1a96415389509a18bd7d7b5d8e4dda9bd" name=
|
||
"classboost_1_1circular__buffer_1a96415389509a18bd7d7b5d8e4dda9bd"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> erase(<a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> first, <a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> last);</b></code><br>
|
||
<br>
|
||
Erase the range <code>[first, last)</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
Valid range <code>[first, last)</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
The elements from the range <code>[first, last)</code> are removed. (If <code>first == last</code>
|
||
nothing is removed.)
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>first</code>
|
||
</dt>
|
||
<dd>
|
||
The beginning of the range to be removed.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>last</code>
|
||
</dt>
|
||
<dd>
|
||
The end of the range to be removed.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
Iterator to the first element remaining beyond the removed elements or <code><a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code> if no such element
|
||
exists.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Whatever <code>T::operator = (const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic; no-throw if the operation in the <i>Throws</i> section does not throw anything.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates iterators pointing to the erased elements and iterators pointing to the elements behind the
|
||
erased range (towards the end; except iterators equal to <code><a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in <code>std::distance(first, <a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a>)</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_197155de712db1759e1698455b49a0be3">erase(iterator)</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1b6d4ae77d7445f844e30e78592f1e06f">rerase(iterator)</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1b0f98ae303584ded5397f067bbfc911f">rerase(iterator,
|
||
iterator)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1826f5770a40b8b752eb9587378464d1e">clear()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1b6d4ae77d7445f844e30e78592f1e06f" name=
|
||
"classboost_1_1circular__buffer_1b6d4ae77d7445f844e30e78592f1e06f"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> rerase(<a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> pos);</b></code><br>
|
||
<br>
|
||
Remove an element at the specified position.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>pos</code> is a valid iterator pointing to the <code>circular_buffer</code> (but not an
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
The element at the position <code>pos</code> is removed.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>pos</code>
|
||
</dt>
|
||
<dd>
|
||
An iterator pointing at the element to be removed.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
Iterator to the first element remaining in front of the removed element or <code><a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a></code> if no such
|
||
element exists.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Whatever <code>T::operator = (const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic; no-throw if the operation in the <i>Throws</i> section does not throw anything.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates iterators pointing to the erased element and iterators pointing to the elements in front of
|
||
the erased element (towards the beginning).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in <code>std::distance(<a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>, pos)</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Note:</b>
|
||
</dt>
|
||
<dd>
|
||
This method is symetric to the <code><a href=
|
||
"#classboost_1_1circular__buffer_197155de712db1759e1698455b49a0be3">erase(iterator)</a></code> method
|
||
and is more effective than <code><a href=
|
||
"#classboost_1_1circular__buffer_197155de712db1759e1698455b49a0be3">erase(iterator)</a></code> if the
|
||
iterator <code>pos</code> is close to the beginning of the <code>circular_buffer</code>. (See the
|
||
<i>Complexity</i>.)
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_197155de712db1759e1698455b49a0be3">erase(iterator)</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1a96415389509a18bd7d7b5d8e4dda9bd">erase(iterator,
|
||
iterator)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1b0f98ae303584ded5397f067bbfc911f">rerase(iterator,
|
||
iterator)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1826f5770a40b8b752eb9587378464d1e">clear()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1b0f98ae303584ded5397f067bbfc911f" name=
|
||
"classboost_1_1circular__buffer_1b0f98ae303584ded5397f067bbfc911f"></a><code><b><a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> rerase(<a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> first, <a href=
|
||
"#classboost_1_1circular__buffer_11b8a33f2dc8519b8a7d344ed4408c532">iterator</a> last);</b></code><br>
|
||
<br>
|
||
Erase the range <code>[first, last)</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Precondition:</b>
|
||
</dt>
|
||
<dd>
|
||
Valid range <code>[first, last)</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
The elements from the range <code>[first, last)</code> are removed. (If <code>first == last</code>
|
||
nothing is removed.)
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>first</code>
|
||
</dt>
|
||
<dd>
|
||
The beginning of the range to be removed.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>last</code>
|
||
</dt>
|
||
<dd>
|
||
The end of the range to be removed.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
Iterator to the first element remaining in front of the removed elements or <code><a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a></code> if no such
|
||
element exists.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Whatever <code>T::operator = (const T&)</code> throws.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
Basic; no-throw if the operation in the <i>Throws</i> section does not throw anything.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates iterators pointing to the erased elements and iterators pointing to the elements in front
|
||
of the erased range (towards the beginning).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in <code>std::distance(<a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>, last)</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Note:</b>
|
||
</dt>
|
||
<dd>
|
||
This method is symetric to the <code><a href=
|
||
"#classboost_1_1circular__buffer_1a96415389509a18bd7d7b5d8e4dda9bd">erase(iterator,
|
||
iterator)</a></code> method and is more effective than <code><a href=
|
||
"#classboost_1_1circular__buffer_1a96415389509a18bd7d7b5d8e4dda9bd">erase(iterator,
|
||
iterator)</a></code> if <code>std::distance(<a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>, first)</code> is lower
|
||
that <code>std::distance(last, <a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a>)</code>.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_197155de712db1759e1698455b49a0be3">erase(iterator)</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1a96415389509a18bd7d7b5d8e4dda9bd">erase(iterator,
|
||
iterator)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1b6d4ae77d7445f844e30e78592f1e06f">rerase(iterator)</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1826f5770a40b8b752eb9587378464d1e">clear()</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="classboost_1_1circular__buffer_1826f5770a40b8b752eb9587378464d1e" name=
|
||
"classboost_1_1circular__buffer_1826f5770a40b8b752eb9587378464d1e"></a><code><b>void
|
||
clear();</b></code><br>
|
||
<br>
|
||
Remove all stored elements from the <code>circular_buffer</code>.
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> ==
|
||
0</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Exception Safety:</b>
|
||
</dt>
|
||
<dd>
|
||
No-throw.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates all iterators pointing to the <code>circular_buffer</code> (except iterators equal to
|
||
<code><a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a></code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the size of the <code>circular_buffer</code>).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_164250ffbbbdbc62b99e8301fc195b80c">~circular_buffer()</a></code>,
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_197155de712db1759e1698455b49a0be3">erase(iterator)</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1a96415389509a18bd7d7b5d8e4dda9bd">erase(iterator,
|
||
iterator)</a></code>, <code><a href=
|
||
"#classboost_1_1circular__buffer_1b6d4ae77d7445f844e30e78592f1e06f">rerase(iterator)</a></code>,
|
||
<code><a href="#classboost_1_1circular__buffer_1b0f98ae303584ded5397f067bbfc911f">rerase(iterator,
|
||
iterator)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<h2>
|
||
<a name="functions" id="functions">Standalone Functions</a>
|
||
</h2>
|
||
<div id="srcdoc_functions">
|
||
<table id="table_functions" border="1" cellpadding="3">
|
||
<tr>
|
||
<td>
|
||
<a id="namespaceboost_1d35871e838359b5215e1cbb353663207" name=
|
||
"namespaceboost_1d35871e838359b5215e1cbb353663207"></a> <code><b>template <class T, class Alloc><br>
|
||
bool operator==(const circular_buffer<T,Alloc>& lhs, const
|
||
circular_buffer<T,Alloc>& rhs);</b></code><br>
|
||
<br>
|
||
Compare two <code>circular_buffer</code>s element-by-element to determine if they are equal.
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>lhs</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> to compare.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>rhs</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> to compare.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>lhs.<a href="#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> ==
|
||
rhs.<a href="#classboost_1_1circular__buffer_1d666f694897465b0d4d7cdd8ddcbc213">size()</a> &&
|
||
<a href="http://www.sgi.com/tech/stl/equal.html">std::equal</a>(lhs.<a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>, lhs.<a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a>, rhs.<a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>)</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the size of the <code>circular_buffer</code>s).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="namespaceboost_195b08213f201c2067d8acb024756329d" name=
|
||
"namespaceboost_195b08213f201c2067d8acb024756329d"></a> <code><b>template <class T, class Alloc><br>
|
||
bool operator<(const circular_buffer<T,Alloc>& lhs, const
|
||
circular_buffer<T,Alloc>& rhs);</b></code><br>
|
||
<br>
|
||
Compare two <code>circular_buffer</code>s element-by-element to determine if the left one is lesser than
|
||
the right one.
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>lhs</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> to compare.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>rhs</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> to compare.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"http://www.sgi.com/tech/stl/lexicographical_compare.html">std::lexicographical_compare</a>(lhs.<a href="#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>,
|
||
lhs.<a href="#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a>, rhs.<a href=
|
||
"#classboost_1_1circular__buffer_158d1ede2e85f5d46eda8db3f0c4efef0">begin()</a>, rhs.<a href=
|
||
"#classboost_1_1circular__buffer_1babfa093dad7801223b80626b598dee1">end()</a>)</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the size of the <code>circular_buffer</code>s).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="namespaceboost_1f5717e2f6532581a6492ff1839b18f6d" name=
|
||
"namespaceboost_1f5717e2f6532581a6492ff1839b18f6d"></a> <code><b>template <class T, class Alloc><br>
|
||
bool operator!=(const circular_buffer<T,Alloc>& lhs, const
|
||
circular_buffer<T,Alloc>& rhs);</b></code><br>
|
||
<br>
|
||
Compare two <code>circular_buffer</code>s element-by-element to determine if they are non-equal.
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>lhs</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> to compare.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>rhs</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> to compare.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>!(lhs == rhs)</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the size of the <code>circular_buffer</code>s).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#namespaceboost_1d35871e838359b5215e1cbb353663207">operator==(const
|
||
circular_buffer<T,Alloc>&, const circular_buffer<T,Alloc>&)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="namespaceboost_1f575d7a9741c2044424de50c966c12f3" name=
|
||
"namespaceboost_1f575d7a9741c2044424de50c966c12f3"></a> <code><b>template <class T, class Alloc><br>
|
||
bool operator>(const circular_buffer<T,Alloc>& lhs, const
|
||
circular_buffer<T,Alloc>& rhs);</b></code><br>
|
||
<br>
|
||
Compare two <code>circular_buffer</code>s element-by-element to determine if the left one is greater than
|
||
the right one.
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>lhs</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> to compare.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>rhs</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> to compare.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>rhs < lhs</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the size of the <code>circular_buffer</code>s).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#namespaceboost_195b08213f201c2067d8acb024756329d">operator<(const
|
||
circular_buffer<T,Alloc>&, const circular_buffer<T,Alloc>&)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="namespaceboost_179abcbacd24b67f08185db54aec8600d" name=
|
||
"namespaceboost_179abcbacd24b67f08185db54aec8600d"></a> <code><b>template <class T, class Alloc><br>
|
||
bool operator<=(const circular_buffer<T,Alloc>& lhs, const
|
||
circular_buffer<T,Alloc>& rhs);</b></code><br>
|
||
<br>
|
||
Compare two <code>circular_buffer</code>s element-by-element to determine if the left one is lesser or
|
||
equal to the right one.
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>lhs</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> to compare.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>rhs</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> to compare.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>!(rhs < lhs)</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the size of the <code>circular_buffer</code>s).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#namespaceboost_195b08213f201c2067d8acb024756329d">operator<(const
|
||
circular_buffer<T,Alloc>&, const circular_buffer<T,Alloc>&)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="namespaceboost_11c31150380272af67deebef578c80b05" name=
|
||
"namespaceboost_11c31150380272af67deebef578c80b05"></a> <code><b>template <class T, class Alloc><br>
|
||
bool operator>=(const circular_buffer<T,Alloc>& lhs, const
|
||
circular_buffer<T,Alloc>& rhs);</b></code><br>
|
||
<br>
|
||
Compare two <code>circular_buffer</code>s element-by-element to determine if the left one is greater or
|
||
equal to the right one.
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>lhs</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> to compare.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>rhs</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> to compare.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Returns:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>!(lhs < rhs)</code>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Linear (in the size of the <code>circular_buffer</code>s).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Does not invalidate any iterators.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href="#namespaceboost_195b08213f201c2067d8acb024756329d">operator<(const
|
||
circular_buffer<T,Alloc>&, const circular_buffer<T,Alloc>&)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<a id="namespaceboost_14aa8f6a2c9640f3f22e266f0fca85777" name=
|
||
"namespaceboost_14aa8f6a2c9640f3f22e266f0fca85777"></a> <code><b>template <class T, class Alloc><br>
|
||
void swap(circular_buffer<T,Alloc>& lhs, circular_buffer<T,Alloc>&
|
||
rhs);</b></code><br>
|
||
<br>
|
||
Swap the contents of two <code>circular_buffer</code>s.
|
||
<dl>
|
||
<dt>
|
||
<b>Effect:</b>
|
||
</dt>
|
||
<dd>
|
||
<code>lhs</code> contains elements of <code>rhs</code> and vice versa.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Parameter(s):</b>
|
||
</dt>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>lhs</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> whose content will be swapped with <code>rhs</code>.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
<dd>
|
||
<dl compact>
|
||
<dt>
|
||
<code>rhs</code>
|
||
</dt>
|
||
<dd>
|
||
The <code>circular_buffer</code> whose content will be swapped with <code>lhs</code>.
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Throws:</b>
|
||
</dt>
|
||
<dd>
|
||
Nothing.
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Complexity:</b>
|
||
</dt>
|
||
<dd>
|
||
Constant (in the size of the <code>circular_buffer</code>s).
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>Iterator Invalidation:</b>
|
||
</dt>
|
||
<dd>
|
||
Invalidates all iterators of both <code>circular_buffer</code>s. (On the other hand the iterators still
|
||
point to the same elements but within another container. If you want to rely on this feature you have
|
||
to turn the <a href="#debug">Debug Support</a> off otherwise an assertion will report an error if such
|
||
invalidated iterator is used.)
|
||
</dd>
|
||
</dl>
|
||
<dl>
|
||
<dt>
|
||
<b>See Also:</b>
|
||
</dt>
|
||
<dd>
|
||
<code><a href=
|
||
"#classboost_1_1circular__buffer_1270ab7074c365663a6f18808024fd88b">swap(circular_buffer<T,
|
||
Alloc>&)</a></code>
|
||
</dd>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</div>
|
||
<h2>
|
||
<a name="notes" id="notes">Notes</a>
|
||
</h2>
|
||
<ol>
|
||
<li>
|
||
<a name="note1" id="note1"></a>
|
||
<p>
|
||
A good implementation of smart pointers is included in <a href="../../smart_ptr/">Boost</a>.
|
||
</p>
|
||
</li>
|
||
<li>
|
||
<a name="note2" id="note2"></a>
|
||
<p>
|
||
Never create a circular buffer of <code>std::auto_ptr</code>. Refer to <a href=
|
||
"http://www.aristeia.com">Scott Meyers</a> ' excellent book <em>Effective STL</em> for a detailed discussion.
|
||
(Meyers S., <i>Effective STL: 50 Specific Ways to Improve Your Use of the Standard Template Library</i>.
|
||
Addison-Wesley, 2001.)
|
||
</p>
|
||
</li>
|
||
</ol>
|
||
<h2>
|
||
<a name="see" id="see">See also</a>
|
||
</h2>
|
||
<p>
|
||
<code><a href="space_optimized.html">boost::circular_buffer_space_optimized</a>, <a href=
|
||
"http://www.sgi.com/tech/stl/Vector.html">std::vector</a>, <a href=
|
||
"http://www.sgi.com/tech/stl/List.html">std::list</a>, <a href=
|
||
"http://www.sgi.com/tech/stl/Deque.html">std::deque</a></code>
|
||
</p>
|
||
<h2>
|
||
<a name="ack" id="ack">Acknowledgements</a>
|
||
</h2>
|
||
<p>
|
||
The <code>circular_buffer</code> has a short history. Its first version was a <code>std::deque</code> adaptor.
|
||
This container was not very effective because of many reallocations when inserting/removing an element. Thomas
|
||
Wenish did a review of this version and motivated me to create a circular buffer which allocates memory at once
|
||
when created.
|
||
</p>
|
||
<p>
|
||
The second version adapted <code>std::vector</code> but it has been abandoned soon because of limited control
|
||
over iterator invalidation.
|
||
</p>
|
||
<p>
|
||
The current version is a full-fledged STL compliant container. Pavel Vozenilek did a thorough review of this
|
||
version and came with many good ideas and improvements. Also, I would like to thank Howard Hinnant, Nigel Stewart
|
||
and everyone who participated at the formal review for valuable comments and ideas.
|
||
</p>
|
||
<hr size="1">
|
||
<table id="footer" width="100%" border="0">
|
||
<tr valign="top">
|
||
<td valign="top" align="left">
|
||
<p>
|
||
<small>Copyright <20> 2003-2007 Jan Gaspar</small>
|
||
</p>
|
||
<p>
|
||
<small>Use, modification, and distribution is subject to the Boost Software License, Version 1.0.<br>
|
||
(See accompanying file <code>LICENSE_1_0.txt</code> or copy at <a href=
|
||
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</small>
|
||
</p>
|
||
</td>
|
||
<td valign="top" align="right">
|
||
<a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
|
||
"http://www.w3.org/Icons/valid-html401" alt="This is a Valid HTML 4.01 Transitional Document." height="31"
|
||
width="88"></a>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</body>
|
||
</html>
|