Renamed circular::array to circular_array

Author: breese

doc/CMakeLists.txt

@@ -22,7 +22,7 @@ vista_add_doc(vista-doc-vista vista.adoc)
 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)
-include(circular/CMakeLists.txt)
+vista_add_doc(vista-doc-circular-array circular_array.adoc)
 include(map/CMakeLists.txt)
 include(priority/CMakeLists.txt)
 
@@ -33,7 +33,7 @@ if (AsciiDoctor_FOUND)
     DEPENDS vista-doc-rationale
     DEPENDS vista-doc-algorithm
     DEPENDS vista-doc-circular-view
-    DEPENDS vista-doc-circular
+    DEPENDS vista-doc-circular-array
     DEPENDS vista-doc-map
     DEPENDS vista-doc-priority
     )

doc/circular/CMakeLists.txt

@@ -11,7 +11,7 @@
 
 == Introduction
 
-The `circular::array<T, N>` template class is a fixed-size double-ended circular queue.
+The `circular_array<T, N>` template class is a fixed-size double-ended circular queue.
 
 The circular array has a _fixed size_, which means there can be at most `N` elements
 in the circular array, where `N` is determined at compile-time. Like `std::array<T, N>`,
@@ -25,8 +25,8 @@ elements.
 
 === Running Average
 
-In the <<span.adoc#span-tutorial,circular span tutorial>> we ended up with a class
-definition for a running average containing both an array and a span.
+In the <<circular_view.adoc#tutorial,circular view tutorial>> we ended up with a class
+definition for a running average containing both an array and a view.
 [source,c++,numbered]
 ----
 template <typename T, std::size_t N>
@@ -42,12 +42,12 @@ private:
     value_type sum = {};
     // Storage and window
     value_type storage[N];
-    circular::span<value_type, N> window;
+    circular_view<value_type, N> window;
 };
 ----
-Combining a fixed-size storage with a circular span is exactly the purpose of
-the circular array, so we can replace the storage and span with
-`circular::array<T, N>`.
+Combining a fixed-size storage with a circular view is exactly the purpose of
+the circular array, so we can replace the storage and view with
+`circular_array<T, N>`.
 [source,c++,numbered]
 ----
 template <typename T, std::size_t N>
@@ -62,15 +62,15 @@ private:
     static_assert(N > 0, "N must be greater than zero");
     value_type sum = {};
     // Window contains storage
-    circular::array<value_type, N> window;
+    circular_array<value_type, N> window;
 };
 ----
 
 == Design Rationale
 
 This section describes the choices behind the design of the circular array.
 
-The <<span.adoc#span-rationale,design rationale>> of `circular::span<T, N>` also applies,
+The <<circular_view.adoc#rationale,design rationale>> of `circular_view<T, N>` also applies,
 except the ability to use `dynamic_extent`.
 
 === std::array
@@ -92,15 +92,15 @@ There are some significant deviations.
 
 == Reference
 
-Defined in header `<vista/circular/array.hpp>`.
+Defined in header `<vista/circular_array.hpp>`.
 
-Defined in namespace `vista::circular`.
+Defined in namespace `vista`.
 [source,c++]
 ----
 template <
     typename T,
     std::size_t N
-> class array;
+> class circular_array;
 ----
 
 The circular array is a fixed-size circular queue.
@@ -131,7 +131,7 @@ are inserted or destroyed when the circular array is destroyed.
  _Constraint:_ `T` must be _DefaultConstructible_.
  +
  _Constraint:_ `T` must be _Erasable_.
-| `N` | The maximum number of elements in the span.
+| `N` | The maximum number of elements in the array.
  +
  +
  _Constraint:_ `N` cannot be `dynamic_extent`.
@@ -160,7 +160,7 @@ are inserted or destroyed when the circular array is destroyed.
 [%header,frame="topbot",grid="rows",stripes=none]
 |===
 | Member function | Description
-| `constexpr array() noexcept` | Creates an empty circular array.
+| `constexpr circular_array() noexcept` | Creates an empty circular array.
  +
  +
  The `N` elements of the underlying storage are default constructed.
@@ -169,7 +169,7 @@ are inserted or destroyed when the circular array is destroyed.
  _Ensures:_ `capacity() == N`
  +
  _Ensures:_ `size() == 0`
-| `constexpr array(const array<T, N>& other) noexcept(_see Remarks_)` | Creates a circular array by copying.
+| `constexpr circular_array(const circular_array<T, N>& other) noexcept(_see Remarks_)` | Creates a circular array by copying.
  +
  +
  _Constraint:_ `T` must be _CopyConstructible_.
