GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  ARRAY::ITERATOR::CIRCULAR (3)

.ds Aq ’

NAME

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

CONTENTS

VERSION

version 0.11

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

BUGS

None that I am aware of, if you find a bug, let me know, and I will be sure to fix it.

CODE COVERAGE

See the <B>CODE COVERAGEB> section of the <B>Array::IteratorB> documentation for information about the code coverage of this module’s test suite.

SEE ALSO

This is a subclass of <B>Array::IteratorB>, please refer to it for more documenation.

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.

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Steven Haryanto.

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 ARRAY::ITERATOR::CIRCULAR (3) 2013-09-18

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.