Add built local::lib

[catagits/Gitalist.git] / local-lib5 / man / man3 / Moose::Autobox::Array.3pm

.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Moose::Autobox::Array 3"
.TH Moose::Autobox::Array 3 "2009-10-12" "perl v5.8.7" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Moose::Autobox::Array \- the Array role
.SH "SYNOPOSIS"
.IX Header "SYNOPOSIS"
.Vb 1
\&  use Moose::Autobox;
\&    
\&  [ 1..5 ]\->isa(\*(AqARRAY\*(Aq); # true
\&  [ a..z ]\->does(\*(AqMoose::Autobox::Array\*(Aq); # true
\&  [ 0..2 ]\->does(\*(AqMoose::Autobox::List\*(Aq); # true  
\&    
\&  print "Squares: " . [ 1 .. 10 ]\->map(sub { $_ * $_ })\->join(\*(Aq, \*(Aq);
\&  
\&  print [ 1, \*(Aqnumber\*(Aq ]\->sprintf(\*(Aq%d is the loneliest %s\*(Aq);
\&  
\&  print ([ 1 .. 5 ]\->any == 3) ? \*(Aqtrue\*(Aq : \*(Aqfalse\*(Aq; # prints \*(Aqtrue\*(Aq
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a role to describe operations on the Array type.
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBpop\fR" 4
.IX Item "pop"
.PD 0
.IP "\fBpush ($value)\fR" 4
.IX Item "push ($value)"
.IP "\fBshift\fR" 4
.IX Item "shift"
.IP "\fBunshift ($value)\fR" 4
.IX Item "unshift ($value)"
.IP "\fBdelete ($index)\fR" 4
.IX Item "delete ($index)"
.IP "\fBsprintf ($format_string)\fR" 4
.IX Item "sprintf ($format_string)"
.IP "\fBslice (@indices)\fR" 4
.IX Item "slice (@indices)"
.IP "\fBflatten\fR" 4
.IX Item "flatten"
.IP "\fBflatten_deep ($depth)\fR" 4
.IX Item "flatten_deep ($depth)"
.PD
.SS "Indexed implementation"
.IX Subsection "Indexed implementation"
.IP "\fBat ($index)\fR" 4
.IX Item "at ($index)"
.PD 0
.ie n .IP "\fBput ($index, \fB$value\fB)\fR" 4
.el .IP "\fBput ($index, \f(CB$value\fB)\fR" 4
.IX Item "put ($index, $value)"
.IP "\fBexists ($index)\fR" 4
.IX Item "exists ($index)"
.IP "\fBkeys\fR" 4
.IX Item "keys"
.IP "\fBvalues\fR" 4
.IX Item "values"
.IP "\fBkv\fR" 4
.IX Item "kv"
.IP "\fBeach\fR" 4
.IX Item "each"
.IP "\fBeach_key\fR" 4
.IX Item "each_key"
.IP "\fBeach_value\fR" 4
.IX Item "each_value"
.PD
.SS "List implementation"
.IX Subsection "List implementation"
.IP "\fBhead\fR" 4
.IX Item "head"
.PD 0
.IP "\fBtail\fR" 4
.IX Item "tail"
.IP "\fBjoin (?$seperator)\fR" 4
.IX Item "join (?$seperator)"
.IP "\fBlength\fR" 4
.IX Item "length"
.IP "\fBmap (\e&block)\fR" 4
.IX Item "map (&block)"
.IP "\fBgrep (\e&block)\fR" 4
.IX Item "grep (&block)"
.PD
Note that, in both the above, \f(CW$_\fR is in scope within the code block, as well as 
being passed as \f(CW$_\fR[0]. As per CORE::map and CORE::grep, \f(CW$_\fR is an alias to 
the list value, so can be used to to modify the list, viz:
.Sp
.Vb 1
\&    use Moose::Autobox;
\&
\&    my $foo = [1, 2, 3]; 
\&    $foo\->map( sub {$_++} ); 
\&    print $foo\->dump;
.Ve
.Sp
yields
.Sp
.Vb 5
\&   $VAR1 = [
\&             2,
\&             3,
\&             4
\&           ];
.Ve
.IP "\fBreverse\fR" 4
.IX Item "reverse"
.PD 0
.IP "\fBsort (?\e&block)\fR" 4
.IX Item "sort (?&block)"
.PD
.SS "Junctions"
.IX Subsection "Junctions"
.IP "\fBall\fR" 4
.IX Item "all"
.PD 0
.IP "\fBany\fR" 4
.IX Item "any"
.IP "\fBnone\fR" 4
.IX Item "none"
.IP "\fBone\fR" 4
.IX Item "one"
.IP "\fBmeta\fR" 4
.IX Item "meta"
.IP "\fBprint\fR" 4
.IX Item "print"
.IP "\fBsay\fR" 4
.IX Item "say"
.PD
.SH "BUGS"
.IX Header "BUGS"
All complex software has bugs lurking in it, and this module is no 
exception. If you find a bug please either email me, or add the bug
to cpan-RT.
.SH "AUTHOR"
.IX Header "AUTHOR"
Stevan Little <stevan@iinteractive.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2006\-2008 by Infinity Interactive, Inc.
.PP
<http://www.iinteractive.com>
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.