Clarify the status of "collate"

And add tests

Changes

@@ -3,6 +3,7 @@ Revision history for ParaSeq
 {{$NEXT}}
     - Added Theory of operation section in documentation
     - Updated status of ".sort" and added tests
+    - Updated status of ".collate" and added tests
 
 0.0.7  2024-05-30T14:24:50+02:00
     - Added optimized ".batch" and tests

README.md

@@ -190,7 +190,7 @@ batch
 collate
 -------
 
-[`.collate`](https://docs.raku.org/type/Any#method_collate)
+**Status**: the nature of the [`.collate`](https://docs.raku.org/type/Any#method_collate) method basically makes it impossible to hyper. Therefore, **no** specific hypering logic has been added for this method.
 
 combinations
 ------------

doc/ParaSeq.rakudoc

@@ -246,7 +246,10 @@ has been implemented.
 
 =head2 collate
 
+B<Status>: the nature of the
 L<C<.collate>|https://docs.raku.org/type/Any#method_collate>
+method basically makes it impossible to hyper.  Therefore, B<no>
+specific hypering logic has been added for this method.
 
 =head2 combinations
 
@@ -942,11 +945,12 @@ be increased.
 
 =begin code
     /---------------------------------------------------------\
-    |               |                                         |
+    |                |                                        |
+    |               ⬇                                         |
     |         --------------                 ------------     |
     |         | statistics |         /-----⮕ | producer | ⮕ -|
     |         --------------        /        ------------     |
-    ⬇              ⬇              /                          |
+    ⬇               ⬇             /                          |
 -----------    ------------    -----------   ------------     |
 | results | ⮕ | deliverer | ⮕ | batcher | ⮕ | producer | ⮕ -|
 -----------    ------------    -----------   ------------     |

lib/ParaSeq.rakumod

@@ -1472,8 +1472,8 @@ class ParaSeq does Sequence {
 #- interfaces that are just infectious -----------------------------------------
 
     proto method collate(|) {*}
-    multi method collate(ParaSeq:D: |c) {
-        self!pass-the-chain: self.List.collate(|c).iterator
+    multi method collate(ParaSeq:D:) {
+        self!pass-the-chain: self.List.collate.iterator
     }
 
     multi method combinations(ParaSeq:D: $of) {

t/35-sort.rakutest

@@ -3,14 +3,14 @@ use ParaSeq;
 
 plan 12;
 
-my constant $elems = 200000;
-my constant $batch = 16;
-my constant @list  = (^$elems).reverse.List;
+my constant $elems   = 200000;
+my constant @list    = (^$elems).reverse.List;
 my constant @sorted  = @list.sort.List;
 my constant $asStr   = *.Str;
 my constant @sorteds = @list.sort($asStr).List;
 my constant $reverse = { $^b cmp $^a };
 my constant @sortedr = @list.sort($reverse).List;
+my constant $batch   = 16;
 
 for 1, ParaSeq.default-degree {
     my $seq := @list.&hyperize($batch, $_).sort;

t/36-collate.rakutest

@@ -0,0 +1,17 @@
+use Test;
+use ParaSeq;
+
+plan 4;
+
+my constant $elems    = 200000;
+my constant @list     = (^$elems).reverse.map(*.Str).List;
+my constant @collated = @list.collate.List;
+my constant $batch    = 16;
+
+for 1, ParaSeq.default-degree {
+    my $seq := @list.&hyperize($batch, $_).collate;
+    isa-ok $seq, $_ == 1 ?? Seq !! ParaSeq;
+    is-deeply $seq.List, @collated, ".collate with degree = $_";
+}
+
+# vim: expandtab shiftwidth=4