NAME

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

VERSION

       This document describes version 0.12 of Array::Iterator::Circular (from Perl distribution Array-
       Iterator), released on 2017-07-04.

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.

ORIGINAL AUTHOR

       stevan little, <stevan@iinteractive.com>

ORIGINAL COPYRIGHT AND LICENSE

       Copyright 2004 by Infinity Interactive, Inc.

       <http://www.iinteractive.com>

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

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/sharyanto/perl-Array-Iterator>.

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.

SEE ALSO

       This is a subclass of Array::Iterator, please refer to it for more documenation.

AUTHOR

       perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2017, 2013, 2012, 2011 by 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.

perl v5.30.0                                       2019-11-02                     Array::Iterator::Circular(3pm)