added spans

also lots of misc fixes + refactors

Author: marzer

CHANGELOG.md

@@ -1,10 +1,23 @@
 # Changelog
 
-## Unreleased
-
--   Fixed `swap_columns` fast-path breaking `data()`
--   Used more CRTP mixins in generated classes
+## v0.6.0
+
+-   Fixed `swap_columns()` fast-path breaking `data()`
+-   Added spans
+    -   Added `span`
+    -   Added `is_span<>`
+    -   Added `table::subspan()` and `table::const_subspan()`
+    -   Added `span_type<>` and `const_span_type<>`
+-   Added `soa_type<>`
+-   Added `const_iterator_type<>`
+-   Added `const_row_type<>`
+-   Added `column_indices<>`
+-   Added `soagen::for_each_column()`
+-   Added `row::for_each_column()`
+-   Added generic names `first`, `second`, ..., `sixteenth` for unnamed columns 0-15
+-   Added const propagation to `soagen::row` member functions
 -   Binary size improvements
+-   Documentation improvements
 
 ## v0.5.0
 

README.md

@@ -1,6 +1,6 @@
 # soagen
 
-Struct-of-Arrays generator for C++ projects.
+Struct-of-Arrays for C++.
 
 [![Sponsor](docs/images/badge-sponsor.svg)][sponsor]
 [![Gitter](docs/images/badge-gitter.svg)][gitter]

docs/pages/intro.md

@@ -1,12 +1,12 @@
-@mainpage soagen: A Structure-of-Arrays generator for C++
+@mainpage soagen: Structure-of-Arrays for C++
 
 @tableofcontents
 
 @section intro_tldr TL;DR
 
 The leading section of this page is an overview of what [Structures-of-Arrays (SoA)](https://en.wikipedia.org/wiki/AoS_and_SoA)
 are, what problems they solve, and the annoyances of working with them in C++. Following that is an overview of
-**soagen** - a new Structure-Of-Arrays generator and library for C++17 and later.
+**soagen** - a new Structure-Of-Arrays library and generator for C++17 and later.
 
 @inline_success Skip to @ref intro_introducing_soagen if you already know all about SoA and want to go
 straight to learning about **soagen** instead.
@@ -34,10 +34,10 @@ struct employee
 };
 ```
 
-And elsewhere in the program you'd almost certainly find this:
+And elsewhere in the program you'd almost certainly find something like this:
 
 ```cpp
-std::vector<employee> employees;
+std::vector<employee> all_employees;
 ```
 
 This paradigm is broadly called [Array-of-Structures](https://en.wikipedia.org/wiki/AoS_and_SoA) \(AoS\).
@@ -102,7 +102,7 @@ struct entity
 As before, lets have a look at what an array of these would look like in memory:
 
 ```cpp
