Skip to content

Commit 409249f

Browse files
committed
First stage adapting methods from Seq refs #1897
1 parent 295e59b commit 409249f

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

doc/Type/HyperSeq.pod6

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
=begin pod
2+
3+
=TITLE class HyperSeq
4+
5+
=SUBTITLE An object for performing batches of work in parallel with ordered
6+
output
7+
8+
class HyperSeq does Iterable does Sequence { }
9+
10+
An HyperSeq is the intermediate object used when the operator
11+
L<C<hyper>|/routine/hyper> is invoked on a L<C<Seq>|/type/Seq>. In general,
12+
it's not intended for direct consumption by the developer.
13+
14+
=head1 Methods
15+
16+
17+
=head2 method iterator
18+
19+
method iterator(HyperSeq:D: --> Iterator:D)
20+
21+
Returns the underlying iterator.
22+
23+
=head2 method is-lazy
24+
25+
method is-lazy(--> False )
26+
27+
Returns C<False>.
28+
29+
30+
=head2 method sink
31+
32+
Defined as:
33+
34+
method sink(--> Nil)
35+
36+
Sinks the underlying data structure, producing any side effects.
37+
38+
=end pod
39+
40+
# vim: expandtab softtabstop=4 shiftwidth=4 ft=perl6

0 commit comments

Comments
 (0)