.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Statistics::R::REXP::List 3pm"
.TH Statistics::R::REXP::List 3pm "2022-02-10" "perl v5.34.0" "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"
Statistics::R::REXP::List \- an R generic vector (list)
.SH "VERSION"
.IX Header "VERSION"
version 1.0002
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Statistics::R::REXP::List
\&    
\&    my $vec = Statistics::R::REXP::List\->new([
\&        1, \*(Aq\*(Aq, \*(Aqfoo\*(Aq, [\*(Aqx\*(Aq, 22]
\&    ]);
\&    print $vec\->elements;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
An object of this class represents an R list, also called a generic
vector (\f(CW\*(C`VECSXP\*(C'\fR). List elements can themselves be lists, and so can
form a tree structure.
.SH "METHODS"
.IX Header "METHODS"
\&\f(CW\*(C`Statistics::R::REXP:List\*(C'\fR inherits from
Statistics::R::REXP::Vector, with no added restrictions on the value
of its elements. Missing values (\f(CW\*(C`NA\*(C'\fR in R) have value \f(CW\*(C`undef\*(C'\fR.
.IP "sexptype" 4
.IX Item "sexptype"
\&\s-1SEXPTYPE\s0 of generic vectors is \f(CW\*(C`VECSXP\*(C'\fR.
.IP "to_pl" 4
.IX Item "to_pl"
Perl value of the list is an array reference to the Perl values of its
\&\f(CW\*(C`elements\*(C'\fR, but using a scalar value to represent elements that are
atomic vectors of length 1, rather than a one-element array reference.
.Sp
The idea is that in R, \f(CW\*(C`1:3\*(C'\fR, and \f(CW\*(C`list(1, 2, 3)\*(C'\fR can often be used
interchangeably, even though the list is really composed of three
integer vectors, each of length one. Now, both will have native Perl
representation of \f(CW\*(C`[1, 2, 3]\*(C'\fR.
.Sp
This only applies to elements that are atomic vectors. An element of
type list will always be represented as an array reference:
.Sp
\&\f(CW\*(C`list(list(1), list(2), list(3))\->to_pl\*(C'\fR \-> \f(CW\*(C`[ [ 1 ], [ 2 ], [ 3 ] ]\*(C'\fR
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
Classes in the \f(CW\*(C`REXP\*(C'\fR hierarchy are intended to be immutable. Please
do not try to change their value or attributes.
.PP
There are no known bugs in this module. Please see
Statistics::R::IO for bug reporting.
.SH "SUPPORT"
.IX Header "SUPPORT"
See Statistics::R::IO for support and contact information.
.SH "AUTHOR"
.IX Header "AUTHOR"
Davor Cubranic <cubranic@stat.ubc.ca>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2017 by University of British Columbia.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The GNU General Public License, Version 3, June 2007
.Ve