Changeset 1b8fc06c for src/Common

Timestamp:

Apr 13, 2023, 4:47:05 PM (20 months ago)

Author:

Andrew Beach <ajbeach@…>

Branches:

ADT, ast-experimental, master

Children:

8a2f7f1, fb4dc28

Parents:

32d6fdc

Message:

Updated Iterate.hpp documentation.

File:

• src/Common/Iterate.hpp (modified) (4 diffs)

src/Common/Iterate.hpp

@@ -20 +20 @@
 #include <iterator>
 
-// it's nice to actually be able to increment iterators by an arbitrary amount
+// Returns an iterator that is it advanced n times.
 template< class InputIt, class Distance >
 InputIt operator+( InputIt it, Distance n ) {
@@ -50 +50 @@
 
 // -----------------------------------------------------------------------------
+// Helper struct and function to support
+// for ( val_and_index : enumerate( container ) ) {}
+// which iterates through the container and tracks the index as well.
+
 template< typename T >
 struct enumerate_t {
@@ -109 +113 @@
 
 // -----------------------------------------------------------------------------
+// Helper function to transform one iterable container into another.
+
 template< typename OutType, typename Range, typename Functor >
 OutType map_range( const Range& range, Functor&& functor ) {
@@ -206 +212 @@
 // Helper struct and function to support
 // for ( val : lazy_map( container1, f ) ) {}
-// syntax to have a for each that iterates a container, mapping each element by applying f
+// syntax to have a for each that iterates a container,
+// mapping each element by applying f.
+
 template< typename T, typename Func >
 struct lambda_iterate_t {