@@ -181,7 +181,7 @@ are inserted or destroyed when the circular array is destroyed.
  +
  +
  _Remarks:_ `noexcept` if `value_type` is nothrow _CopyConstructible_.
-| `constexpr array(array<T, N>&& other) noexcept(_see Remarks_)` | Creates a circular array by moving.
+| `constexpr circular_array(circular_array<T, N>&& other) noexcept(_see Remarks_)` | Creates a circular array by moving.
  +
  +
  _Constraint:_ `T` must be _MoveConstructible_.
@@ -195,7 +195,7 @@ are inserted or destroyed when the circular array is destroyed.
  _Remarks:_ `noexcept` if `value_type` is nothrow _MoveConstructible_.
 | `template <typename... Args>
  +
- constexpr array(value_type, Args&&...) noexcept(_see Remarks_)` | Creates a circular array with elements from input.
+ constexpr circular_array(value_type, Args&&...) noexcept(_see Remarks_)` | Creates a circular array with elements from input.
  +
  +
  This constructor emulates aggregate initialization.
@@ -207,7 +207,7 @@ are inserted or destroyed when the circular array is destroyed.
  +
  +
  _Remarks:_ `noexcept` if `value_type` is nothrow _MoveAssignable_. 
-| `constexpr{wj}footnote:constexpr11[Not constexpr in pass:[C++11].] array& operator=(const array<T, N>& other) noexcept(_see Remarks_)` | Recreates circular array by copying.
+| `constexpr{wj}footnote:constexpr11[Not constexpr in pass:[C++11].] circular_array& operator=(const circular_array<T, N>& other) noexcept(_see Remarks_)` | Recreates circular array by copying.
  +
  +
  _Constraint:_ `T` must be _CopyAssignable_.
@@ -219,7 +219,7 @@ are inserted or destroyed when the circular array is destroyed.
  +
  +
  _Remarks:_ `noexcept` if `value_type` is nothrow _CopyAssignable_.
-| `constexpr{wj}footnote:constexpr11[] array& operator=(array&& other) noexcept(_see Remarks_)` | Recreates circular array by moving.
+| `constexpr{wj}footnote:constexpr11[] circular_array& operator=(circular_array&& other) noexcept(_see Remarks_)` | Recreates circular array by moving.
  +
  +
  All elements are inserted, but if `input.size() > N` then only the last `N` input
@@ -232,7 +232,7 @@ are inserted or destroyed when the circular array is destroyed.
  +
  +
  _Remarks:_ `noexcept` if `value_type` is nothrow _MoveAssignable_.
-| `constexpr{wj}footnote:constexpr11[] array& operator=(std::initializer_list<value_type> input) noexcept(_see Remarks_)` | Recreates circular array with elements from initializer list.
+| `constexpr{wj}footnote:constexpr11[] circular_circular_array& operator=(std::initializer_list<value_type> input) noexcept(_see Remarks_)` | Recreates circular array with elements from initializer list.
  +
  +
  All elements are inserted, but if `input.size() > N` then only the last `N` input

doc/circular/array.adoc doc/circular_array.adoc

@@ -30,6 +30,7 @@ into a double-ended circular queue.
    the view.
 |===
 
+[#tutorial]
 == Tutorial
 
 === Running Average
@@ -258,6 +259,7 @@ auto impulse::value() const -> value_type
 Other variations are possible. For instance, we could have pushed the input
 values at the end of the view, and then used reverse iterators in the algorithm.
 
+[#rationale]
 == Design Rationale
 
 This section describes the choices behind the design of the circular view.

doc/circular_view.adoc

@@ -44,7 +44,7 @@ Views operate on borrowed continguous memory. Some <<rationale.adoc#,design deci
 
 == Fixed-Capacity Container
 
-- <<circular/array.adoc#,Circular array>> is a circular queue operating on a nested array.
+- <<circular_array.adoc#,Circular array>> is a circular queue operating on a nested array.
 
 == Algorithm
 

doc/vista.adoc

@@ -12,7 +12,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 #include <type_traits>
-#include <vista/circular/array.hpp>
+#include <vista/circular_array.hpp>
 
 namespace vista
 {
@@ -23,11 +23,11 @@ namespace example
 
 template <typename T, std::size_t N>
 class average
-    : protected circular::array<T, N>
+    : protected circular_array<T, N>
 {
     static_assert(N > 0, "N must be greater than zero");
 
-    using window = circular::array<T, N>;
+    using window = circular_array<T, N>;
 
 public:
     using value_type = typename window::value_type;

example/circular/average/average.hpp

@@ -13,7 +13,7 @@
 
 #include <mutex>
 #include <condition_variable>
-#include <vista/circular/array.hpp>
+#include <vista/circular_array.hpp>
 
 namespace vista
 {
@@ -52,7 +52,7 @@ class concurrent_queue
 private:
     std::mutex mutex;
     std::condition_variable notifier;
-    circular::array<T, N> data;
+    circular_array<T, N> data;
 };
 
 } // namespace example

example/circular/concurrent/queue.hpp

@@ -14,7 +14,7 @@
 #include <type_traits>
 #include <numeric>
 #include <array>
-#include <vista/circular/array.hpp>
+#include <vista/circular_array.hpp>
 
 namespace vista
 {
@@ -59,7 +59,7 @@ class impulse
     }
 
 private:
-    circular::array<value_type, N> window;
+    circular_array<value_type, N> window;
     std::array<value_type, N> coefficients;
 };
 

example/circular/impulse/impulse.hpp

@@ -16,8 +16,6 @@
 
 namespace vista
 {
-namespace circular
-{
 
 //! @brief Fixed-sized circular buffer.
 //!
@@ -29,7 +27,7 @@ namespace circular
 //! Violation of any precondition results in undefined behavior.
 
 template <typename T, std::size_t N>
-class array
+class circular_array
     : private std::array<T, N>,
       private circular_view<T, N>
 {
@@ -58,7 +56,7 @@ class array
     //! @post capacity() == N
     //! @post size() == 0
 
-    constexpr array() noexcept;
+    constexpr circular_array() noexcept;
 
     //! @brief Creates circular array by copying.
     //!
@@ -67,7 +65,7 @@ class array
     //! @post capacity() == N
     //! @post size() == other.size()
 
-    constexpr array(const array& other) noexcept(std::is_nothrow_copy_constructible<value_type>::value);
+    constexpr circular_array(const circular_array& other) noexcept(std::is_nothrow_copy_constructible<value_type>::value);
 
     //! @brief Recreates circular array by copying.
     //!
@@ -77,22 +75,22 @@ class array
     //! @post size() == other.size()
 
     VISTA_CXX14_CONSTEXPR
-    array& operator=(const array& other) noexcept(std::is_nothrow_copy_assignable<value_type>::value);
+    circular_array& operator=(const circular_array& other) noexcept(std::is_nothrow_copy_assignable<value_type>::value);
 
     //! @brief Creates circular array by moving.
     //!
     //! @post capacity() == N
     //! @post size() == other.size()
 
-    constexpr array(array&& other) noexcept(std::is_nothrow_move_constructible<value_type>::value) = default;
+    constexpr circular_array(circular_array&& other) noexcept(std::is_nothrow_move_constructible<value_type>::value) = default;
 
     //! @brief Recreates circular array by moving.
     //!
     //! @post capacity() == N
     //! @post size() == other.size()
 
     VISTA_CXX14_CONSTEXPR
-    array& operator=(array&& other) noexcept(std::is_nothrow_move_assignable<value_type>::value) = default;
+    circular_array& operator=(circular_array&& other) noexcept(std::is_nothrow_move_assignable<value_type>::value) = default;
 
     //! @brief Creates circular array with element from initializer list.
     //!
@@ -103,7 +101,7 @@ class array
     //! @post size() == input.size()
 
     template <typename... Args>
-    constexpr array(value_type, Args&&...) noexcept(std::is_nothrow_move_assignable<value_type>::value);
+    constexpr circular_array(value_type, Args&&...) noexcept(std::is_nothrow_move_assignable<value_type>::value);
 
     //! @brief Recreates circular array with element from initializer list.
     //!
@@ -114,7 +112,7 @@ class array
     //! @post size() == input.size()
 
     VISTA_CXX14_CONSTEXPR
-    array& operator=(std::initializer_list<value_type> input) noexcept(std::is_nothrow_move_assignable<value_type>::value);
+    circular_array& operator=(std::initializer_list<value_type> input) noexcept(std::is_nothrow_move_assignable<value_type>::value);
 
     //! @brief Checks if circular array is empty.
     using view::empty;
@@ -207,9 +205,8 @@ class array
     using view::last_unused_segment;
 };
 
-} // namespace circular
 } // namespace vista
 
-#include <vista/circular/detail/array.ipp>
+#include <vista/detail/circular_array.ipp>
 
 #endif // VISTA_CIRCULAR_ARRAY_HPP