.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 "LaTeXML::Core::Array 3pm" .TH LaTeXML::Core::Array 3pm "2021-05-20" "perl v5.32.1" "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" "LaTeXML::Core::Array" \- support for Arrays of objects .SH "DESCRIPTION" .IX Header "DESCRIPTION" Provides a representation of arrays of digested objects. It extends LaTeXML::Common::Object. .SS "Methods" .IX Subsection "Methods" .ie n .IP """LaTeXML::Core::Array\->new(%options);""" 4 .el .IP "\f(CWLaTeXML::Core::Array\->new(%options);\fR" 4 .IX Item "LaTeXML::Core::Array->new(%options);" Creates an Array object Options are values List of values; typically Tokens, initially. type The type of objects (as a ParameterType) .Sp The following are Tokens lists that are used for reverting to raw TeX, each can be undef open the opening delimiter eg \*(L"{\*(R" close the closing delimiter eg \*(L"}\*(R" separator the separator between items, eg \*(L",\*(R" itemopen the opening delimiter for each item itemclose the closing delimiter for each item .SS "Accessors" .IX Subsection "Accessors" .ie n .IP """$value = $array\->getValue($n)""" 4 .el .IP "\f(CW$value = $array\->getValue($n)\fR" 4 .IX Item "$value = $array->getValue($n)" Return the \f(CW$n\fR\-th item in the list. .ie n .IP """$array\->setValue($n,$value)""" 4 .el .IP "\f(CW$array\->setValue($n,$value)\fR" 4 .IX Item "$array->setValue($n,$value)" Sets the \f(CW$n\fR\-th value to \f(CW$value\fR. .ie n .IP """@values = $keyval\->getValues();""" 4 .el .IP "\f(CW@values = $keyval\->getValues();\fR" 4 .IX Item "@values = $keyval->getValues();" Return the list of values. .ie n .IP """$keyval\->beDigested;""" 4 .el .IP "\f(CW$keyval\->beDigested;\fR" 4 .IX Item "$keyval->beDigested;" Return a new \f(CW\*(C`LaTeXML::Core::Array\*(C'\fR object with all values digested as appropriate. .SH "AUTHOR" .IX Header "AUTHOR" Bruce Miller .SH "COPYRIGHT" .IX Header "COPYRIGHT" Public domain software, produced as part of work done by the United States Government & not subject to copyright in the \s-1US.\s0