NAME

Array::Iterator::Circular - A subclass of Array::Iterator to allow circular iteration

VERSION

This document describes version 0.131 of Array::Iterator::Circular (from Perl distribution Array-Iterator), released on 2021-09-26.

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();

DESCRIPTION

This iterator will loop continuosly as long as "next" or "get_next" is called. The "has_next" method will always return true (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.

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.

has_next: Since we endlessly loop, this will always return true (1).
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.
get_next: This method is now defined in terms of "next", since neither will even stop dispensing items, there is no need to differentiate.
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.
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.
get_loop_count: This method will tell you how many times the iterator has looped back to its start.

HOMEPAGE

Please visit the project's homepage at <https://metacpan.org/release/Array-Iterator>.

SOURCE

Source repository is at <https://github.com/perlancar/perl-Array-Iterator>.

AUTHOR

perlancar <perlancar@cpan.org>

ORIGINAL AUTHOR

stevan little, <stevan@iinteractive.com>

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 Dist::Zilla, 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.

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

ORIGINAL COPYRIGHT AND LICENSE

<http://www.iinteractive.com>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

BUGS

Please report any bugs or feature requests on the bugtracker website <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.