File Coverage

blib/lib/Array/Slice.pm

Criterion	Covered	Total	%
statement	13	13	100.0
branch	2	2	100.0
condition			n/a
subroutine	5	5	100.0
pod	1	1	100.0
total	21	21	100.0

# $Id: Slice.pm,v 1.11 2007/04/16 07:33:29 dk Exp $
package Array::Slice;

use strict;
use warnings;
use Want qw(howmany);

our $VERSION = '0.03';
use base qw(DynaLoader Exporter);

our @EXPORT_OK   = qw(reset slice);
our %EXPORT_TAGS = ( all => \@EXPORT_OK);

bootstrap Array::Slice $VERSION;

sub slice(\@;$) { array_slice( $_[0], $#_ ? $_[1] : howmany) }

1;

=pod

=head1 NAME

Array::Slice - context-dependent array iterator

=head1 SYNOPSIS

    use Array::Slice qw(slice);

Iterate over an array assigning several items per cycle. Three:

    while ( my ( $x, $y, $z) = slice @arr) { ... }

or two:

    while ( my ( undef, $second) = slice @arr) { ... }

or even forty-two:

    while ( @a = slice @arr, 42) { ... }

=head1 DESCRIPTION

I've always wanted the power of C to be applied to arrays
working with more than one item at a time. Perl6 does it, Perl5 with source
filtering can do it, close, but no cigar. This module is an small step towards
the idea, an attempt to produce a way of slicing a single array with least
obtrusive syntax I can think of.

The module works by attaching an integer counter to each scalar using perl
magic API, advancing the counter on each slice.

=over

=item slice @array, [ $howmany ]

Iterates over an array, returning C<$howmany> items perl call. If called without C<$howmany>,
deduces the number depending on the calling context.

=item reset @array, [ $whereto ]

Resets the array iterator to C<$whereto> or 0. C<$whereto> can be negavtive, as in
native array indexing.

=back

=head1 BUGS

Array items are copied, not aliased as in C/C.

Doesn't work with lists. This is one big TODO.

=head1 SEE ALSO

L, L, L, L,
Synopsis 04(The 'for' statement).

=head1 THANKS

Aaron Crane for implementation of L, which code was used as base
for this module.

=head1 AUTHOR

Dmitry Karasik, [e-mail].

=cut