Table for public member types

slavenf · Jun 15, 2024 · feb661f · feb661f
1 parent 2055c9d
commit feb661f
Show file tree

Hide file tree

Showing 21 changed files with 394 additions and 316 deletions.
diff --git a/doc/compact_vector.md b/doc/compact_vector.md
@@ -102,21 +102,21 @@ This container is inspired by [OpenFOAM's](https://openfoam.org/) container [`Li
 
 ## Public Member Types
 
-```
-using allocator_type         = Allocator;
-using allocator_traits       = std::allocator_traits<Allocator>;
-using value_type             = T;
-using size_type              = typename allocator_traits::size_type;
-using difference_type        = typename allocator_traits::difference_type;
-using reference              = T&;
-using const_reference        = const T&;
-using pointer                = typename allocator_traits::pointer;
-using const_pointer          = typename allocator_traits::const_pointer;
-using iterator               = /* Random access iterator to value_type */
-using const_iterator         = /* Random access iterator to const value_type */
-using reverse_iterator       = std::reverse_iterator<iterator>;
-using const_reverse_iterator = std::reverse_iterator<const_iterator>;
-```
+| Member Type               | Definition |
+| ------------------------- | ---------- |
+| `allocator_type`          | `Allocator` |
+| `allocator_traits`        | `std::allocator_traits<Allocator>` |
+| `value_type`              | `T` |
+| `size_type`               | `typename allocator_traits::size_type` |
+| `difference_type`         | `typename allocator_traits::difference_type` |
+| `reference`               | `T&` |
+| `const_reference`         | `const T&` |
+| `pointer`                 | `typename allocator_traits::pointer` |
+| `const_pointer`           | `typename allocator_traits::const_pointer` |
+| `iterator`                | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) and [*LegacyContiguousIterator*](https://en.cppreference.com/w/cpp/named_req/ContiguousIterator) to `value_type` |
+| `const_iterator`          | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) and [*LegacyContiguousIterator*](https://en.cppreference.com/w/cpp/named_req/ContiguousIterator) to `const value_type` |
+| `reverse_iterator`        | `std::reverse_iterator<iterator>` |
+| `const_reverse_iterator`  | `std::reverse_iterator<const_iterator>` |
 
 <br><br>
 

diff --git a/doc/segmented_devector.md b/doc/segmented_devector.md
@@ -128,21 +128,21 @@ Key differences between `segmented_vector` and `segmented_devector`:
 
 ## Public Member Types
 
-```
-using allocator_type         = Allocator;
-using allocator_traits       = std::allocator_traits<Allocator>;
-using value_type             = T;
-using size_type              = typename allocator_traits::size_type;
-using difference_type        = typename allocator_traits::difference_type;
-using reference              = T&;
-using const_reference        = const T&;
-using pointer                = typename allocator_traits::pointer;
-using const_pointer          = typename allocator_traits::const_pointer;
-using iterator               = /* Random access iterator to value_type */
-using const_iterator         = /* Random access iterator to const value_type */
-using reverse_iterator       = std::reverse_iterator<iterator>;
-using const_reverse_iterator = std::reverse_iterator<const_iterator>;
-```
+| Member Type               | Definition |
+| ------------------------- | ---------- |
+| `allocator_type`          | `Allocator` |
+| `allocator_traits`        | `std::allocator_traits<Allocator>` |
+| `value_type`              | `T` |
+| `size_type`               | `typename allocator_traits::size_type` |
+| `difference_type`         | `typename allocator_traits::difference_type` |
+| `reference`               | `T&` |
+| `const_reference`         | `const T&` |
+| `pointer`                 | `typename allocator_traits::pointer` |
+| `const_pointer`           | `typename allocator_traits::const_pointer` |
+| `iterator`                | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) to `value_type` |
+| `const_iterator`          | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) to `const value_type` |
+| `reverse_iterator`        | `std::reverse_iterator<iterator>` |
+| `const_reverse_iterator`  | `std::reverse_iterator<const_iterator>` |
 
 <br><br>
 

diff --git a/doc/segmented_vector.md b/doc/segmented_vector.md
@@ -121,21 +121,21 @@ Key differences between `segmented_vector` and `segmented_devector`:
 
 ## Public Member Types
 
