Initial commit of OpenSPARC T2 design and verification files.

[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man1 / perllol.1

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "PERLLOL 1"
.TH PERLLOL 1 "2002-06-08" "perl v5.8.0" "Perl Programmers Reference Guide"
.SH "NAME"
perllol \- Manipulating Arrays of Arrays in Perl
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.Sh "Declaration and Access of Arrays of Arrays"
.IX Subsection "Declaration and Access of Arrays of Arrays"
The simplest thing to build is an array of arrays (sometimes imprecisely
called a list of lists).  It's reasonably easy to understand, and
almost everything that applies here will also be applicable later
on with the fancier data structures.
.PP
An array of an array is just a regular old array \f(CW@AoA\fR that you can
get at with two subscripts, like \f(CW$AoA[3][2]\fR.  Here's a declaration
of the array:
.PP
.Vb 6
\&    # assign to our array, an array of array references
\&    @AoA = (
\&           [ "fred", "barney" ],
\&           [ "george", "jane", "elroy" ],
\&           [ "homer", "marge", "bart" ],
\&    );
.Ve
.PP
.Vb 2
\&    print $AoA[2][2];
\&  bart
.Ve
.PP
Now you should be very careful that the outer bracket type
is a round one, that is, a parenthesis.  That's because you're assigning to
an \f(CW@array\fR, so you need parentheses.  If you wanted there \fInot\fR to be an \f(CW@AoA\fR,
but rather just a reference to it, you could do something more like this:
.PP
.Vb 6
\&    # assign a reference to array of array references
\&    $ref_to_AoA = [
\&        [ "fred", "barney", "pebbles", "bambam", "dino", ],
\&        [ "homer", "bart", "marge", "maggie", ],
\&        [ "george", "jane", "elroy", "judy", ],
\&    ];
.Ve
.PP
.Vb 1
\&    print $ref_to_AoA->[2][2];
.Ve
.PP
Notice that the outer bracket type has changed, and so our access syntax
has also changed.  That's because unlike C, in perl you can't freely
interchange arrays and references thereto.  \f(CW$ref_to_AoA\fR is a reference to an
array, whereas \f(CW@AoA\fR is an array proper.  Likewise, \f(CW$AoA[2]\fR is not an
array, but an array ref.  So how come you can write these:
.PP
.Vb 2
\&    $AoA[2][2]
\&    $ref_to_AoA->[2][2]
.Ve
.PP
instead of having to write these:
.PP
.Vb 2
\&    $AoA[2]->[2]
\&    $ref_to_AoA->[2]->[2]
.Ve
.PP
Well, that's because the rule is that on adjacent brackets only (whether
square or curly), you are free to omit the pointer dereferencing arrow.
But you cannot do so for the very first one if it's a scalar containing
a reference, which means that \f(CW$ref_to_AoA\fR always needs it.
.Sh "Growing Your Own"
.IX Subsection "Growing Your Own"
That's all well and good for declaration of a fixed data structure,
but what if you wanted to add new elements on the fly, or build
it up entirely from scratch?
.PP
First, let's look at reading it in from a file.  This is something like
adding a row at a time.  We'll assume that there's a flat file in which
each line is a row and each word an element.  If you're trying to develop an
\&\f(CW@AoA\fR array containing all these, here's the right way to do that:
.PP
.Vb 4
\&    while (<>) {
\&        @tmp = split;
\&        push @AoA, [ @tmp ];
\&    }
.Ve
.PP
You might also have loaded that from a function:
.PP
.Vb 3
\&    for $i ( 1 .. 10 ) {
\&        $AoA[$i] = [ somefunc($i) ];
\&    }
.Ve
.PP
Or you might have had a temporary variable sitting around with the
array in it.
.PP
.Vb 4
\&    for $i ( 1 .. 10 ) {
\&        @tmp = somefunc($i);
\&        $AoA[$i] = [ @tmp ];
\&    }
.Ve
.PP
It's very important that you make sure to use the \f(CW\*(C`[]\*(C'\fR array reference
constructor.  That's because this will be very wrong:
.PP
.Vb 1
\&    $AoA[$i] = @tmp;
.Ve
.PP
You see, assigning a named array like that to a scalar just counts the
number of elements in \f(CW@tmp\fR, which probably isn't what you want.
.PP
If you are running under \f(CW\*(C`use strict\*(C'\fR, you'll have to add some
declarations to make it happy:
.PP
.Vb 6
\&    use strict;
\&    my(@AoA, @tmp);
\&    while (<>) {
\&        @tmp = split;
\&        push @AoA, [ @tmp ];
\&    }
.Ve
.PP
Of course, you don't need the temporary array to have a name at all:
.PP
.Vb 3
\&    while (<>) {
\&        push @AoA, [ split ];
\&    }
.Ve
.PP
You also don't have to use \fIpush()\fR.  You could just make a direct assignment
if you knew where you wanted to put it:
.PP
.Vb 5
\&    my (@AoA, $i, $line);
\&    for $i ( 0 .. 10 ) {
\&        $line = <>;
\&        $AoA[$i] = [ split ' ', $line ];
\&    }
.Ve
.PP
or even just
.PP
.Vb 4
\&    my (@AoA, $i);
\&    for $i ( 0 .. 10 ) {
\&        $AoA[$i] = [ split ' ', <> ];
\&    }
.Ve
.PP
You should in general be leery of using functions that could
potentially return lists in scalar context without explicitly stating
such.  This would be clearer to the casual reader:
.PP
.Vb 4
\&    my (@AoA, $i);
\&    for $i ( 0 .. 10 ) {
\&        $AoA[$i] = [ split ' ', scalar(<>) ];
\&    }
.Ve
.PP
If you wanted to have a \f(CW$ref_to_AoA\fR variable as a reference to an array,
you'd have to do something like this:
.PP
.Vb 3
\&    while (<>) {
\&        push @$ref_to_AoA, [ split ];
\&    }
.Ve
.PP
Now you can add new rows.  What about adding new columns?  If you're
dealing with just matrices, it's often easiest to use simple assignment:
.PP
.Vb 5
\&    for $x (1 .. 10) {
\&        for $y (1 .. 10) {
\&            $AoA[$x][$y] = func($x, $y);
\&        }
\&    }
.Ve
.PP
.Vb 3
\&    for $x ( 3, 7, 9 ) {
\&        $AoA[$x][20] += func2($x);
\&    }
.Ve
.PP
It doesn't matter whether those elements are already
there or not: it'll gladly create them for you, setting
intervening elements to \f(CW\*(C`undef\*(C'\fR as need be.
.PP
If you wanted just to append to a row, you'd have
to do something a bit funnier looking:
.PP
.Vb 2
\&    # add new columns to an existing row
\&    push @{ $AoA[0] }, "wilma", "betty";
.Ve
.PP
Notice that I \fIcouldn't\fR say just:
.PP
.Vb 1
\&    push $AoA[0], "wilma", "betty";  # WRONG!
.Ve
.PP
In fact, that wouldn't even compile.  How come?  Because the argument
to \fIpush()\fR must be a real array, not just a reference to such.
.Sh "Access and Printing"
.IX Subsection "Access and Printing"
Now it's time to print your data structure out.  How
are you going to do that?  Well, if you want only one
of the elements, it's trivial:
.PP
.Vb 1
\&    print $AoA[0][0];
.Ve
.PP
If you want to print the whole thing, though, you can't
say
.PP
.Vb 1
\&    print @AoA;         # WRONG
.Ve
.PP
because you'll get just references listed, and perl will never
automatically dereference things for you.  Instead, you have to
roll yourself a loop or two.  This prints the whole structure,
using the shell-style \fIfor()\fR construct to loop across the outer
set of subscripts.
.PP
.Vb 3
\&    for $aref ( @AoA ) {
\&        print "\et [ @$aref ],\en";
\&    }
.Ve
.PP
If you wanted to keep track of subscripts, you might do this:
.PP
.Vb 3
\&    for $i ( 0 .. $#AoA ) {
\&        print "\et elt $i is [ @{$AoA[$i]} ],\en";
\&    }
.Ve
.PP
or maybe even this.  Notice the inner loop.
.PP
.Vb 5
\&    for $i ( 0 .. $#AoA ) {
\&        for $j ( 0 .. $#{$AoA[$i]} ) {
\&            print "elt $i $j is $AoA[$i][$j]\en";
\&        }
\&    }
.Ve
.PP
As you can see, it's getting a bit complicated.  That's why
sometimes is easier to take a temporary on your way through:
.PP
.Vb 6
\&    for $i ( 0 .. $#AoA ) {
\&        $aref = $AoA[$i];
\&        for $j ( 0 .. $#{$aref} ) {
\&            print "elt $i $j is $AoA[$i][$j]\en";
\&        }
\&    }
.Ve
.PP
Hmm... that's still a bit ugly.  How about this:
.PP
.Vb 7
\&    for $i ( 0 .. $#AoA ) {
\&        $aref = $AoA[$i];
\&        $n = @$aref - 1;
\&        for $j ( 0 .. $n ) {
\&            print "elt $i $j is $AoA[$i][$j]\en";
\&        }
\&    }
.Ve
.Sh "Slices"
.IX Subsection "Slices"
If you want to get at a slice (part of a row) in a multidimensional
array, you're going to have to do some fancy subscripting.  That's
because while we have a nice synonym for single elements via the
pointer arrow for dereferencing, no such convenience exists for slices.
(Remember, of course, that you can always write a loop to do a slice
operation.)
.PP
Here's how to do one operation using a loop.  We'll assume an \f(CW@AoA\fR
variable as before.
.PP
.Vb 5
\&    @part = ();
\&    $x = 4;
\&    for ($y = 7; $y < 13; $y++) {
\&        push @part, $AoA[$x][$y];
\&    }
.Ve
.PP
That same loop could be replaced with a slice operation:
.PP
.Vb 1
\&    @part = @{ $AoA[4] } [ 7..12 ];
.Ve
.PP
but as you might well imagine, this is pretty rough on the reader.
.PP
Ah, but what if you wanted a \fItwo-dimensional slice\fR, such as having
\&\f(CW$x\fR run from 4..8 and \f(CW$y\fR run from 7 to 12?  Hmm... here's the simple way:
.PP
.Vb 6
\&    @newAoA = ();
\&    for ($startx = $x = 4; $x <= 8; $x++) {
\&        for ($starty = $y = 7; $y <= 12; $y++) {
\&            $newAoA[$x - $startx][$y - $starty] = $AoA[$x][$y];
\&        }
\&    }
.Ve
.PP
We can reduce some of the looping through slices
.PP
.Vb 3
\&    for ($x = 4; $x <= 8; $x++) {
\&        push @newAoA, [ @{ $AoA[$x] } [ 7..12 ] ];
\&    }
.Ve
.PP
If you were into Schwartzian Transforms, you would probably
have selected map for that
.PP
.Vb 1
\&    @newAoA = map { [ @{ $AoA[$_] } [ 7..12 ] ] } 4 .. 8;
.Ve
.PP
Although if your manager accused of seeking job security (or rapid
insecurity) through inscrutable code, it would be hard to argue. :\-)
If I were you, I'd put that in a function:
.PP
.Vb 5
\&    @newAoA = splice_2D( \e@AoA, 4 => 8, 7 => 12 );
\&    sub splice_2D {
\&        my $lrr = shift;        # ref to array of array refs!
\&        my ($x_lo, $x_hi,
\&            $y_lo, $y_hi) = @_;
.Ve
.PP
.Vb 4
\&        return map {
\&            [ @{ $lrr->[$_] } [ $y_lo .. $y_hi ] ]
\&        } $x_lo .. $x_hi;
\&    }
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIperldata\fR\|(1), \fIperlref\fR\|(1), \fIperldsc\fR\|(1)
.SH "AUTHOR"
.IX Header "AUTHOR"
Tom Christiansen <\fItchrist@perl.com\fR>
.PP
Last update: Thu Jun  4 16:16:23 \s-1MDT\s0 1998