summaryrefslogtreecommitdiffstats
path: root/src/boost/libs/poly_collection/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 18:24:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 18:24:20 +0000
commit483eb2f56657e8e7f419ab1a4fab8dce9ade8609 (patch)
treee5d88d25d870d5dedacb6bbdbe2a966086a0a5cf /src/boost/libs/poly_collection/README.md
parentInitial commit. (diff)
downloadceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.tar.xz
ceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.zip
Adding upstream version 14.2.21.upstream/14.2.21upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/boost/libs/poly_collection/README.md')
-rw-r--r--src/boost/libs/poly_collection/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/src/boost/libs/poly_collection/README.md b/src/boost/libs/poly_collection/README.md
new file mode 100644
index 00000000..ec9578ab
--- /dev/null
+++ b/src/boost/libs/poly_collection/README.md
@@ -0,0 +1,33 @@
+# Boost PolyCollection library
+
+Branch | Travis | AppVeyor | Regression tests
+---------|--------|----------|-----------------
+develop | [![Build Status](https://travis-ci.org/boostorg/poly_collection.svg?branch=develop)](https://travis-ci.org/boostorg/poly_collection) | [![Build Status](https://ci.appveyor.com/api/projects/status/github/boostorg/poly_collection?branch=develop&svg=true)](https://ci.appveyor.com/project/joaquintides/poly-collection) | [![Test Results](./test_results.svg)](https://www.boost.org/development/tests/develop/developer/poly_collection.html)
+master | [![Build Status](https://travis-ci.org/boostorg/poly_collection.svg?branch=master)](https://travis-ci.org/boostorg/poly_collection) | [![Build Status](https://ci.appveyor.com/api/projects/status/github/boostorg/poly_collection?branch=master&svg=true)](https://ci.appveyor.com/project/joaquintides/poly-collection) | [![Test Results](./test_results.svg)](https://www.boost.org/development/tests/master/developer/poly_collection.html)
+
+**Boost.PolyCollection**: fast containers of polymorphic objects.
+
+[Online docs](http://boost.org/libs/poly_collection)
+[Seminal article at bannalia.blogspot.com](http://bannalia.blogspot.com/2014/05/fast-polymorphic-collections.html)
+
+Typically, polymorphic objects cannot be stored *directly* in regular containers
+and need be accessed through an indirection pointer, which introduces performance
+problems related to CPU caching and branch prediction. Boost.PolyCollection
+implements a
+[novel data structure](http://www.boost.org/doc/html/poly_collection/an_efficient_polymorphic_data_st.html)
+that is able to contiguously store polymorphic objects without such indirection,
+thus providing a value-semantics user interface and better performance.
+Three *polymorphic collections* are provided:
+
+* [`boost::base_collection`](http://www.boost.org/doc/html/poly_collection/tutorial.html#poly_collection.tutorial.basics.boost_base_collection)
+* [`boost::function_collection`](http://www.boost.org/doc/html/poly_collection/tutorial.html#poly_collection.tutorial.basics.boost_function_collection)
+* [`boost::any_collection`](http://www.boost.org/doc/html/poly_collection/tutorial.html#poly_collection.tutorial.basics.boost_any_collection)
+
+dealing respectively with classic base/derived or OOP polymorphism, function wrapping
+in the spirit of `std::function` and so-called
+[*duck typing*](https://en.wikipedia.org/wiki/Duck_typing) as implemented by
+[Boost.TypeErasure](http://www.boost.org/libs/type_erasure).
+
+## Requirements
+
+Boost.PolyCollection is a header-only library. C++11 support is required. The library has been verified to work with Visual Studio 2015, GCC 4.8 and Clang 3.3.