-```
-using allocator_type         = Allocator;
-using allocator_traits       = std::allocator_traits<Allocator>;
-using value_type             = T;
-using size_type              = typename allocator_traits::size_type;
-using difference_type        = typename allocator_traits::difference_type;
-using reference              = T&;
-using const_reference        = const T&;
-using pointer                = typename allocator_traits::pointer;
-using const_pointer          = typename allocator_traits::const_pointer;
-using iterator               = /* Random access iterator to value_type */
-using const_iterator         = /* Random access iterator to const value_type */
-using reverse_iterator       = std::reverse_iterator<iterator>;
-using const_reverse_iterator = std::reverse_iterator<const_iterator>;
-```
+| Member Type               | Definition |
+| ------------------------- | ---------- |
+| `allocator_type`          | `Allocator` |
+| `allocator_traits`        | `std::allocator_traits<Allocator>` |
+| `value_type`              | `T` |
+| `size_type`               | `typename allocator_traits::size_type` |
+| `difference_type`         | `typename allocator_traits::difference_type` |
+| `reference`               | `T&` |
+| `const_reference`         | `const T&` |
+| `pointer`                 | `typename allocator_traits::pointer` |
+| `const_pointer`           | `typename allocator_traits::const_pointer` |
+| `iterator`                | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) to `value_type` |
+| `const_iterator`          | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) to `const value_type` |
+| `reverse_iterator`        | `std::reverse_iterator<iterator>` |
+| `const_reverse_iterator`  | `std::reverse_iterator<const_iterator>` |
 
 <br><br>
 

