1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
package Array::Iterator::Circular;
use strict;
use warnings;
use Array::Iterator;
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2021-09-26'; # DATE
our $DIST = 'Array-Iterator'; # DIST
our $VERSION = '0.131'; # VERSION
our @ISA = qw(Array::Iterator);
sub _init {
my ($self, @args) = @_;
$self->{loop_counter} = 0;
$self->SUPER::_init(@args);
}
# always return true, since
# we just keep looping
sub has_next { 1 }
sub next {
my ($self) = @_;
unless ($self->_current_index < $self->getLength()) {
$self->_current_index = 0;
$self->{loop_counter}++;
}
$self->_iterated = 1;
return $self->_getItem($self->_iteratee(), $self->_current_index++);
}
# since neither of them will
# ever stop dispensing items
# they can just be aliases of
# one another.
*get_next = \&next;
sub is_start {
my ($self) = @_;
return ($self->_current_index() == 0);
}
sub isStart { my $self = shift; $self->is_start(@_) }
sub is_end {
my ($self) = @_;
return ($self->_current_index() == $self->getLength());
}
sub isEnd { my $self = shift; $self->is_end(@_) }
sub get_loop_count {
my ($self) = @_;
return $self->{loop_counter};
}
sub getLoopCount { my $self = shift; $self->get_loop_count(@_) }
1;
# ABSTRACT: A subclass of Array::Iterator to allow circular iteration
__END__
=pod
=encoding UTF-8
=head1 NAME
Array::Iterator::Circular - A subclass of Array::Iterator to allow circular iteration
=head1 VERSION
This document describes version 0.131 of Array::Iterator::Circular (from Perl distribution Array-Iterator), released on 2021-09-26.
=head1 SYNOPSIS
use Array::Iterator::Circular;
# create an instance with a
# small array
my $color_iterator = Array::Iterator::Circular->new(qw(red green blue orange));
# this is a large list of
# arbitrary items
my @long_list_of_items = ( ... );
# as we loop through the items ...
foreach my $item (@long_list_of_items) {
# we assign color from our color
# iterator, which will keep dispensing
# as it loops through its set
$item->set_color($color_iterator->next());
}
# tell us how many times the set
# was looped through
print $color_iterator->get_loop_count();
=head1 DESCRIPTION
This iterator will loop continuosly as long as C<next> or C<get_next> is called. The C<has_next> method will always return true (C<1>), since the list will always loop back. This is useful when you need a list to repeat itself, but don't want to (or care to) know that it is doing so.
=for Pod::Coverage .+
=head1 METHODS
This is a subclass of Array::Iterator, only those methods that have been added or altered are documented here, refer to the Array::Iterator documentation for more information.
=over 4
=item B<has_next>
Since we endlessly loop, this will always return true (C<1>).
=item B<next>
This will return the next item in the array, and when it reaches the end of the array, it will loop back to the beginning again.
=item B<get_next>
This method is now defined in terms of C<next>, since neither will even stop dispensing items, there is no need to differentiate.
=item B<is_start>
If at anytime during your looping, you want to know if you have arrived back at the start of you list, you can ask this method.
=item B<is_end>
If at anytime during your looping, you want to know if you have gotten to the end of you list, you can ask this method.
=item B<get_loop_count>
This method will tell you how many times the iterator has looped back to its start.
=back
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/Array-Iterator>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-Array-Iterator>.
=head1 SEE ALSO
This is a subclass of B<Array::Iterator>, please refer to it for more documentation.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 ORIGINAL AUTHOR
stevan little, E<lt>stevan@iinteractive.comE<gt>
=head1 CONTRIBUTING
To contribute, you can send patches by email/via RT, or send pull requests on
GitHub.
Most of the time, you don't need to build the distribution yourself. You can
simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your
system), you can install L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>, and sometimes one or two other
Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required
beyond that are considered a bug and can be reported to me.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2021, 2017, 2013, 2012, 2011 by perlancar <perlancar@cpan.org>.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=head1 ORIGINAL COPYRIGHT AND LICENSE
Copyright 2004 by Infinity Interactive, Inc.
L<http://www.iinteractive.com>
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=Array-Iterator>
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=cut
|