-std::vector<entity> entities;
+std::vector<entity> all_entities;
 ```
 
 @parblock
@@ -263,8 +263,8 @@ SoAgen, Soagen, SOAgen, whatever.</i>
 
 @subsection intro_getting_started_prerequisites Prerequisites
 
--   Using the generator: Python 3.9 or higher
 -   Using the C++ library and/or generated code: C++17 or later
+-   Using the generator: Python 3.9 or higher
 
 @subsection intro_getting_started_generator Installing soagen
 

docs/pages/schema.md

@@ -492,7 +492,7 @@ individal tables in your struct's `static_variables`, e.g.:
 ```toml
 [structs.particles]
 static_variables = [
-	{ name = '...', type = '...', ... }
+	{ name = 'default_mass', type = 'float', ... }
 ]
 ```
 
@@ -626,7 +626,7 @@ tables in your struct's `variables`, e.g.:
 ```toml
 [structs.particles]
 variables = [
-	{ name = '...', type = '...', ... }
+	{ name = 'mass', type = 'float', ... }
 ]
 ```
 

docs/poxy.toml

@@ -54,13 +54,13 @@ paths = ['images']
 macros = ['SOAGEN_[A-Z0-9_]+?']
 types = [
 	'employee',
+	'employees',
 	'quaternion',
-	'game::entities',
+	'entity',
 	'entities',
 	'entities::columns',
+	'game::entities',
 	'emplacer',
-	'game::raw_entities',
-	'raw_entities',
 ]
 namespaces = ['game']
 
@@ -71,21 +71,9 @@ namespaces = ['game']
 [autolinks]
 'soagen::iterators?' = 'classsoagen_1_1iterator.html'
 'soagen::rows?' = 'structsoagen_1_1row.html'
-'(?:soagen::)emplacers?' = 'structsoagen_1_1emplacer.html'
+'(?:soagen::)?emplacers?' = 'structsoagen_1_1emplacer.html'
 'soagen::tables?' = 'classsoagen_1_1table.html'
 'CRTP' = 'https://en.wikipedia.org/wiki/Curiously_recurring_template_pattern'
 
-#[implementation_headers]
-#'soagen.hpp' = [
-#	'allocator.hpp',
-#	'column_traits.hpp',
-#	'iterator.hpp',
-#	'core.hpp',
-#	'mixins.hpp',
-#	'row.hpp',
-#	'table_traits.hpp',
-#	'table.hpp',
-#	# 'generated/compressed_pair.hpp',
-#	'generated/functions.hpp',
-#	'generated/preprocessor.hpp',
-#]
+[macros]
+'SOAGEN_COLUMN(...)' = ''

examples/entities.hpp

@@ -145,6 +145,10 @@ namespace soagen::detail
 	SOAGEN_MAKE_NAMED_COLUMN(soagen::examples::entities, 2, pos);
 	SOAGEN_MAKE_NAMED_COLUMN(soagen::examples::entities, 3, orient);
 
+	template <>
+	struct is_soa_<soagen::examples::entities> : std::true_type
+	{};
+
 	template <>
 	struct table_traits_type_<soagen::examples::entities>
 	{
@@ -166,10 +170,6 @@ namespace soagen::detail
 	{
 		using type = table<table_traits_type<soagen::examples::entities>, allocator_type<soagen::examples::entities>>;
 	};
-
-	template <>
-	struct is_soa_<soagen::examples::entities> : std::true_type
-	{};
 }
 
 // clang-format on
@@ -208,6 +208,7 @@ namespace soagen::examples
 						   public soagen::mixins::columns<entities>,
 						   public soagen::mixins::rows<entities>,
 						   public soagen::mixins::iterators<entities>,
+						   public soagen::mixins::spans<entities>,
 						   public soagen::mixins::swappable<entities>)
 	{
 	  public:
@@ -240,12 +241,21 @@ namespace soagen::examples
 		/// @brief Row iterators returned by iterator functions.
 		using iterator = soagen::iterator_type<entities>;
 
-		/// @brief Row iterators returned by const-qualified iterator functions.
-		using const_iterator = soagen::iterator_type<const entities>;
-
 		/// @brief Row iterators returned by rvalue-qualified iterator functions.
 		using rvalue_iterator = soagen::iterator_type<entities&&>;
 
+		/// @brief Row iterators returned by const-qualified iterator functions.
+		using const_iterator = soagen::const_iterator_type<entities>;
+
+		/// @brief Regular (lvalue-qualified) span type.
+		using span_type = soagen::span_type<entities>;
+
+		/// @brief Rvalue-qualified span type.
+		using rvalue_span_type = soagen::span_type<entities&&>;
+
+		/// @brief Const-qualified span type.
+		using const_span_type = soagen::const_span_type<entities>;
+
 		/// @brief Regular (lvalue-qualified) row type used by this class.
 		using row_type = soagen::row_type<entities>;
 
@@ -332,7 +342,7 @@ namespace soagen::examples
 			return table_.get_allocator();
 		}
 
-		/// @name Underlying table access
+		/// @name Underlying table
 		/// @{
 
 		/// @brief Returns an lvalue reference to the underlying soagen::table.
@@ -358,21 +368,21 @@ namespace soagen::examples
 
 		/// @brief Returns an lvalue reference to the underlying soagen::table.
 		SOAGEN_PURE_INLINE_GETTER
-		explicit constexpr operator table_type&() & noexcept
+		explicit constexpr operator table_type&() noexcept
 		{
 			return table_;
 		}
 
 		/// @brief Returns an rvalue reference to the underlying soagen::table.
 		SOAGEN_PURE_INLINE_GETTER
-		explicit constexpr operator table_type&&() && noexcept
+		explicit constexpr operator table_type&&() noexcept
 		{
 			return static_cast<table_type&&>(table_);
 		}
 
 		/// @brief Returns a const lvalue reference to the underlying soagen::table.
 		SOAGEN_PURE_INLINE_GETTER
-		explicit constexpr operator const table_type&() const& noexcept
+		explicit constexpr operator const table_type&() const noexcept
 		{
 			return table_;
 		}
@@ -451,7 +461,7 @@ namespace soagen::examples
 			noexcept(soagen::has_nothrow_unordered_erase_member<table_type>)
 		{
 			if (auto moved_pos = table_.unordered_erase(static_cast<size_type>(pos)); moved_pos)
-				return iterator{ table_, static_cast<difference_type>(*moved_pos) };
+				return iterator{ *this, static_cast<difference_type>(*moved_pos) };
 			return {};
 		}
 
@@ -490,7 +500,7 @@ namespace soagen::examples
 			noexcept(soagen::has_nothrow_unordered_erase_member<table_type>)
 		{
 			if (auto moved_pos = table_.unordered_erase(static_cast<size_type>(pos)); moved_pos)
-				return const_iterator{ table_, static_cast<difference_type>(*moved_pos) };
+				return const_iterator{ *this, static_cast<difference_type>(*moved_pos) };
 			return {};
 		}
 
@@ -875,7 +885,7 @@ namespace soagen::examples
 
 		/// @}
 
-		/// @name Column access
+		/// @name Columns
 		/// @{
 
 		/// @brief Returns a pointer to the elements of a specific column.
@@ -1060,23 +1070,23 @@ namespace soagen::examples
 
 		/// @brief Returns an iterator to the first row in the table.
 		template <auto... Columns>
-		constexpr soagen::iterator_type<const entities, Columns...> begin() const& noexcept;
+		constexpr soagen::const_iterator_type<entities, Columns...> begin() const& noexcept;
 
 		/// @brief Returns an iterator to one-past-the-last row in the table.
 		template <auto... Columns>
-		constexpr soagen::iterator_type<const entities, Columns...> end() const& noexcept;
+		constexpr soagen::const_iterator_type<entities, Columns...> end() const& noexcept;
 
 		/// @brief Returns an iterator to the first row in the table.
 		template <auto... Columns>
-		constexpr soagen::iterator_type<const entities, Columns...> cbegin() const noexcept;
+		constexpr soagen::const_iterator_type<entities, Columns...> cbegin() const noexcept;
 
 		/// @brief Returns an iterator to one-past-the-last row in the table.
 		template <auto... Columns>
-		constexpr soagen::iterator_type<const entities, Columns...> cend() const noexcept;
+		constexpr soagen::const_iterator_type<entities, Columns...> cend() const noexcept;
 
 		/// @}
 
-		/// @name Row access
+		/// @name Rows
 		/// @{
 
 		/// @brief Returns the row at the given index.
@@ -1141,6 +1151,23 @@ namespace soagen::examples
 
 		/// @}
 
+		/// @name Spans
+		/// @{
+
+		/// @brief Returns a span of (some part of) the table.
+		span_type subspan(size_type start, size_type count = static_cast<size_type>(-1)) & noexcept;
+
+		/// @brief Returns an rvalue-qualified span of (some part of) the table.
+		rvalue_span_type subspan(size_type start, size_type count = static_cast<size_type>(-1)) && noexcept;
+
+		/// @brief Returns a const-qualified span of (some part of) the table.
+		const_span_type subspan(size_type start, size_type count = static_cast<size_type>(-1)) const& noexcept;
+
+		/// @brief Returns a const-qualified span of (some part of) the table.
+		const_span_type const_subspan(size_type start, size_type count = static_cast<size_type>(-1)) const noexcept;
+
+		/// @}
+
 #endif
 	};