diff --git a/doc/small_flat_map.md b/doc/small_flat_map.md
@@ -7,6 +7,7 @@
 * [Summary](#summary)
 * [Template Parameters](#template-parameters)
 * [Public Member Types](#public-member-types)
+* [Public Member Classes](#public-member-classes)
 * [Public Data Members](#public-data-members)
 * [Public Member Functions](#public-member-functions)
   * [(constructor)](#constructor)
@@ -134,24 +135,32 @@ Iterators to elements of `sfl::small_flat_map` are random access iterators and t
 
 ## Public Member Types
 
-```
-using allocator_type         = Allocator;
-using allocator_traits       = std::allocator_traits<allocator_type>;
-using key_type               = Key;
-using mapped_type            = T;
-using value_type             = std::pair<Key, T>;
-using size_type              = typename allocator_traits::size_type;
-using difference_type        = typename allocator_traits::difference_type;
-using key_compare            = Compare;
-using reference              = value_type&;
-using const_reference        = const value_type&;
-using pointer                = typename allocator_traits::pointer;
-using const_pointer          = typename allocator_traits::const_pointer;
-using iterator               = /* Random access iterator to value_type */
-using const_iterator         = /* Random access iterator to const value_type */
-using reverse_iterator       = std::reverse_iterator<iterator>;
-using const_reverse_iterator = std::reverse_iterator<const_iterator>;
+| Member Type               | Definition |
+| ------------------------- | ---------- |
+| `allocator_type`          | `Allocator` |
+| `allocator_traits`        | `std::allocator_traits<allocator_type>` |
+| `key_type`                | `Key` |
+| `mapped_type`             | `T` |
+| `value_type`              | `std::pair<Key, T>` |
+| `size_type`               | `typename allocator_traits::size_type` |
+| `difference_type`         | `typename allocator_traits::difference_type` |
+| `key_compare`             | `Compare` |
+| `reference`               | `value_type&` |
+| `const_reference`         | `const value_type&` |
+| `pointer`                 | `typename allocator_traits::pointer` |
+| `const_pointer`           | `typename allocator_traits::const_pointer` |
+| `iterator`                | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) and [*LegacyContiguousIterator*](https://en.cppreference.com/w/cpp/named_req/ContiguousIterator) to `value_type` |
+| `const_iterator`          | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) and [*LegacyContiguousIterator*](https://en.cppreference.com/w/cpp/named_req/ContiguousIterator) to `const value_type` |
+| `reverse_iterator`        | `std::reverse_iterator<iterator>` |
+| `const_reverse_iterator`  | `std::reverse_iterator<const_iterator>` |
+
+<br><br>
+
 
+
+## Public Member Classes
+
+```
 class value_compare
 {
 public:

diff --git a/doc/small_flat_multimap.md b/doc/small_flat_multimap.md
@@ -7,6 +7,7 @@
 * [Summary](#summary)
 * [Template Parameters](#template-parameters)
 * [Public Member Types](#public-member-types)
+* [Public Member Classes](#public-member-classes)
 * [Public Data Members](#public-data-members)
 * [Public Member Functions](#public-member-functions)
   * [(constructor)](#constructor)
@@ -130,24 +131,32 @@ Iterators to elements of `sfl::small_flat_multimap` are random access iterators
 
 ## Public Member Types
 
-```
-using allocator_type         = Allocator;
-using allocator_traits       = std::allocator_traits<allocator_type>;
-using key_type               = Key;
-using mapped_type            = T;
-using value_type             = std::pair<Key, T>;
-using size_type              = typename allocator_traits::size_type;
-using difference_type        = typename allocator_traits::difference_type;
-using key_compare            = Compare;
-using reference              = value_type&;
-using const_reference        = const value_type&;
-using pointer                = typename allocator_traits::pointer;
-using const_pointer          = typename allocator_traits::const_pointer;
-using iterator               = /* Random access iterator to value_type */
-using const_iterator         = /* Random access iterator to const value_type */
-using reverse_iterator       = std::reverse_iterator<iterator>;
-using const_reverse_iterator = std::reverse_iterator<const_iterator>;
+| Member Type               | Definition |
+| ------------------------- | ---------- |
+| `allocator_type`          | `Allocator` |
+| `allocator_traits`        | `std::allocator_traits<allocator_type>` |
+| `key_type`                | `Key` |
+| `mapped_type`             | `T` |
+| `value_type`              | `std::pair<Key, T>` |
+| `size_type`               | `typename allocator_traits::size_type` |
+| `difference_type`         | `typename allocator_traits::difference_type` |
+| `key_compare`             | `Compare` |
+| `reference`               | `value_type&` |
+| `const_reference`         | `const value_type&` |
+| `pointer`                 | `typename allocator_traits::pointer` |
+| `const_pointer`           | `typename allocator_traits::const_pointer` |
+| `iterator`                | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) and [*LegacyContiguousIterator*](https://en.cppreference.com/w/cpp/named_req/ContiguousIterator) to `value_type` |
+| `const_iterator`          | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) and [*LegacyContiguousIterator*](https://en.cppreference.com/w/cpp/named_req/ContiguousIterator) to `const value_type` |
+| `reverse_iterator`        | `std::reverse_iterator<iterator>` |
+| `const_reverse_iterator`  | `std::reverse_iterator<const_iterator>` |
+
+<br><br>
+
 
+
+## Public Member Classes
+
+```
 class value_compare
 {
 public:

diff --git a/doc/small_flat_multiset.md b/doc/small_flat_multiset.md
@@ -123,24 +123,24 @@ Iterators to elements of `sfl::small_flat_multiset` are random access iterators
 
 ## Public Member Types
 
-```
-using allocator_type         = Allocator;
-using allocator_traits       = std::allocator_traits<allocator_type>;
-using key_type               = Key;
-using value_type             = Key;
-using size_type              = typename allocator_traits::size_type;
-using difference_type        = typename allocator_traits::difference_type;
-using key_compare            = Compare;
-using value_compare          = Compare;
-using reference              = value_type&;
-using const_reference        = const value_type&;
-using pointer                = typename allocator_traits::pointer;
-using const_pointer          = typename allocator_traits::const_pointer;
-using iterator               = /* Random access iterator to const value_type */
-using const_iterator         = /* Random access iterator to const value_type */
-using reverse_iterator       = std::reverse_iterator<iterator>;
-using const_reverse_iterator = std::reverse_iterator<const_iterator>;
-```
+| Member Type               | Definition |
+| ------------------------- | ---------- |
+| `allocator_type`          | `Allocator` |
+| `allocator_traits`        | `std::allocator_traits<allocator_type>` |
+| `key_type`                | `Key` |
+| `value_type`              | `Key` |
+| `size_type`               | `typename allocator_traits::size_type` |
+| `difference_type`         | `typename allocator_traits::difference_type` |
+| `key_compare`             | `Compare` |
+| `value_compare`           | `Compare` |
+| `reference`               | `value_type&` |
+| `const_reference`         | `const value_type&` |
+| `pointer`                 | `typename allocator_traits::pointer` |
+| `const_pointer`           | `typename allocator_traits::const_pointer` |
+| `iterator`                | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) and [*LegacyContiguousIterator*](https://en.cppreference.com/w/cpp/named_req/ContiguousIterator) to `const value_type` |
+| `const_iterator`          | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) and [*LegacyContiguousIterator*](https://en.cppreference.com/w/cpp/named_req/ContiguousIterator) to `const value_type` |
+| `reverse_iterator`        | `std::reverse_iterator<iterator>` |
+| `const_reverse_iterator`  | `std::reverse_iterator<const_iterator>` |
 
 <br><br>
 

diff --git a/doc/small_flat_set.md b/doc/small_flat_set.md
@@ -123,24 +123,24 @@ Iterators to elements of `sfl::small_flat_set` are random access iterators and t
 
 ## Public Member Types
 
-```
-using allocator_type         = Allocator;
-using allocator_traits       = std::allocator_traits<allocator_type>;
-using key_type               = Key;
-using value_type             = Key;
-using size_type              = typename allocator_traits::size_type;
-using difference_type        = typename allocator_traits::difference_type;
-using key_compare            = Compare;
-using value_compare          = Compare;
-using reference              = value_type&;
-using const_reference        = const value_type&;
-using pointer                = typename allocator_traits::pointer;
-using const_pointer          = typename allocator_traits::const_pointer;
-using iterator               = /* Random access iterator to const value_type */
-using const_iterator         = /* Random access iterator to const value_type */
-using reverse_iterator       = std::reverse_iterator<iterator>;
-using const_reverse_iterator = std::reverse_iterator<const_iterator>;
-```
+| Member Type               | Definition |
+| ------------------------- | ---------- |
+| `allocator_type`          | `Allocator` |
+| `allocator_traits`        | `std::allocator_traits<allocator_type>` |
+| `key_type`                | `Key` |
+| `value_type`              | `Key` |
+| `size_type`               | `typename allocator_traits::size_type` |
+| `difference_type`         | `typename allocator_traits::difference_type` |
+| `key_compare`             | `Compare` |
+| `value_compare`           | `Compare` |
+| `reference`               | `value_type&` |
+| `const_reference`         | `const value_type&` |
+| `pointer`                 | `typename allocator_traits::pointer` |
+| `const_pointer`           | `typename allocator_traits::const_pointer` |
+| `iterator`                | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) and [*LegacyContiguousIterator*](https://en.cppreference.com/w/cpp/named_req/ContiguousIterator) to `const value_type` |
+| `const_iterator`          | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) and [*LegacyContiguousIterator*](https://en.cppreference.com/w/cpp/named_req/ContiguousIterator) to `const value_type` |
+| `reverse_iterator`        | `std::reverse_iterator<iterator>` |
+| `const_reverse_iterator`  | `std::reverse_iterator<const_iterator>` |
 
 <br><br>
 

diff --git a/doc/small_unordered_flat_map.md b/doc/small_unordered_flat_map.md
@@ -7,6 +7,7 @@
 * [Summary](#summary)
 * [Template Parameters](#template-parameters)
 * [Public Member Types](#public-member-types)
+* [Public Member Classes](#public-member-classes)
 * [Public Data Members](#public-data-members)
 * [Public Member Functions](#public-member-functions)
   * [(constructor)](#constructor)
@@ -125,22 +126,30 @@ Iterators to elements of `sfl::small_unordered_flat_map` are random access itera
 
 ## Public Member Types
 
-```
-using allocator_type   = Allocator;
-using allocator_traits = std::allocator_traits<allocator_type>;
-using key_type         = Key;
-using mapped_type      = T;
-using value_type       = std::pair<Key, T>;
-using size_type        = typename allocator_traits::size_type;
-using difference_type  = typename allocator_traits::difference_type;
-using key_equal        = KeyEqual;
-using reference        = value_type&;
-using const_reference  = const value_type&;
-using pointer          = typename allocator_traits::pointer;
-using const_pointer    = typename allocator_traits::const_pointer;
-using iterator         = /* Random access iterator to value_type */
-using const_iterator   = /* Random access iterator to const value_type */
+| Member Type               | Definition |
+| ------------------------- | ---------- |
+| `allocator_type`          | `Allocator` |
+| `allocator_traits`        | `std::allocator_traits<allocator_type>` |
+| `key_type`                | `Key` |
+| `mapped_type`             | `T` |
+| `value_type`              | `std::pair<Key, T>` |
+| `size_type`               | `typename allocator_traits::size_type` |
+| `difference_type`         | `typename allocator_traits::difference_type` |
+| `key_equal`               | `KeyEqual` |
+| `reference`               | `value_type&` |
+| `const_reference`         | `const value_type&` |
+| `pointer`                 | `typename allocator_traits::pointer` |
+| `const_pointer`           | `typename allocator_traits::const_pointer` |
+| `iterator`                | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) and [*LegacyContiguousIterator*](https://en.cppreference.com/w/cpp/named_req/ContiguousIterator) to `value_type` |
+| `const_iterator`          | [*LegacyRandomAccessIterator*](https://en.cppreference.com/w/cpp/named_req/RandomAccessIterator) and [*LegacyContiguousIterator*](https://en.cppreference.com/w/cpp/named_req/ContiguousIterator) to `const value_type` |
+
+<br><br>
+
 
+
+## Public Member Classes
+
+```
 class value_compare
 {
 public: