Renamed map::span to map_view

Author: breese

doc/CMakeLists.txt

@@ -23,8 +23,8 @@ vista_add_doc(vista-doc-rationale rationale.adoc)
 vista_add_doc(vista-doc-algorithm algorithm.adoc)
 vista_add_doc(vista-doc-circular-view circular_view.adoc)
 vista_add_doc(vista-doc-circular-array circular_array.adoc)
+vista_add_doc(vista-doc-map-view map_view.adoc)
 vista_add_doc(vista-doc-priority-view priority_view.adoc)
-include(map/CMakeLists.txt)
 
 if (AsciiDoctor_FOUND)
 
@@ -34,7 +34,7 @@ if (AsciiDoctor_FOUND)
     DEPENDS vista-doc-algorithm
     DEPENDS vista-doc-circular-view
     DEPENDS vista-doc-circular-array
-    DEPENDS vista-doc-map
+    DEPENDS vista-doc-map-view
     DEPENDS vista-doc-priority-view
     )
 

doc/map/CMakeLists.txt

@@ -8,78 +8,78 @@
 :icons: font
 :stem: latexmath
 
-= Map Span
+= Map View
 
 == Introduction
 
-The map span is a fixed-capacity associative span.
+The `map_view` template class is a fixed-capacity associative view.
 
 == Tutorial
 
 === In-Place Construction
 
-Constructing an element in-place is done by expanding the span, constructing
+Constructing an element in-place is done by expanding the view, constructing
 the element in the expanded storage, and reordering the constructed element.
 
 [source,c++,numbered]
 ----
-  map::pair<std::string, int> storage[4] = {};
-  map::span<std::string, int> span(storage);
+  pair<std::string, int> storage[4] = {};
+  map_view<std::string, int> view(storage);
 
-  assert(!span.full());
+  assert(!view.full());
 
-  auto position = span.expand_back();
+  auto position = view.expand_back();
   std::construct_at(position, "key", 42); // Use placement-new before C++20
   position = reorder_back();
 
-  assert(span.lower_bound("key") == position);
+  assert(view.lower_bound("key") == position);
   assert(position->first == "key");
   assert(position->second == 42);
 ----
 
 
 == Design Rationale
 
-This section describes the choice behind the design of the map span. See also
-the general <<../rationale.adoc#,span rationale>>.
+This section describes the choice behind the design of the map view. See also
+the general <<rationale.adoc#,view rationale>>.
 
 === Non-copyable
 
-The map span is not copyable. If two spans are operating on the same underlying
+The map view is not copyable. If two views are operating on the same underlying
 storage, then they may break the class invariants of each other. For instance,
-if the first span removes an element (the removed element is moved to the position
-immediately after the span) then the second span looks at a range where its last
+if the first view removes an element (the removed element is moved to the position
+immediately after the view) then the second view looks at a range where its last
 element no longer is in the correct order.
 
-The map span is movable, but it is undefined behavior to use the moved-from span.
+The map view is movable, but it is undefined behavior to use the moved-from view.
 
 == Reference
 
-Defined in header `<vista/map/span.hpp>`.
+Defined in header `<vista/map_view.hpp>`.
 
-Defined in namespace `vista::map`.
+Defined in namespace `vista`.
 [source,c++]
 ----
 template <
     typename Key,
     typename T,
     std::size_t Extent = dynamic_extent,
     typename Compare = std::less<Key>>
-> class span;
+> class map_view;
 ----
-The map span template class is an associative array view of some continguos
-storage. The storage is not owned by the span. The owner must ensure that the
-span is destroyed before the storage is released.
+The map view template class is an associative array view of some continguos
+storage. The storage is not owned by the view. The owner must ensure that the
+view is destroyed before the storage is released.
 
-The map span does not construct or destroy elements in the underlying storage.
+The map view does not construct or destroy elements in the underlying storage.
 Some operations may leave elements in a moved-from state.
 
-The size is the current number of elements in the span.
+The size is the current number of elements in the view.
 
 The capacity is the maximum number of elements that can be inserted. The
 capacity cannot be changed.
 
-The extent determines the capacity of the span.
+The extent determines the capacity of the view.
 With `dynamic_extent` the capacity is derived from the input arguments
 at construction or assignment time. Otherwise the capacity is fixed to the
 specified `Extent` template argument. Dynamic extent is used by default.
@@ -96,7 +96,7 @@ specified `Extent` template argument. Dynamic extent is used by default.
  +
  +
  _Constraint:_ `T` must be a complete type.
-| `Extent` | The maximum number of elements in the span.
+| `Extent` | The maximum number of elements in the view.
 | `Compare` | A _BinaryPredicate_ determining the order.
 |===
 
@@ -121,10 +121,10 @@ specified `Extent` template argument. Dynamic extent is used by default.
 [%header,frame="topbot",grid="rows",stripes=none]
 |===
 | Member function | Description
-| `constexpr span() noexcept` | Creates an empty map span with zero capacity.
+| `constexpr map_view() noexcept` | Creates an empty map view with zero capacity.
  +
  +
- No elements can be inserted into a zero-capacity span. The span must
+ No elements can be inserted into a zero-capacity view. The view must
  therefore be recreated before use.
  +
  +
@@ -134,21 +134,21 @@ specified `Extent` template argument. Dynamic extent is used by default.
  _Ensures:_ `capacity() == 0`
  +
  _Ensures:_ `size() == 0`
-| `constexpr span(span&& other) noexcept` | Creates span by moving.
+| `constexpr map_view(map_view&& other) noexcept` | Creates view by moving.
  +
  +
- The state of the moved-from span is valid but unspecified.
+ The state of the moved-from view is valid but unspecified.
  +
  +
  _Ensures:_ `capacity() == other.capacity()`
  +
  _Ensures:_ `size() == other.size()`
 | `template <std::size_t N>
  +
- constexpr span(value_type (&array)[N]) noexcept` | Creates empty span from array.
+ constexpr map_view(value_type (&array)[N]) noexcept` | Creates empty view from array.
  +
  +
- The span uses the array as the underlying storage.
+ The view uses the array as the underlying storage.
  +
  +
  _Constrait:_ `N == Extent` unless `Extent == dynamic_extent`
@@ -159,7 +159,7 @@ specified `Extent` template argument. Dynamic extent is used by default.
  _Ensures:_ `size() == 0`
 | `template <typename ContiguousIterator>
  +
- constexpr span(ContiguousIterator begin, ContiguousIterator end) noexcept` | Creates a span from iterators.
+ constexpr map_view(ContiguousIterator begin, ContiguousIterator end) noexcept` | Creates a view from iterators.
  +
  +
  _Expects:_ `Extent == std::distance(begin, end)` or `Extent == dynamic_extent`
@@ -168,14 +168,14 @@ specified `Extent` template argument. Dynamic extent is used by default.
  _Ensures:_ `capacity() == std::distance(begin, end)`
  +
  _Ensures:_ `size() == 0`
-| `constexpr bool empty() const noexcept` | Checks if span is empty.
-| `constexpr bool full() const noexcept` | Checks if span is full.
+| `constexpr bool empty() const noexcept` | Checks if view is empty.
+| `constexpr bool full() const noexcept` | Checks if view is full.
  +
  +
- Span is full when `size() == capacity()`.
-| `constexpr size_type capacity() const noexcept` | Returns the maximum possible number of elements in the span.
-| `constexpr size_type size() const noexcept` | Returns the number of elements in the span.
-| `constexpr{wj}footnote:constexpr11[Not constexpr in pass:[C++11].] void clear() noexcept` | Clears the span.
+ View is full when `size() == capacity()`.
+| `constexpr size_type capacity() const noexcept` | Returns the maximum possible number of elements in the view.
+| `constexpr size_type size() const noexcept` | Returns the number of elements in the view.
+| `constexpr{wj}footnote:constexpr11[Not constexpr in pass:[C++11].] void clear() noexcept` | Clears the view.
  +
  +
  The elements are not destroyed in the underlying storage.
@@ -203,17 +203,17 @@ specified `Extent` template argument. Dynamic extent is used by default.
  +
  +
  _Remarks:_ `noexcept` if `value_type` is nothrow _Swappable_.
-| `constexpr{wj}footnote:constexpr11[] iterator expand_back() noexcept` | Inserts unspecified element at the end of the span.
+| `constexpr{wj}footnote:constexpr11[] iterator expand_back() noexcept` | Inserts unspecified element at the end of the view.
  +
  +
- The span is expanded to include the next element in the underlying storage
+ The view is expanded to include the next element in the underlying storage
  after the current end.
  +
  +
  Returns iterator to inserted element.
  +
  +
- The span may not be expanded beyond capacity.
+ The view may not be expanded beyond capacity.
  +
  +
  This function breaks the class invariants which must be restored with
@@ -251,15 +251,15 @@ specified `Extent` template argument. Dynamic extent is used by default.
  +
  +
  constexpr const_iterator cbegin() const noexcept`
- | Returns an iterator to the beginning of the span.
+ | Returns an iterator to the beginning of the view.
 | `constexpr{wj}footnote:constexpr11[] iterator end() noexcept
  +
  +
  constexpr const_iterator end() const noexcept
  +
  +
  constexpr const_iterator cend() const noexcept`
- | Returns an iterator to the end of the span.
+ | Returns an iterator to the end of the view.
 | `constexpr key_compare key_comp() const noexcept` | Returns key comparison predicate.
 | `constexpr value_compare value_comp() const noexcept` | Returns value comparison predicate.
 |===

doc/map/span.adoc doc/map_view.adocdoc/map/span.adoc renamed to doc/map_view.adoc

@@ -14,11 +14,11 @@ Bjørn Reese
 
 == Introduction
 
-Vista is a header-only C++11 library that contains various span classes.
+Vista is a header-only C++11 library that contains various view classes.
 
-The span classes acts like fixed-capacity in-place containers operating on contiguous memory provided by the user.
+The view classes acts like fixed-capacity in-place containers operating on contiguous memory provided by the user.
 
-The span classes do not take ownership of the user-provided memory. User must ensure the life-time of the memory until the span has been destroyed.
+The view classes do not take ownership of the user-provided memory. User must ensure the life-time of the memory until the view has been destroyed.
 
 [NOTE]
 .Precondition
@@ -29,17 +29,12 @@ using namespace vista;
 ----
 ====
 
-== Span
-
-Spans operate on borrowed continguous memory. Some <<rationale.adoc#,design decisions>> are common to all spans.
-
-- <<map/span.adoc#,Map span>> is an associative array operating on borrowed storage.
-
 == View
 
 Views operate on borrowed continguous memory. Some <<rationale.adoc#,design decisions>> are common to all views.
 
 - <<circular_view.adoc#,Circular view>> is a circular queue operating on borrowed storage.
+- <<map_view.adoc#,Map view>> is an associative array operating on borrowed storage.
 - <<priority_view.adoc#,Priority view>> is a priority queue operating on borrowed storage.
 
 == Fixed-Capacity Container