texlive[42467] Master/texmf-dist: readarray (8nov16)
commits+karl at tug.org
commits+karl at tug.org
Tue Nov 8 23:36:29 CET 2016
Revision: 42467
http://tug.org/svn/texlive?view=revision&revision=42467
Author: karl
Date: 2016-11-08 23:36:28 +0100 (Tue, 08 Nov 2016)
Log Message:
-----------
readarray (8nov16)
Modified Paths:
--------------
trunk/Master/texmf-dist/doc/latex/readarray/README
trunk/Master/texmf-dist/doc/latex/readarray/readarray.pdf
trunk/Master/texmf-dist/doc/latex/readarray/readarray.tex
trunk/Master/texmf-dist/tex/latex/readarray/readarray.sty
Modified: trunk/Master/texmf-dist/doc/latex/readarray/README
===================================================================
--- trunk/Master/texmf-dist/doc/latex/readarray/README 2016-11-08 22:36:17 UTC (rev 42466)
+++ trunk/Master/texmf-dist/doc/latex/readarray/README 2016-11-08 22:36:28 UTC (rev 42467)
@@ -1,12 +1,28 @@
The readarray package allows one to input formatted data into elements
-of a 2-D or 3-D array and to recall that data at will by individual cell
-number. The data can be but need not be numerical in nature. It can
-be, for example, formatted text.
+of a 2-D or 3-D array (or a 1-D file-record array). Subsequently, that
+data may be recalled at will using an array-cell indexing nomenclature.
+The data can be but need not be numerical in nature. It can be, for
+example, formatted text. In this regard, the array stores the
+unexpanded data from the file, if macros are present in the data.
+As of V2.0, the separator by which data is parsed may be customized by
+the user. A totally new package syntax has also been introduced (the
+prior syntax is retained as deprecated macros). Various levels of bound
+checking are now available to the user.
+
While the package can be used for any application where indexed data is
called for, the package proves particularly useful when elements of
multiple arrays must be recallable and dynamically combined at time of
compilation, rather than in advance.
-When data is read from an input file, it may also be accessed by file
-record (1-D access), in addition to 2-D or 3-D array-cell access.
+This work may be distributed and/or modified under the
+conditions of the LaTeX Project Public License, either version 1.3
+of this license or (at your option) any later version.
+The latest version of this license is in
+
+ http://www.latex-project.org/lppl.txt
+
+and version 1.3c or later is part of all distributions of LaTeX
+version 2005/12/01 or later.
+
+The Current Maintainer of this work is Steven B. Segletes.
Modified: trunk/Master/texmf-dist/doc/latex/readarray/readarray.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/readarray/readarray.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/readarray/readarray.tex 2016-11-08 22:36:17 UTC (rev 42466)
+++ trunk/Master/texmf-dist/doc/latex/readarray/readarray.tex 2016-11-08 22:36:28 UTC (rev 42467)
@@ -1,5 +1,4 @@
\documentclass{article}
-\def\version{1.3}
%% Copyright 2013 Steven B. Segletes
%
% This work may be distributed and/or modified under the
@@ -22,13 +21,53 @@
% to avoid unnecessary use of counters.
% v1.3 -Moved \newread outside of \readdef, so as not to exhaust the
% 16 allotted file streams (Thanks to Ken Kubota for the tip).
-
+\usepackage{tabstackengine}[2016-10-04]
+\usepackage{lmodern}
+\usepackage[T1]{fontenc}
\parskip 1em
\parindent 0em
\newcommand\rl{\rule{1em}{0in}}
\def\rdar{\textsf{readarray}}
+\def\loi{\textsf{listofitems}}
+\def\cmd#1{\texttt{\string\ \unskip#1}}
\usepackage{readarray}
\usepackage{verbatimbox}
+\usepackage{filecontents}
+\begin{filecontents*}{file1data.txt}
+A111 A112 A113 A114
+A121 A122 A123 A124
+A131 A132 A133 A134
+
+A211 A212 A213 A214
+A221 A222 A223 A224
+A231 A232 A233 A234
+\end{filecontents*}
+\begin{filecontents*}{file2data.txt}
+\def{\dataA}{%
+A111 A112 A113 A114
+A121 A122 A123 A124
+A131 A132 A133 A134
+%
+A211 A212 A213 A214
+A221 A222 A223 A224
+A231 A232 A233 A234
+}
+\end{filecontents*}
+\begin{filecontents*}{file3data.txt}
+\textit{am} , \textit{are}, have \textit{been}, have \textit{been}
+\textit{are}, \textit{are} , have \textit{been}, have \textit{been}
+\textit{is} , \textit{are} , has \textit{been} , have \textit{been}
+
+\textit{was} , \textit{were}, had \textit{been}, had \textit{been}
+\textit{were}, \textit{were}, had \textit{been}, had \textit{been}
+\textit{was} , \textit{were}, had \textit{been}, had \textit{been}
+
+will \textit{be}, will \textit{be}, will have \textit{been}, will have \textit{been}
+will \textit{be}, will \textit{be}, will have \textit{been}, will have \textit{been}
+will \textit{be}, will \textit{be}, will have \textit{been}, will have \textit{been}
+\end{filecontents*}
+
+
\let\vb\verb
\def\bs{{\ttfamily\char'134}}
\reversemarginpar
@@ -39,113 +78,212 @@
\begin{center}
\LARGE The {\rdar} Package\\
\rule{0em}{.7em}\small Routines for inputting formatted array data and
-recalling it on an element-by-element basis.\\Currently supports 2-D
-and 3-D array structures\\
+recalling it on an element-by-element basis.\\
\rule{0em}{2.7em}\large Steven B. Segletes\\
steven.b.segletes.civ at mail.mil\\
-\rule{0em}{1.7em}\today\\
-v\version
+\rule{0em}{1.7em}\readarrayPackageDate\\
+V\readarrayPackageVersion
\end{center}
+\section*{Comments About Version 2.0}
+
+Version 2.0 of the \rdar{} package has brought major changes,
+ including a \textit{new and improved} syntax.
+Functionally, the data-reading/parsing code of the package
+ has been revised to use the powerful \loi{} package.
+This has two primary advantages: 1) the data that is read is no
+ longer expanded prior to the read, so that macros can be read
+ and stored in the data arrays using their unexpanded tokens; and 2)
+ list separators other than a space may now be employed
+ to parse the data into array cells.
+
+While a newer preferred syntax has been introduced for reading and
+ recalling arrays, the deprecated syntax is still supported.
+The user will also note other small changes, such as the fact that errors
+ arising from array-boundary violations now appear in the log file
+ rather than the document itself.
+
\section{Description and Commands}
-The {\rdar} package allows for the inputting of data arrays (numeric,
-string, or even formatted) in either file form or \vb|\def| form, such
-that the elements of multiple arrays can be specified and later recalled
-in an orderly fashion, on a cell-by-cell basis. Routines have been
-developed to support the storage and recall of both 2-D and 3-D arrays.
+The {\rdar} package allows for the creation of data arrays (numeric,
+ string, or even formatted) using either file contents or \vb|\def|
+ format for input, such that the elements of multiple arrays can be
+ set and later recalled in an orderly fashion, on a cell-by-cell basis.
+Routines have been developed to support the storage and recall of both
+ 2-D and 3-D arrays, as well as 1-D file-record arrays.%
+\footnote{
+Note: for 1-D arrays that are to be simply parsed on the basis of a
+ specified separator, the \loi{} package is already prepared
+ to do this, without the help of this package.
+}
-The commands included in this package help the user input data, define
-it in terms of array elements and recall those elements at will. Those
-commands are:\\\itshape
-\rl\vb|\readdef{|filename\vb|}{|token\vb|}|\\
-\rl\vb|\showrecord[|error\vb|]{|record number\vb|}|\\
-\rl\vb|\copyrecords{|identifier\vb|}|\\
-\rl\vb|\readArrayij{|token\vb|}{|identifier\vb|}{|columns\vb|}|\\
-\rl\vb|\readArrayijk{|token\vb|}{|identifier\vb|}{|rows\vb|}{|columns\vb|}|\\
-\rl\vb|\Arrayij[|error\vb|]{|identifier\vb|}{|row\vb|}{|column\vb|}|\\
-\rl\vb|\Arrayijk[|error\vb|]{|identifier\vb|}{|plane\vb|}{|row\vb|}{|%
- column\vb|}|\\
-\rl\vb|\arrayij{|identifier\vb|}{|row\vb|}{|column\vb|}|\\
-\rl\vb|\arrayijk{|identifier\vb|}{|plane\vb|}{|row\vb|}{|%
- column\vb|}|\upshape
+\clearpage
+The commands included in this package help the user to input data, define
+it in terms of array elements, and recall those elements at will. Those
+commands are:
-Several strings of fixed name are defined through the use of this
-package which are accessible to the user:\\
+
+\itshape
+\textup{To place file data into a data macro:}\\
+\rl\vb|\readdef{|filename\vb|}\|data-macro\\
+\textup{To place file data into a 1-D file-record array:}\\
+\rl\vb|\readrecordarray{|filename\vb|}\|array-identifier\\
+\textup{To parse a data macro and place the results into a 2-D or 3-D array:}\\
+\rl\vb|\readarray\|data-macro\vb|\|array-identifier\vb|[-,|columns\vb|]|%
+ \hfill\textup{(2-D)}\\
+\rl\vb|\readarray\|data-macro\vb|\|array-identifier\vb|[-,|rows\vb|,|columns\vb|]|%
+ \hfill\textup{(3-D)}\\
+\textup{Same as above, with leading/trailing spaces removed from array cells:}\\
+\rl\vb|\readarray*\|data-macro\vb|\|array-identifier\vb|[-,|columns\vb|]|%
+ \hfill\textup{(2-D)}\\
+\rl\vb|\readarray*\|data-macro\vb|\|array-identifier\vb|[-,|rows\vb|,|columns\vb|]|%
+ \hfill\textup{(3-D)}\\
+\textup{Recall data from indexed array cell:}\\
+\rl\vb|\|array-identifier\vb|[|row\vb|,|column\vb|]|%
+ \hfill\textup{(2-D)}\\
+\rl\vb|\|array-identifier\vb|[|plane\vb|,|row\vb|,|column\vb|]|%
+ \hfill\textup{(3-D)}\\
+\textup{To place the actual tokens of an array cell into a macro:}\\
+\rl\vb|\arraytomacro\|array-identifier\vb|[-,|columns\vb|]\|macro%
+ \hfill\textup{(2-D)}\\
+\rl\vb|\arraytomacro\|array-identifier\vb|[-,|rows\vb|,|columns\vb|]\|macro%
+ \hfill\textup{(3-D)}\\
+\textup{To change the array-parsing separator character:}\\
+\rl\vb|\readarraysepchar{|parsing-separator-char\vb|}|\\
+\textup{To select the level of bounds checking on array cell recall:}\\
+\rl\vb|\nocheckbounds|\hfill OR\hfill%
+\vb|\checkbounds|\hfill OR\hfill%
+\vb|\hypercheckbounds|
+\upshape
+
+In these commands, \cmd{}\textit{data-macro} is a command sequence into
+ which the contents of \texttt{filename} are set into a \cmd{def}.
+The \textit{array-identifier} is a sequence of
+ (catcode 11) letters that identify the array.
+The starred version of the commands are used if, during the array
+ creation, it is desired to automatically excise the array data of
+ leading and trailing spaces.
+
+Unlike earlier versions of this package, where error messages were
+ output into the typeset document, error messages are now
+ set in the log file.
+The level of error messaging is defined by the level of bounds checking,
+ with \cmd{hypercheckbounds} providing the
+ most intense level of error checking.
+When a bounds-checking error is found in an array invocation, in addition
+ to the error message in the log file, a ``?'' is typeset in the document,
+ unless bound checking is disabled with \cmd{nocheckbounds}.
+
+
+Several strings of fixed name are defined through the use the
+\cmd{readdef} command, which are accessible to the user:
+
+\itshape
\rl\vb|\nrows|\\
\rl\vb|\ncols|\\
\rl\vb|\nrecords|\\
-\rl\vb|\record|\textit{index}
+\rl\vb|\ArrayRecord[|record\vb|]|%
+ \hfill\textup{(to retrieve record from most recent \cmd{readdef})}\upshape
-In addition to the strings of fixed name, there are various strings
-created whose name is a function of the user-specified data, such
-as\\\itshape
-\rl\vb|\|identifier\vb|CELLS|\\
-\rl\vb|\|identifier\vb|PLANES|\\
-\rl\vb|\|identifier\vb|ROWS|\\
-\rl\vb|\|identifier\vb|COLS|\\\upshape
-where \textit{identifier} is the alphabetic-character string by which
-you have designated a particular array. They will be discussed in
-relation to the commands that create these strings.
+The macros \cmd{nrows} and \cmd{ncols}, which were gleaned from the file
+ structure, may be used in the subsequent \cmd{readarray}
+ invocation to specify the array dimensions.
+Alternately, those values may be manually overridden by specifying
+ the desired values in the \cmd{readarray} invocation.
+Individual records of the original file, from the most recent
+ \cmd{readdef}, may be recalled with the
+ \cmd{ArrayRecord} macro.
+In addition to the strings of fixed name created during the
+ \cmd{readdef}, there are various strings created during
+ the \cmd{readarray} whose name is a function of the
+ \textit{array-identifier}, such as
+
+\itshape
+\rl\vb|\|array-identifier\vb|CELLS|\\
+\rl\vb|\|array-identifier\vb|PLANES|\\
+\rl\vb|\|array-identifier\vb|ROWS|\\
+\rl\vb|\|array-identifier\vb|COLS|\upshape
+
+where \textit{array-identifier} is the alphabetic-character string by which
+you have designated a particular array.
+Their meaning will be discussed later in this document.
+
Support routines which are generally not required directly by
the user for the specification and recall of data arrays, but which are
-useful to this package and in a variety of other circumstances include
-the following:\\\itshape
-\rl\vb|\getargsC{|token {\upshape or} string\vb|}|\\
-\rl\vb|\arg|index\\
-\rl\vb|\narg|\\
-\rl\vb|\showargs[|number\vb|]|\\\upshape
-\rl\vb|\def\converttilde{|T or F\vb|}|\upshape
+useful for debugging include
+the following:
-\begin{center}
-\vfill
-[\textsc{This Space Intentionally Left Blank}]
-\vfill
-\end{center}
-\clearpage
+\itshape
+
+\rl\vb|\arraydump\|array-identifier\\%
+\rl\vb|\scalardump\|array-identifier%
+\upshape
+
+These macros print out the complete array, in either a structured or
+ unstructured form, respectively.
+
\section{Data Structure}
The first requirement is to lay out a format for the data interface to
-this package. The {\rdar} package is set up to digest space-separated data.
-The format for the data organization is as follows, for 2-D arrays:
+ this package.
+The {\rdar} package is set up to digest data separated by a user-defined
+ separator character.
+The default separator is a space character but, as of V2.0, the separator
+ may be specified by way of \vb|\readarraysepchar{|\textit{separator}\vb|}|.
+The format for the data organization to be digested is as follows,
+ for 2-D arrays:
-\(
-\begin{array}{lllll}
-A_{11} &A_{12} &A_{13} & \ldots & A_{1\mathrm{(columns)}} \\
-A_{21} &A_{22} & \ldots && \\
+\TABstackTextstyle{\tiny}
+\setstackgap{L}{3pt}
+\newcommand\SEP{\,\langle\smash{\raisebox{1pt}{\tabbedCenterstack{s\\e\\p}}}\rangle\,}
+\renewcommand\arraystretch{1.1}
+{\arraycolsep=3pt\relax\small\(
+\begin{array}{lll@{\hspace{2pt}}ll}
+A_{11}\SEP &A_{12}\SEP &A_{13}\SEP & \ldots & A_{1\mathrm{(columns)}} \\
+A_{21}\SEP &A_{22}\SEP & \ldots && \\
\vdots&&&&\\
-A_{\mathrm{(rows)}1} &A_{\mathrm{(rows)}2} &A_{\mathrm{(rows)}3} &
+A_{\mathrm{(rows)}1}\SEP &A_{\mathrm{(rows)}2}\SEP &A_{\mathrm{(rows)}3}\SEP &
\ldots & A_{\mathrm{(rows)}\mathrm{(columns)}} \\
\end{array}
-\)
+\)}
-and for 3-D arrays:
+For 3-D arrays, the following structure is employed:
-\(
-\begin{array}{lllll}
-A_{111} &A_{112} &A_{113} & \ldots & A_{11\mathrm{(columns)}} \\
-A_{121} &A_{122} & \ldots && \\
+{\arraycolsep=3pt\relax\small\(
+\begin{array}{lll@{\hspace{2pt}}ll}
+A_{111}\SEP &A_{112}\SEP &A_{113}\SEP & \ldots & A_{11\mathrm{(columns)}} \\
+A_{121}\SEP &A_{122}\SEP & \ldots && \\
\vdots&&&&\\
-A_{1\mathrm{(rows)}1} &A_{1\mathrm{(rows)}2} &A_{1\mathrm{(rows)}3} &
+A_{1\mathrm{(rows)}1}\SEP &A_{1\mathrm{(rows)}2}\SEP &A_{1\mathrm{(rows)}3}\SEP &
\ldots & A_{1\mathrm{(rows)}\mathrm{(columns)}} \\
-&&&&\\
-A_{211} &A_{212} &A_{213} & \ldots & A_{21\mathrm{(columns)}} \\
-A_{221} &A_{222} & \ldots && \\
+\rlap{\scriptsize$<$blank line$>$}&&&&\\
+A_{211}\SEP &A_{212}\SEP &A_{213} & \ldots & A_{21\mathrm{(columns)}} \\
+A_{221}\SEP &A_{222}\SEP & \ldots && \\
\vdots&&&&\\
-A_{2\mathrm{(rows)}1} &A_{2\mathrm{(rows)}2} &A_{2\mathrm{(rows)}3} &
+A_{2\mathrm{(rows)}1}\SEP &A_{2\mathrm{(rows)}2}\SEP &A_{2\mathrm{(rows)}3}\SEP &
\ldots & A_{2\mathrm{(rows)}\mathrm{(columns)}} \\
&&&&\\
\vdots&&&&\\
&&&&\\
-A_{\mathrm{(planes)}11} &A_{\mathrm{(planes)}12} &A_{\mathrm{(planes)}13} & \ldots & A_{\mathrm{(planes)}1\mathrm{(columns)}} \\
-A_{\mathrm{(planes)}21} &A_{\mathrm{(planes)}22} & \ldots && \\
+A_{\mathrm{(planes)}11}\SEP &A_{\mathrm{(planes)}12}\SEP &A_{\mathrm{(planes)}13}\SEP & \ldots & A_{\mathrm{(planes)}1\mathrm{(columns)}} \\
+A_{\mathrm{(planes)}21}\SEP &A_{\mathrm{(planes)}22}\SEP & \ldots && \\
\vdots&&&&\\
-A_{\mathrm{(planes)}\mathrm{(rows)}1} &A_{\mathrm{(planes)}\mathrm{(rows)}2} &A_{\mathrm{(planes)}\mathrm{(rows)}3} &
+A_{\mathrm{(planes)}\mathrm{(rows)}1}\SEP &A_{\mathrm{(planes)}\mathrm{(rows)}2}\SEP &A_{\mathrm{(planes)}\mathrm{(rows)}3}\SEP &
\ldots & A_{\mathrm{(planes)}\mathrm{(rows)}\mathrm{(columns)}} \\
\end{array}
-\)
+\)}
+
+Here,\,$\SEP${}\,is the data separator that is used to parse the input.
+Terms like $A_{\mathrm{(plane)}\mathrm{(row)}\mathrm{(column)}}$ refers
+ to the \LaTeX{}-formatted data to be associated with the particlar plane,
+ row, and column of data.
+Note, that for 3-D arrays, a blank line can be used to signify to the
+ parsing algorithm the size of a data plane (alternately, the number of
+ rows per data plane can be explicitly provided to the \cmd{readarray}
+ command).
+
\section{Getting Data into Array Structures\label{s:ex}}
One can provide data to be digested by this package in one of two ways:
@@ -153,41 +291,56 @@
\vb|\def|. If one chooses the external file approach, the command
\vb|\readdef|\margcmd{readdef} is the command which can achieve this
result. The command takes two arguments. The first is the file in
-which the data is stored, while the second is the token into which the
-data will be placed, for example
+which the data is stored, while the second is the data macro into which the
+file's data will be placed, for example
-\rl\vb|\readdef{data.txt}{\dataA}|
+\rl\vb|\readdef{data.txt}{\dataA}|\readdef{file1data.txt}{\dataA}
In this case, the contents of the file \vb|data.txt| will be placed
-into the token \vb|\dataA|. At this point, the data is still not
-digested into a data ``array,'' but merely stuffed into a \vb|\def| (a
-\vb|\protected at edef| actually). Thus, there is no
-\textit{requirement} that carriage returns be part of the input file
-after each row of data, nor that blank lines exist between planes of
-data (if the data is 3-D). \textit{However}, there is a reason to do so,
-nonetheless. In particular, for datafiles that are organized in the
+ into the data macro \vb|\dataA|.
+Two alterations to the format occur during this conversion from file
+ to \cmd{def}: 1) blank lines in the file are ignored; and
+ 2) a data separator replaces the end-of-line.
+At this point, the data is still not digested into a 2-D or 3-D data
+ ``array.''
+However, two things have been accomplished: 1) the file contents are \cmd{def}'ed
+ into the data macro \cmd{dataA}; and 2) they are also placed into a 1-D
+ file record array, \cmd{ArrayRecord}.
+
+There is no
+\textit{requirement} that the input file be organized with structured rows
+ of data corresponding to individual file records, nor that blank
+ lines exist between planes of data (if the data is 3-D).
+\textit{However}, there is a reason to do so, nonetheless.
+In particular, for datafiles that are organized in the
preferred fashion, for example:
-\begin{verbbox}
-A111 A112 A113 A114
-A121 A122 A123 A124
-A131 A132 A133 A134
+\verbfilebox{file1data.txt}
+\rl\theverbbox
-A211 A212 A213 A214
-A221 A222 A223 A224
-A231 A232 A233 A234
-\end{verbbox}
-\tabcolsep 1em\begin{tabular}{l}
-\theverbbox
-\end{tabular}
+a \vb|\readdef| attempts to estimate the number columns, and
+ rows-per-plane of the dataset by analyzing the data structure.
+These estimates are given by
+ \vb|\ncols|\margcmd{ncols} and \vb|\nrows|\margcmd{nrows}, in this
+ case to values of \texttt{\ncols} and \texttt{\nrows}, respectively.
+Such data could prove useful if the array size is not known in advance.
+When \verb|\readdef| is invoked, a string
+ \verb|\nrecords|\margcmd{nrecords} will also be set to the number of
+ file records processed by the \vb|\readdef| command, in this case,
+ to \texttt{\nrecords}.
+Finally, the 1-D file-record array, \cmd{ArrayRecord}\margcmd{ArrayRecord},
+ is created to allow access to the most recently read file records.
+For example, \vb|\ArrayRecord[3]| produces: ``\ArrayRecord[3]''.
+Note, however, that the array, \cmd{ArrayRecord}, will be overwritten on
+ the subsequent invocation of \cmd{readdef}.
-a \vb|\readdef| will cause the following strings to be set:
-\vb|\ncols|\margcmd{ncols} and \vb|\nrows|\margcmd{nrows}, in this
-case to values of \vb|4| and \vb|3|, respectively. Such data could
-prove useful if the array size is not known in advance.
-When \verb|\readdef| is invoked, a string
-\verb|\nrecords|\margcmd{nrecords} will also be set to the number of
-file records processed by the \vb|\readdef| command.
+Because \cmd{ArrayRecord} is only a 1-D file-record array, the
+ \textit{actual} array metrics, given by \cmd{ArrayRecordCOLS},
+ \cmd{ArrayRecordROWS}, \cmd{ArrayRecordPLANES}, and
+ \cmd{ArrayRecordCELLS} are
+ \ArrayRecordCOLS, \ArrayRecordROWS, \ArrayRecordPLANES, and
+ \ArrayRecordCELLS, respectively, which do not align with the
+ estimations provided by \cmd{ncols} and \cmd{nrows}.
In lieu of \verb|\readdef|, a generally less preferred, but viable way
to make the data available is to cut and paste into a \vb|\def|.
@@ -197,307 +350,450 @@
\verb|\def| example at the top of the following page. Note that the
\vb|%| is also required at the end of the line containing \vb|\def|, in
order to guarantee that, in this case, \vb|A111| is the first element of
-data (and not a linebreak). However, unlike \vb|\readdef|, this
-definition will set the values of neither \vb|\ncols| nor \vb|\nrows|.
+data (and not a space separator). However, unlike \vb|\readdef|, this
+definition will neither set the value of \vb|\ncols| nor \vb|\nrows|.
-\begin{verbbox}[]
-\def{\dataA}{%
-A111 A112 A113 A114
-A121 A122 A123 A124
-A131 A132 A133 A134
-%
-A211 A212 A213 A214
-A221 A222 A223 A224
-A231 A232 A233 A234
+\verbfilebox{file2data.txt}
+\rl\theverbbox
+
+Once the data to be placed into an array is available in a macro,
+ by way of either
+ \vb|\readdef| or \vb|\def|, the command to digest the data into an
+ array is \vb|\readarray| for the case of 2-D or 3-D data.
+For 1-D file-record arrays, in contrast, the \cmd{readrecordarray}
+ command is used to go directly from a file into the 1-D array,
+ bypassing the intermediate step of a data macro.
+
+\subsection{1-D File-Record Arrays}
+
+If the desire is merely to parse a string of data based on a common
+ data separator, such as a comma or any other character, there is
+ no need to use the \rdar{} package.
+The \loi{} package, which is employed by \rdar, already has those provisions
+ and should be used directly.%
+\begin{verbbox}[\footnotesize]
+\setsepchar{ }
+\readlist\oneDlist{\dataA}
+\oneDlistlen{} list items, 12th item is ``\oneDlist[12]''.
+\end{verbbox}
+\footnote{%
+For a simple 1-D list punctuated by data separators, one may use the
+\loi{} package directly:\\
+\rl\theverbbox\\
+which produces the following output:
+\setsepchar{ }%
+\readlist\oneDlist{\dataA}%
+\oneDlistlen{} list items, 12th item is ``\oneDlist[12]''.
}
-\end{verbbox}
-\begin{tabular}{l}
-\theverbbox
-\end{tabular}
-Once the data to be placed into an array is available by way of either
-\vb|\readdef| or \vb|\def|, the command to digest the data into an array
-is either \vb|\readArrayij| (or \verb|\copyrecords|), in the case of 2-D
-data, or \vb|\readArrayijk|, for 3-D data.
+On the other hand, if one wishes a 1-D file-record array, in which each
+ array element corresponds to the record from a file, then \rdar{}
+ can be used.
+The command \cmd{readrecordarray} can be used to stick the individual
+ ``file records'' from a designated file into a 1-D array.
-\subsection{Creating 2-D Arrays}
+The \cmd{readrecordarray} command takes two arguments: a file
+ name containing data records, and the name of a 1-D record-array
+ into which to place the file records.
-In the case of \vb|\readArrayij|\margcmd{readArrayij}, the command
-takes three arguments. The first is the token into which the data had
-previously been stuffed. The second is an alphabetic-string identifier
-for the array, which can be one or more characters in length. Finally,
-the last argument is the number of columns in the array. If the data
-had been read by way of \vb|\readdef|, the string \vb|\ncols|
-may be used to signify this value.
+So, for example, with the invocation of
+ \vb|\readrecordarray{data.txt}\oneD|, the data from the file
+ \texttt{data.txt} is now saved in the \cmd{oneD} array, and can
+ be retrieved, for example, the 3rd record, with \cmd{oneD[3]}, which
+ returns \readrecordarray{file1data.txt}\oneD``\oneD[3]''.
-\subsection{Creating Pseudo-1-D Arrays}
+If an array name is reutilized, its prior definitions are cleared,
+ so that ``old'' data is not inadvertantly retrieved following the
+ reutilization.
-While the {\rdar} package has no explicit provisions for 1-D arrays, one
-could use the 2-D \verb|\readArrayij| command, with the third argument set
-to a value of unity \{1\}, instead of \verb|\ncols|. In this way, each
-space-separated word of the input file will be set to a new data row.
-While this approach is useful for sticking each ``word'' of input data
-into its own single-column data row, the command
-\verb|\copyrecords|\margcmd{copyrecords} can be used to stick the
-individual ``file records'' from the most recent \verb|\readdef| into a
-2-D array of \textbf{single-column width}. The \verb|\copyrecords| command takes
-as its argument an alphabetic string identifier to associate with the
-array of data. Its use accomplishes two things: 1) it allows records
-(rather than words) of a file to be accessed using the general
-\verb|\Arrayij| nomenclature to be discussed shortly; and 2) it saves
-the most recently read file data into its own data structure, so that it
-is not overwritten by a subsequent invocation of \verb|\readdef|.
-\subsection{Creating 3-D Arrays}
+\subsection{Creating 2-D and 3-D Arrays}
-For the 3-D case, \vb|\readArrayijk|\margcmd{readArrayijk} takes an
-additional argument, in comparison to \verb|\readArrayij|. The first two
-arguments are identical to \vb|\readArrayij|; namely, the token containing
-the data and an identifier for the array. The third argument is the
-number of rows in the array, while the fourth argument is the number of
-columns. Likewise, if \vb|\readdef| had been used on a properly formed
+The \cmd{readarray}\margcmd{readarray} command, used to convert
+ raw parsable data into data arrays,
+ takes three arguments.
+The first is the data macro into which the unarrayed raw data had
+ previously been stuffed (e.g., by way of \cmd{readdef} or \cmd{def}).
+The second is array-identifier macro into which the parsed data is to
+ be placed.
+Finally, the last compound argument, enclosed in square brackets, denotes the
+ rank and range of the array to be created.
+
+There is a starred version of the command, \cmd{readarray*}, which is used
+ to remove leading/trailing spaces from the array elements, when parsed.
+This option, is only relevant when the data separator is not already a
+ space.
+
+If an array name is reutilized, its prior definitions are cleared,
+ so that ``old'' data is not inadvertantly retrieved following the
+ reutilization.
+
+\subsubsection{2-D Arrays}
+
+\begin{sloppypar}
+For a 2-D array, this last argument of \cmd{readarray} will be
+ of the form \vb|[-,<columns>]|.
+If the data had recently been read by way of \vb|\readdef|, the
+ string \vb|\ncols| may be used to signify the \vb|<columns>| value.
+The \texttt{-} (or any other character before the initial comma)
+ reminds us that the range of row numbers is not specified in advance,
+ but is dictated by the length of the data macro containing the raw
+ file data.
+For such a 2-D array, only the column range is specified.
+\end{sloppypar}
+
+Consider, for example, the previously discussed file, \texttt{dataA.txt},
+ which had been digested into the data macro \cmd{dataA}.
+One can process that as a 2-D array with an invocation of
+ \vb|\readarray\dataA\twoD[-,\ncols]|, since \cmd{ncols} had been
+ set to a value of \texttt{\ncols}, based on the prior \cmd{readdef}.
+Thereafter, data may be retieved, for example the 3rd row, 2nd column,
+ with \cmd{twoD[3,2]}, to give
+\readarray\dataA\twoD[-,\ncols]
+``\twoD[3,2]''.
+
+The actual array size is given by
+\cmd{twoDROWS}, \cmd{twoDCOLS}, \cmd{twoDCELLS}
+as
+\twoDROWS, \twoDCOLS, and \twoDCELLS, respectively.
+The number of rows in the array is fewer than the number of file records,
+ \oneDCELLS, because blank rows in the input file are ignored.
+One should also note that if the end of the data stream results in a
+ partial final row of data, the partial row will be discarded.
+
+\subsubsection{3-D Arrays}
+
+For the 3-D case, the only difference in the invocation of
+ \vb|\readarray| is in the 3rd argument, in which the
+ rank and range of the array is specified.
+This last argument will be of the form
+ \vb|[-,<rows>,<columns>]|.
+As before, the \vb|-| denotes the fact that the range of the planes
+ of data is unknown before the fact, and governed by the length
+ of data in the dataset.
+Only the range of rows and columns are specifiable here.
+If \vb|\readdef| had been used on a properly formed
input file, both \vb|\nrows| and \vb|\ncols| may be used to supply the
-third and fourth arguments.
+range arguments of the 3-D array.
+For example, using the same \cmd{dataA} dataset, but reading it as a
+ 3-D array can be accomplished with
+ \vb|\readarray\dataA\threeD[-,\nrows,\ncols]|.%
+\readarray\dataA\threeD[-,\nrows,\ncols]
+This results in an array with \threeDPLANES{} planes,
+ \threeDROWS{} rows, and \threeDCOLS{} columns
+(\threeDCELLS{} data cells total).
+Data from the 2nd plane, 1st row, 2nd column can be obtained via
+\cmd{threeD[2,1,2]} as ``\threeD[2,1,2]''.
+
+If, perchance, a row or plane is only partially defined by
+ \cmd{readarray}, the partial data is discarded from the array.
+
+\subsubsection{Array Parsing Separator}
+
While it may be easily envisioned that the array data is numerical, this
-need not be the case. The data may be text, and even formatted text.
+ need not be the case.
+The array data may be text, and even formatted text.
+
Furthermore, one may introduce space characters into the data of
-individual cells through the use of hardspaces (\vb|~|), since
-normal white space would otherwise be interpreted as a data separator.
-Thus, given the following definitions and array initialization,
+ individual cells simply by resetting the \rdar{} parsing separator
+ to something other than the default space, ``~''.
+This can be done, for example employing a comma as the separator,
+ by way of \vb|\readarraysepchar{,}|.\margcmd{readarraysepchar}
-\begin{verbbox}[]
-\def\I#1{\textit{#1}}
-\def\dataC{%
-\I{am} \I{are} have~\I{been} have~\I{been}
-\I{are} \I{are} have~\I{been} have~\I{been}
-\I{is} \I{are} has~\I{been} have~\I{been}
-%
-\I{was} \I{were} had~\I{been} had~\I{been}
-\I{were} \I{were} had~\I{been} had~\I{been}
-\I{was} \I{were} had~\I{been} had~\I{been}
-%
-will~\I{be} will~\I{be} will~have~\I{been} will~have~\I{been}
-will~\I{be} will~\I{be} will~have~\I{been} will~have~\I{been}
-will~\I{be} will~\I{be} will~have~\I{been} will~have~\I{been}
-}
-\readArrayijk{\dataC}{tobeConjugation}{3}{4}
-\end{verbbox}
-\begin{tabular}{l}
-\theverbbox
-\end{tabular}
+Note also, using the facilities of the underlying \loi{} package,
+ that compound separators are possible.
+For example, \textit{either} a comma \textit{or} a period may be used
+ for the data parsing, by specifying a
+ \textbf{logical-OR} (\vb+||+) separated list: \vb:\readarraysepchar{,||.}:.
+Similarly, a multicharacter separator is possible, so that setting
+ \vb|\readarraysepchar{!!}| will cause \cmd{readarray} to look for
+ instances of ``!!'' to divide the data into separate array elements.
-\def\I#1{\textit{#1}}
-\def\dataC{%
-\I{am} \I{are} have~\I{been} have~\I{been}
-\I{are} \I{are} have~\I{been} have~\I{been}
-\I{is} \I{are} has~\I{been} have~\I{been}
-%
-\I{was} \I{were} had~\I{been} had~\I{been}
-\I{were} \I{were} had~\I{been} had~\I{been}
-\I{was} \I{were} had~\I{been} had~\I{been}
-%
-will~\I{be} will~\I{be} will~have~\I{been} will~have~\I{been}
-will~\I{be} will~\I{be} will~have~\I{been} will~have~\I{been}
-will~\I{be} will~\I{be} will~have~\I{been} will~have~\I{been}
-}
-\readArrayijk{\dataC}{tobeConjugation}{3}{4}
-multi-word sequences will be placed into the individual array elements
-of an array identified as ``tobeConjugation,'' with the appropriate
-italic emphases applied to the words.
+Consider the following comma-separated input in, let us say, the file
+ \textsf{conjugation.txt}.
-If, perchance, a row is only partially defined by \vb|\readArrayij| or
-a plane is only partially defined by \vb|\readArrayijk|, the partial
-data is discarded.
+\verbfilebox[\footnotesize]{file3data.txt}
+\rl\theverbbox
-\subsection{Treatment of Hardspaces}
+The sequence of commands
-For either the 2-D or 3-D \verb|\readArray| commands, the interpretation
-of hardspaces (\vb|~|) as data is specifically designed to allow
-multi-word data entries. However, one may choose to turn this feature
-off by setting the flag
+\begin{verbbox}
+\readarraysepchar{,}
+\readdef{conjugation.txt}\dataC
+\readarray*\dataC\tobeConjugation[-,\nrows,\ncols]
+\end{verbbox}
+\rl\theverbbox
+\readarraysepchar{,}
+\readdef{file3data.txt}\dataC
+\readarray*\dataC\tobeConjugation[-,\nrows,\ncols]
-\rl\vb|\def\converttilde{T}|
+will employ a comma separator to parse the file.
+It will then create a 3-D array using data from the file, placed into the
+ array \cmd{tobeConjugation}.
+Leading/trailing spaces will be removed from the data, with the use of the
+ star form of the \cmd{readarray} command.
+Data can then be directly accessed, so that, for example
+\cmd{tobeConjugation[1,3,3]} will yield the entry from the
+ 1st plane, 3rd row, 3rd column as ``\tobeConjugation[1,3,3]''.
-which will have the effect of converting hardspaces to regular space
-tokens.
+The 3-D array metrics are \cmd{tobeConjugationPLANES},
+ \cmd{tobeConjugationROWS}, \cmd{tobeConjugationCOLS}, and
+ \cmd{tobeConjugationCELLS}, which are
+ here given as \tobeConjugationPLANES,
+ \tobeConjugationROWS, \tobeConjugationCOLS, and
+ \tobeConjugationCELLS.
+ respectively.
+
\section{Recalling Data from Array Structures}
-While one has specified the number of columns and/or rows associated
-with the \vb|\readArray...| initialization, those numbers may not yet
+\begin{sloppypar}
+While one must specify the number of columns and/or rows associated
+with the \vb|\readarray| invocation, those numbers may not yet
be known to the user, if the values employed came from the
-\vb|\readdef| initializations of
-\vb|\ncols| and \vb|\nrows|. Therefore, the \vb|\readArray...|
-\margcmd{{\rmfamily\itshape identifier}CELLS}%
-\margcmd{{\rmfamily\itshape identifier}PLANES}%
-\margcmd{{\rmfamily\itshape identifier}ROWS}%
-\margcmd{{\rmfamily\itshape identifier}COLS}%
-commands also set the following strings:
-\itshape\vb|\|identifier\vb|CELLS|, \vb|\|identifier\vb|PLANES|% ,
-\vb|\|identifier\vb|ROWS|{\upshape, and}
-\vb|\|identifier\vb|COLS|\upshape, where
-\textit{identifier} is the array identifier string that was supplied to
-the \verb|\readarray...| command. Note that it is the
-case, for 3-D arrays, that
+\vb|\readdef| estimations of
+\vb|\ncols| and \vb|\nrows|. Therefore, the \cmd{readrray}
+\margcmd{{\rmfamily\itshape array-identifier}CELLS}%
+\margcmd{{\rmfamily\itshape array-identifier}PLANES}%
+\margcmd{{\rmfamily\itshape array-identifier}ROWS}%
+\margcmd{{\rmfamily\itshape array-identifier}COLS}%
+command variants also define the following strings:
+\itshape\vb|\|array-identifier\vb|CELLS|, \vb|\|array-identifier\vb|PLANES|,
+\vb|\|array-identifier\vb|ROWS|{\upshape, and}
+\vb|\|array-identifier\vb|COLS|\upshape, where
+\cmd{array-identifier} is the array name supplied to
+the \cmd{readarray} command. Note, for 3-D arrays, that
+\end{sloppypar}
-\rl\itshape\vb|\|identifier\vb|CELLS| $=$ \vb|\|identifier\vb|PLANES|
-$\times$ \vb|\|identifier\vb|ROWS| $\times$
-\vb|\|identifier\vb|COLS|\upshape
+\rl\itshape\vb|\|array-identifier\vb|CELLS| $=$ \\\rl\quad
+ \vb|\|array-identifier\vb|PLANES| $\times$ \vb|\|array-identifier\vb|ROWS|
+ $\times$ \vb|\|array-identifier\vb|COLS|\upshape
-For the ``tobeConjugation'' example of the prior section,
+For the \cmd{tobeConjugation} example of the prior section,
\tobeConjugationCELLS $=$\tobeConjugationPLANES
$\times$\tobeConjugationROWS $\times$%
\tobeConjugationCOLS. Likewise, for 2-D arrays
-\rl\itshape\vb|\|identifier\vb|CELLS| $=$ \vb|\|identifier\vb|ROWS|
-$\times$ \vb|\|identifier\vb|COLS|\upshape
+\rl\itshape\vb|\|array-identifier\vb|CELLS| $=$ \vb|\|array-identifier\vb|ROWS|
+$\times$ \vb|\|array-identifier\vb|COLS|\upshape
-To retrieve the data from the array, one need employ either the
-\vb|\Arrayij|
-\margcmd{Arrayij}
-or \vb|\Arrayijk|
-\margcmd{Arrayijk}
-commands, depending on whether the array is 2-D or 3-D. The first
-mandatory argument to either of these commands is the array identifer.
-The remaining arguments to these commands are simply the row and column,
-in the case of the 2-D \vb|\Arrayij|, or else the plane, row, and
-column, in the case of the 3-D \vb|\Arrayijk|.
+To retrieve the data from the array, one merely supplies the
+ array name in the form of
+ \cmd{}\textit{array-identifier}\margcmd{\rmfamily\itshape array-identifier%
+ \upshape\ttfamily[...]},
+ along with the array-cell nomenclature in the form of
+ \textit{\texttt{\upshape[}plane\texttt{\upshape,}row\texttt{\upshape,}%
+ column\texttt{\upshape]}} for 3-D arrays,
+ \textit{\texttt{\upshape[}row\texttt{\upshape,}%
+ column\texttt{\upshape]}} for 2-D arrays, and
+ \textit{\texttt{\upshape[}row\texttt{\upshape]}} for 1-D arrays.
Thus, in the case of the earlier example involving conjugation of the
verb \textit{to be}, the second-person future-perfect tense of the verb
-is given by\\
-\rl\vb|\Arrayijk{tobeConjugation}{3}{2}{4}|,\\
-which yields ``\Arrayijk{tobeConjugation}{3}{2}{4}.''
+is given by
-For pseudo-1-D arrays, either created with \verb|\copyrecords| or else
-using the \verb|\readarray| command with the third argument set to
-unity, access to these arrays is achieved by way of \verb|\Arrayij|,
-setting the column argument to unity.
+\rl\cmd{tobeConjugation[3,2,4]}
-There are also strings defined, one for each record that was read from
-the file, with the name
-\verb|\record|\textit{index}\margcmd{record\itshape\rmfamily index},
-where \textit{index} is the record number expressed in roman numerals.
-Thus in the example from section~\ref{s:ex}, \vb|\recordii| would
-contain the string ``\vb|A121 A122 A123 A124|''. However, such syntax
-provides no bounds checking.
+which yields ``\tobeConjugation[3,2,4]''.
-An alternate (perhaps preferred) way to access one of the file records
-read during the most recent \verb|\readdef|, in a way which provides
-bounds checking, is to use the \verb|\showrecord|
-command\margcmd{showrecord}. For the section~\ref{s:ex} example, the
-alternative to executing \vb|\recordii| would be to use
-\verb|\showrecord{2}|. The optional argument to this command provides
-an alternative error message if the record requested is out of bounds.
-The default error messages for negative or excessive record numbers are,
-respectively:
+\section{Bounds Checking}
-\def\nrecords{1}
-\rl\showrecord{-1}\\
-\rl\showrecord{10}
+While the user is developing his or her application involving the {\rdar}
+package, there may accidentally arise the unintended circumstance where
+an array element is requested which falls outside the array bounds.
+In general, when a non-existent array element is requested in the
+ absence of bounds checking, the call will expand to \cmd{relax}.
-Unlike the \vb|\Arrayij| and \verb|\Arrayijk| commands already
-discussed, the record data from a given file read will only be available
-until the next invocation of \verb|\readdef|. For this reason, the
-command \verb|\copyrecords| was introduced to convert file-record data
-into an array data structure.
+The package provides three declarations to set the manner in
+ which array bounds are be monitored.
+The setting \cmd{nocheckbounds}\margcmd{nocheckbounds} is used when bounds
+ are not to be checked.
+This is the default behavior for \rdar.
+For some bounds checking, \cmd{checkbounds}\margcmd{checkbounds}
+ may be set.
+With this setting, bounds violations are noted, but no guidance is
+ provided as to the allowable index range for the array.
+However, with \cmd{hypercheckbounds}\margcmd{hypercheckbounds} set,
+ full bounds checking is possible.
+With this setting, not only are violations noted, but a description
+ of the actual array range is provided.
-While the user is developing his application involving the {\rdar}
-package, there may accidentally arise the unintended circumstance where
-an array element is asked for which falls outside the array bounds.
-Like \verb|\showrecord|, the \verb|\Arrayij| and \verb|\Arrayijk|
-commands also employ bounds checking. These commands check for
-four error conditions that, by default, produce the following error
-messages:\\
-\rl\Arrayijk{tobeConjugation}{-3}{2}{4}\\
-\rl\Arrayijk{tobeConjugation}{9}{2}{4}\\
-\rl\Arrayijk{tobeConjugation}{3}{9}{4}\\
-\rl\Arrayijk{tobeConjugation}{3}{2}{9}
+As of V2.0, bounds violations are noted in the log file, rather than the
+ document itself.
+However, if an array bound is violated when bounds checking is turned on,
+a ``?'' shows up in the document itself.
-which are written in lieu of a valid array element datum. While such
-messages help in debugging, the user may desire an error tailored to the
-application. The optional argument to both \vb|\Arrayij| and
-\vb|\Arrayijk| replaces the default error messages and is to be printed
-if any error condition arises. It could be a blank \vb|[]|, a black
-box \vb|[\rule{1ex}{1ex}]|, or anything else that makes sense for the
-application.
-\section{Alternate Accessing Commands if \texttt{\bs edef} is Required}
+\section{Accessing Array Cells if Full Expansion is Required
+ (e.g., placed in an \texttt{\bs edef}) }
-The\verb|\Arrayij| and \verb|\Arrayijk| commands may, of course, be
-placed as arguments of \verb|\def| commands. They, cannot, however, be
-placed into an \verb|\edef|. If the user has need to place the
-array-element content into an \verb|\edef| (and assuming that the
-actual array-element content is suitable for an \verb|\edef|), the user
-should employ the \verb|\arrayij| and \verb|\arrayijk| commands, as
-alternatives.
-\margcmd{arrayij}\margcmd{arrayijk}%
-These commands do not perform any bounds checking (thus eliminating the
-need for an optional argument). Their advantage, however, is that they
-may be freely placed into an
-\verb|\edef|.
+If full expansion is required of array cell contents (and assuming the cell
+ content is expandable), it is advisable to set \cmd{nocheckbounds}%
+ , so that the error checking code is not
+ included in the expansion.
+Results may be also expanded even with \cmd{checkbounds}
+ set, though the error-checking code is part of the expansion.
+However, with \cmd{hypercheckbounds} set, full
+ expansion of array cells is no longer possible.
+\section{Accessing Array Cells if No Expansion is Required}
+
+With the normal use of \cmd{\rmfamily\itshape array-identifier} syntax
+ for accessing array cells,
+ several levels of expansion are required to directly recover the original
+ tokens of the cell, and then only when bounds checking is disabled.
+When the actual unexpanded tokens of cell are required, the use of the
+ \cmd{arraytomacro}\margcmd{arraytomacro} command provides the means
+ to accomplish this.
+The command takes the array name and index as the initial arguments followed
+ by a generic macro name into which to place the unexpanded tokens of the
+ indexed array cell.
+
+So, for example \vb|\arraytomacro\tobeConjugation[2,2,3]\thiscell| will
+ place the cell's original tokens in the macro \cmd{thiscell}.
+Upon detokenization, \cmd{thiscell} contains
+\arraytomacro\tobeConjugation[2,2,3]\thiscell
+``\texttt{\detokenize\expandafter{\thiscell}}''.
+
\section{Support Routines}
-The engine for the {\rdar} package is the \vb|\getargsC|
-\margcmd{getargsC} command, based on the \vb|\getargs| command found
-in the \textsf{stringstrings} package. This command has been herein
-rewritten for speed. The \vb|\getargsC| command takes a string or
-token as its argument and separates each of the space-separated words of
-it into individual strings, named with roman numerals as
-\vb|\argi|\margcmd{arg\itshape\rmfamily index}, \vb|\argii|,
-\textit{etc}. The total number of arguments that are separated is given
-by the string \vb|\narg|\margcmd{narg}. This command can be useful
-for a variety of applications outside of \rdar. While generally used
-only for diagnostic purposes, the command
-\vb|\showargs|\margcmd{showargs} is used print out all the arguments
-recently digested by an invocation of \vb|\getargsC|, separated by
-small black blocks. The optional argument to \vb|\showargs| is the
-number of individual arguments to place on a single line of output,
-before issuing a linefeed. Thus, the command
+The package provides two commands that can help one understand how a
+ data set has been parsed into an array.
+Both of these commands dump the specified array to the document.
+In the case of \cmd{arraydump}\margcmd{arraydump}, the array is formatted
+ in the structure of the array, broken up by columns, rows, and planes.
+In the case of \cmd{scalardump}\margcmd{scalardump}, however, the elements
+ of the array are dumped sequentially, without reference to the array's
+ heirarchy.
-\begin{verbbox}[]
-\showargs[4]
-\end{verbbox}
-\begin{tabular}{l}
-\theverbbox
-\end{tabular}
+For the case of 1-D record array \cmd{oneD} employed in prior sections, for
+ example, the invocations of
-yields the following result:
+\rl\vb|\arraydump\oneD|\\
+\rl\vb|\scalardump\oneD|
-\showargs[4]
+results in
-Note that the 37$^{th}$ argument is non-printing and represents the
-residual linefeed left over fromt he \vb|\def| of \vb|\dataC|. A
-similar residual argument is also left by the \vb|\readdef| command.
-It can be eliminated if the last record of the \vb|\readdef| input
-file (or the last record of the \vb|\def| command) ends with a
-\vb|%| symbol, so as to discard the final linefeed prior to the
-end-of-file (or \vb|}|).
+\arraydump\oneD
+\scalardump\oneD
-As mentioned earlier, the flag
-\vb|converttilde|\margcmd{converttilde}, by default ``false,'' can be
-set to \vb|\def\converttilde{T}| so as to tell \vb|\getargsC| to
-treat hardspaces as ordinary spaces.
+\clearpage
+The \cmd{twoD} equivalent, resulting from parsing the same data file as
+ a 2-D, rather than a 1-D record array, is
+
+\rl\vb|\arraydump\twoD|\\
+\rl\vb|\scalardump\twoD|
+
+\arraydump\twoD
+\scalardump\twoD
+
+For the case of the 3-D array (earlier read as \cmd{threeD}),
+the \cmd{arraydump} would appear as
+
+\rl\vb|\arraydump\threeD|\\
+\rl\vb|\scalardump\threeD|
+
+\arraydump\threeD
+\scalardump\threeD
+
+Note that the \cmd{scalardump} of \cmd{threeD} is indistinguishable from
+ that of \cmd{twoD}, since both arrays are comprised of the same data
+ cells, though arrayed into different plane/row/column structures.
+
+\clearpage
+For comparison, the \cmd{arraydump} of \cmd{tobeConjugation} is
+
+\arraydump\tobeConjugation
+
+
+\section{Deprecated, Vestigial, and Defunct Features}
+
+\textbf{Deprecated}
+
+The following commands are supplied, but are no longer the preferred
+embodiment of package syntax.
+
+\itshape
+\rl\vb|\copyrecords{|array-identifier\vb|}|%
+\\
+\rl\vb|\readArrayij{\|data-macro\vb|}{|array-identifier\vb|}{|columns\vb|}|%
+\\
+\rl\vb|\readArrayij*{\|data-macro\vb|}{|array-identifier\vb|}{|columns\vb|}|%
+\\
+\rl\vb|\readArrayijk{\|data-macro\vb|}{|array-identifier\vb|}{|rows\vb|}{|columns\vb|}|%
+\\
+\rl\vb|\readArrayijk*{\|data-macro\vb|}{|array-identifier\vb|}{|rows\vb|}{|columns\vb|}|%
+\\
+\rl\vb|\showrecord[|error\vb|]{|record number\vb|}|\\
+\rl\vb|\Arrayij[|error\vb|]{|array-identifier\vb|}{|row\vb|}{|column\vb|}|\\
+\rl\vb|\Arrayijk[|error\vb|]{|array-identifier\vb|}{|plane\vb|}{|row\vb|}{|%
+ column\vb|}|\\
+\rl\vb|\arrayij{|array-identifier\vb|}{|row\vb|}{|column\vb|}|\\
+\rl\vb|\arrayijk{|array-identifier\vb|}{|plane\vb|}{|row\vb|}{|%
+ column\vb|}|\upshape
+
+\textbf{Vestigial}
+
+The following support macros are provided but no longer recommended.
+Their capability is more fully served by way of the \loi{} package.
+
+\itshape
+\rl\vb|\getargsC{\|macro {\upshape or} string\vb|}|\\
+\rl\vb|\arg|index\\
+\rl\vb|\narg|\\
+\rl\vb|\showargs|%
+\upshape
+
+Note that whereas \cmd{getargs} could previously (pre-V2.0 \rdar) employ
+ only a space as the parsing separator, \cmd{getargs} now respects the
+ currently set value of separator, as (re)defined by \cmd{readarraysepchar}.
+
+\textbf{Defunct}
+
+The following macros are no longer supported.
+
+\itshape
+\rl\vb|\converttilde|\\
+\rl\vb|\record|index
+\upshape
+
+Since the package now supports arbitrary parsing separators,
+ there is no need for the function of \cmd{converttilde}.
+However, were one desiring to parse, while treating hard spaces as spaces,
+ this can be simply achieved under V2.0 \rdar{} by setting the
+ parsing character as either a space or a hard space, using
+ \vb:readarraysepchar{ ||~}:.
+Likewise, the indirect addressing (using a romannumeral \textit{index})
+ provided by the internal command \cmd{record}\textit{index} is fully
+ superceded by the ability to directly address any record of \rdar's
+ 1-D record arrays.
+
+
\section{Acknowledgements}
-The author would like to thank Dr. David Carlisle for his assistance in
+I am profoundly thankful to Christian Tellechea for using
+ my simplistic (read ``deficient'') \textsf{getargs} package to
+ inspire his effort in creating the powerful \loi{} package.
+It is precisely the tool I have sought for a long time, and I have
+ adapted its use into the workings of this package.
+
+I would like to thank Dr. David Carlisle for his assistance in
helping the author rewrite the \vb|\getargs| command, originally found
in the \textsf{stringstrings} package. To distinguish the two versions,
-and in deference to him, it is herein named \vb|\getargsC|.
+and in deference to him, it is herein named \vb|\getargsC|. However,
+as of V2.0, its presence is vestigial, having instead been superceded with
+the \loi{} package macros.
-The author is likewise grateful to Ken Kubota, who suggested moving the
+I am likewise grateful to Ken Kubota, who suggested moving the
\vb|\newread| outside of \vb|\readdef|, so as not to prematurely
exhaust the 16 available file streams.
\clearpage
-
\section{Code Listing}
-\verbatiminput{readarray.sty}
-
+\verbfilenobox[\footnotesize]{readarray.sty}
\end{document}
Modified: trunk/Master/texmf-dist/tex/latex/readarray/readarray.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/readarray/readarray.sty 2016-11-08 22:36:17 UTC (rev 42466)
+++ trunk/Master/texmf-dist/tex/latex/readarray/readarray.sty 2016-11-08 22:36:28 UTC (rev 42467)
@@ -1,7 +1,9 @@
+\def\readarrayPackageVersion{2.0}
+\def\readarrayPackageDate{2016/11/07}
\ProvidesPackage{readarray}
-[2016/07/07 v1.3
-Routines for inputting array data and recalling it on an
-element-by-element basis. Currently supports 2-D and 3-D array]
+[\readarrayPackageDate\ \readarrayPackageVersion\ %
+Routines for inputting 2D and 3D array data and recalling it on an
+element-by-element basis.]
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
@@ -16,8 +18,8 @@
% The Current Maintainer of this work is Steven B. Segletes.
%
% Revisions:
-% v1.01 Documentation revision
-% v1.1 Added \csname record\roman{@row}\endcsname to \readdef
+% v1.01 -Documentation revision
+% v1.1 -Added \csname record\roman{@row}\endcsname to \readdef
% v1.2 -Corrected the [truncated] LPPL license info
% -Added \arrayij and \arrayijk, which can be put into \edef
% -Used \romannumeral in preference to \roman{}, when possible,
@@ -24,8 +26,15 @@
% to avoid unnecessary use of counters.
% v1.3 -Moved \newread outside of \readdef, so as not to exhaust the
% 16 allotted file streams (Thanks to Ken Kubota for the tip).
-\usepackage{ifthen}
-\usepackage{ifnextok}
+% v2.0 -Converted parsing to listofitems package. This allows for
+% ANY parsing character or combination of characters (via logical OR).
+% -Replaced all \protected at edef's with appropriately expanded \def's.
+% -Use listofitems package in preference to \getargsC.
+% -Deprecated \Arrayijk, \arrayijk, \Arrayij, & \arrayij. Direct
+% access now preferred, e.g., \xyz[2,3,1].
+% -Deprecated most other commands in favor of a more natural syntax.
+\RequirePackage{ifthen}
+\RequirePackage{listofitems}[2016-10-22]
%
\newcounter{@index}
\newcounter{@plane}
@@ -33,20 +42,156 @@
\newcounter{@col}
\newcounter{use at args}
\newcounter{@record}
-\def\the at rule{\rule{.8ex}{1.6ex}}%
+\newcounter{arg at index}
+\newcounter{break at count}
+\newcounter{index at count}
+\newcounter{loop at count}
+\newtoks\Arg at toks
+\newtoks\@arrayident at toks
+\newread\rdar at file
%
-\newcommand\readArrayijk[4]{%
- \getargsC{#1}%
- \setcounter{@plane}{\numexpr(\narg/#4/#3)}%
- \setcounter{use at args}{\numexpr\arabic{@plane}*#3*#4}%
- \ifthenelse{\arabic{use at args} > \narg}{%
+\newcommand\readdef[2]{\@readdef{#1}{#2}{ArrayRecord}}
+%
+\newcommand\readrecordarray[2]{%
+ \edef\@arrayident{\rdar at macroname#2}%
+ \def\ra at TermA{\@readdef{#1}}%
+ \def\ra at TermB{\expandafter\ra at TermA\csname\@arrayident def\endcsname}%
+ \expandafter\ra at TermB\expandafter{\@arrayident}%
+}
+%
+\newcommand\readarray{\@ifstar{\read at array@newsyntax[*]}{\read at array@newsyntax[]}}
+%
+\def\arraytomacro#1[#2]#3{%
+ \edef\@arrayident{\rdar at macroname#1[#2]}%
+ \@arrayident at toks=\expandafter\expandafter\expandafter{\csname\@arrayident\endcsname}%
+ \expandafter\def\expandafter#3\expandafter{\the\@arrayident at toks}%
+}
+%
+\newcommand\readarraysepchar[1]{\def\read at array@sepchar{#1}}
+%
+\def\nocheckbounds{\def\rootmacro at aux##1##2##3{##1%
+ }\typeout{readarray: bounds checking OFF}%
+}
+%
+\def\checkbounds{\def\rootmacro at aux##1##2##3{##1%
+ \expandafter\ifx##1\relax\readarrayboundfailmsg%
+ \setbox0=\hbox{\typeout{readarray Warning: ##1 out of bounds.}}%
+ \fi%
+ }\typeout{readarray: bounds checking ON}%
+}
+%
+\def\hypercheckbounds{\def\rootmacro at aux##1##2##3{##1%
+ \expandafter\ifx##1\relax\readarrayboundfailmsg%
+ \typeout{readarray Warning: ##1 out of bounds:}%
+ \fi%
+ \setcounter{index at count}{0}%
+ \parse at index##3,\relax%
+ \setcounter{loop at count}{0}%
+ \whiledo{\value{loop at count}<\value{index at count}}{%
+ \stepcounter{loop at count}%
+ \ifnum\csname parsed at index[\theloop at count]\endcsname<0%
+ \relax\typeout{\nonposmessage{##2}{##3}}\fi%
+ }%
+ \ifnum \value{index at count}=1\relax%
+ \ifnum\csname parsed at index[1]\endcsname>%
+ \csname##2CELLS\endcsname\relax\typeout{\recordmessage{##2}{##3}}\fi%
+ \fi
+ \ifnum \value{index at count}=2\relax%
+ \ifnum\csname parsed at index[1]\endcsname>%
+ \csname##2ROWS\endcsname\relax\typeout{\rowmessage{##2}{%
+ \csname parsed at index[1]\endcsname}}\fi%
+ \ifnum\csname parsed at index[2]\endcsname>%
+ \csname##2COLS\endcsname\relax\typeout{\colmessage{##2}{%
+ \csname parsed at index[2]\endcsname}}\fi%
+ \fi
+ \ifnum \value{index at count}=3\relax%
+ \ifnum\csname parsed at index[1]\endcsname>%
+ \csname##2PLANES\endcsname\relax\typeout{\planemessage{##2}{%
+ \csname parsed at index[1]\endcsname}}\fi%
+ \ifnum\csname parsed at index[2]\endcsname>%
+ \csname##2ROWS\endcsname\relax\typeout{\rowmessage{##2}{%
+ \csname parsed at index[2]\endcsname}}\fi%
+ \ifnum\csname parsed at index[2]\endcsname>%
+ \csname##2COLS\endcsname\relax\typeout{\colmessage{##2}{%
+ \csname parsed at index[3]\endcsname}}\fi%
+ \fi%
+ }\typeout{readarray: bounds hyperchecking ON}%
+}
+%
+\def\rdar at macroname{\expandafter\@gobble\string}
+%
+\def\getArg at toks[#1]{\Arg at toks\expandafter\expandafter\expandafter{\Arg at list[#1]}}
+%
+\newcommand\@readdef[3]{%
+ \clear at array{#3}%
+ \edef\former at recordcount{\csname #3CELLS\endcsname}%
+ \def\first at row{T}%
+ \def\first at plane{T}%
+ \catcode\endlinechar=9 %
+ \def#2{}%
+ \setcounter{@record}{0}%
+ \openin\rdar at file=#1%
+ \loop\unless\ifeof\rdar at file%
+ \read\rdar at file to\rdar at fileline % Reads a line of the file into \rdar at fileline%
+ \addtocounter{@record}{1}%
+ \expandafter\g at addto@macro\expandafter#2\expandafter{\rdar at fileline}%
+ \ifthenelse{\equal{\rdar at fileline}{}}{}{\expandafter\g at addto@macro%
+ \expandafter#2\expandafter{\read at array@sepchar}}%
+ \if T\first at row\read at array{#2}\setcounter{@col}{\numexpr(\Arg at listlen-1)}%
+ \edef\ncols{\arabic{@col}}\def\first at row{F}\setcounter{@row}{1}%
+ \else%
+ \if T\first at plane%
+ \ifthenelse{\equal{\rdar at fileline}{}}{%
+ \edef\nrows{\arabic{@row}}\def\first at plane{F}%
+ }{%
+ \addtocounter{@row}{1}%
+ }%
+ \fi%
+ \fi%
+ \def\record at name{\csname #3[\the at record]\endcsname}%
+ \expandafter\expandafter\expandafter\expandafter\expandafter\expandafter%
+ \expandafter\def\expandafter\record at name\expandafter{\rdar at fileline}%
+ \repeat%
+ \edef\nrecords{\arabic{@record}}%
+ \expandafter\edef\csname #3PLANES\endcsname{0}%
+ \expandafter\edef\csname #3ROWS\endcsname{\nrecords}%
+ \expandafter\edef\csname #3COLS\endcsname{0}%
+ \expandafter\edef\csname #3CELLS\endcsname{\nrecords}%
+ \closein\rdar at file%
+ \catcode\endlinechar=5 %
+ \define at rootmacro{#3}%
+}
+%
+\def\read at array@newsyntax[#1]#2#3[#4,#5]{%
+ \edef\@arrayident{\rdar at macroname#3}%
+ \setcounter{index at count}{0}%
+ \parse at index#5,\relax%
+ \ifnum\value{index at count}=1\relax%
+ \def\ra at TermA{\readArrayij#1{#2}}%
+ \edef\ra at TermB{{\@arrayident}{\csname parsed at index[1]\endcsname}}%
+ \expandafter\ra at TermA\ra at TermB%
+ \else
+ \ifnum\value{index at count}=2\relax%
+ \def\ra at TermA{\readArrayijk#1{#2}}%
+ \edef\ra at TermB{{\@arrayident}{\csname parsed at index[1]\endcsname}%
+ {\csname parsed at index[2]\endcsname}}%
+ \expandafter\ra at TermA\ra at TermB%
+ \fi\fi
+}
+%
+\newcommand\read at Arrayijk[5][]{%
+ \clear at array{#3}%
+ \read at array[#1]{#2}%
+ \setcounter{@plane}{\numexpr(\Arg at listlen/#5/#4)}%
+ \setcounter{use at args}{\numexpr\arabic{@plane}*#4*#5}%
+ \ifthenelse{\arabic{use at args} > \Arg at listlen}{%
\addtocounter{@plane}{-1}%
- \setcounter{use at args}{\numexpr\arabic{@plane}*#3*#4}%
+ \setcounter{use at args}{\numexpr\arabic{@plane}*#4*#5}%
}{}%
- \expandafter\edef\csname#2PLANES\endcsname{\arabic{@plane}}%
- \expandafter\edef\csname#2ROWS\endcsname{#3}%
- \expandafter\edef\csname#2COLS\endcsname{#4}%
- \expandafter\edef\csname#2CELLS\endcsname{\arabic{use at args}}%
+ \expandafter\edef\csname#3PLANES\endcsname{\arabic{@plane}}%
+ \expandafter\edef\csname#3ROWS\endcsname{#4}%
+ \expandafter\edef\csname#3COLS\endcsname{#5}%
+ \expandafter\edef\csname#3CELLS\endcsname{\arabic{use at args}}%
\setcounter{@index}{0}%
\setcounter{@plane}{1}%
\setcounter{@row}{1}%
@@ -54,32 +199,35 @@
\whiledo{\value{@index} < \value{use at args}}{%
\addtocounter{@index}{1}%
\addtocounter{@col}{1}%
- \ifthenelse{\value{@col} > #4}%
+ \ifthenelse{\value{@col} > #5}%
{\addtocounter{@row}{1}%
- \addtocounter{@col}{-#4}}%
+ \addtocounter{@col}{-#5}}%
{}%
- \ifthenelse{\value{@row} > #3}%
+ \ifthenelse{\value{@row} > #4}%
{\addtocounter{@plane}{1}%
- \addtocounter{@row}{-#3}}%
+ \addtocounter{@row}{-#4}}%
{}%
- \expandafter\protected at edef%
- \csname#2X\roman{@plane}X\roman{@row}X\roman{@col}\endcsname%
- {\expandafter\csname arg\roman{@index}\endcsname}%
+ \def\arg at name{\csname#3[\the at plane,\the at row,\the at col]\endcsname}%
+ \getArg at toks[\the at index]%
+ \expandafter\expandafter\expandafter\expandafter\expandafter\expandafter%
+ \expandafter\def\expandafter\arg at name\expandafter{\the\Arg at toks}%
}%
+ \define at rootmacro{#3}%
}
%
-\newcommand\readArrayij[3]{%
- \getargsC{#1}%
- \setcounter{@row}{\numexpr(\narg/#3)}%
- \setcounter{use at args}{\numexpr\arabic{@row}*#3}%
- \ifthenelse{\arabic{use at args} > \narg}{%
+\newcommand\read at Arrayij[4][]{%
+ \clear at array{#3}%
+ \read at array[#1]{#2}%
+ \setcounter{@row}{\numexpr(\Arg at listlen/#4)}%
+ \setcounter{use at args}{\numexpr\arabic{@row}*#4}%
+ \ifthenelse{\arabic{use at args} > \Arg at listlen}{%
\addtocounter{@row}{-1}%
- \setcounter{use at args}{\numexpr\arabic{@row}*#3}%
+ \setcounter{use at args}{\numexpr\arabic{@row}*#4}%
}{}%
- \expandafter\edef\csname#2PLANES\endcsname{1}%
- \expandafter\edef\csname#2ROWS\endcsname{\arabic{@row}}%
- \expandafter\edef\csname#2COLS\endcsname{#3}%
- \expandafter\edef\csname#2CELLS\endcsname{\arabic{use at args}}%
+ \expandafter\edef\csname#3PLANES\endcsname{0}%
+ \expandafter\edef\csname#3ROWS\endcsname{\arabic{@row}}%
+ \expandafter\edef\csname#3COLS\endcsname{#4}%
+ \expandafter\edef\csname#3CELLS\endcsname{\arabic{use at args}}%
\setcounter{@index}{0}%
\setcounter{@row}{1}%
\setcounter{@col}{0}%
@@ -86,162 +234,194 @@
\whiledo{\value{@index} < \value{use at args}}{%
\addtocounter{@index}{1}%
\addtocounter{@col}{1}%
- \ifthenelse{\value{@col} > #3}%
+ \ifthenelse{\value{@col} > #4}%
{\addtocounter{@row}{1}%
- \addtocounter{@col}{-#3}}%
+ \addtocounter{@col}{-#4}}%
{}%
- \expandafter\protected at edef%
- \csname#2X\roman{@row}X\roman{@col}\endcsname%
- {\expandafter\csname arg\roman{@index}\endcsname}%
+ \def\arg at name{\csname#3[\the at row,\the at col]\endcsname}%
+ \getArg at toks[\the at index]%
+ \expandafter\expandafter\expandafter\expandafter\expandafter\expandafter%
+ \expandafter\def\expandafter\arg at name\expandafter{\the\Arg at toks}%
}%
+ \define at rootmacro{#3}%
}
%
-\def\nonposrecordmessage{{\tiny Only positive showrecords permitted}}
-\def\recordmessage#1{{\tiny RECORD=#1 exceeds records read}}
+\newcommand\clear at array[1]{%
+ \expandafter\ifx\csname #1\endcsname\relax\else%
+ \setcounter{@row}{0}%
+ \whiledo{\value{@row}<\csname #1ROWS\endcsname}{%
+ \stepcounter{@row}%
+ \ifnum\csname #1COLS\endcsname=0\relax%
+ \expandafter\let\csname #1[\the at row]\endcsname\relax%
+ \else
+ \setcounter{@col}{0}%
+ \whiledo{\value{@col}<\csname #1COLS\endcsname}{%
+ \stepcounter{@col}%
+ \ifnum\csname #1PLANES\endcsname=0\relax%
+ \expandafter\let\csname #1[\the at row,\the at col]\endcsname\relax%
+ \else
+ \setcounter{@plane}{0}%
+ \whiledo{\value{@plane}<\csname #1PLANES\endcsname}{%
+ \stepcounter{@plane}%
+ \expandafter%
+ \let\csname #1[\the at plane,\the at row,\the at col]\endcsname\relax%
+ }%
+ \fi%
+ }%
+ \fi%
+ }%
+ \fi%
+}
%
-\def\nonposmessage{{\tiny Only positive array indices permitted}}
-\def\planemessage#1#2{{\tiny PLANE=#2 exceeds limit for #1}}
-\def\rowmessage#1#2{{\tiny ROW=#2 exceeds limit for #1}}
-\def\colmessage#1#2{{\tiny COL=#2 exceeds limit for #1}}
+\newcommand\read at array[2][]{%
+ \bgroup%
+ \expandafter\setsepchar\expandafter{\read at array@sepchar}%
+ \greadlist#1\Arg at list{#2}%
+ \egroup%
+ \edef\Arg at listCELLS{\Arg at listlen}%
+}
%
-\newcommand\arrayijk[4]{%
- \csname#1X\romannumeral#2X\romannumeral#3X\romannumeral#4\endcsname%
+\def\define at rootmacro#1{%
+ \expandafter\def\csname#1\endcsname[##1]{%
+ \expandafter\rootmacro at aux\csname #1[##1]\endcsname{#1}{##1}}%
}
%
-\newcommand\Arrayijk[5][$]{%
- \ifthenelse{\value{@plane}<1 \OR \value{@row}<1 \OR \value{@col}<1}{%
- \if$#1\nonposmessage\else#1\fi}{%
- \ifthenelse{#3 > \csname#2PLANES\endcsname}{%
- \if$#1\planemessage{#2}{#3}\else#1\fi}{%
- \ifthenelse{#4 > \csname#2ROWS\endcsname}{%
- \if$#1\rowmessage{#2}{#4}\else#1\fi}{%
- \ifthenelse{#5 > \csname#2COLS\endcsname}{%
- \if$#1\colmessage{#2}{#5}\else#1\fi}{%
- \csname#2X\romannumeral#3X\romannumeral#4X\romannumeral#5\endcsname}%
- }%
- }%
- }%
+\def\parse at index#1,#2\relax{%
+ \stepcounter{index at count}%
+ \expandafter\gdef\csname parsed at index[\theindex at count]\endcsname{#1}%
+ \ifx\relax#2\relax\else\parse at index#2\relax\fi%
}
+% INITIALIZATION
+\readarraysepchar{ }
+\nocheckbounds
%
-\newcommand\arrayij[3]{%
- \csname#1X\romannumeral#2X\romannumeral#3\endcsname%
+\def\nonposmessage#1#2{Negative index [#2] impermissable for #1.}
+\def\recordmessage#1#2{RECORD=#2 exceeds bounds(=\csname#1CELLS\endcsname) for #1.}
+\def\planemessage#1#2{PLANE=#2 exceeds bounds(=\csname#1PLANES\endcsname) for #1.}
+\def\rowmessage#1#2{ROW=#2 exceeds bounds(=\csname#1ROWS\endcsname) for #1.}
+\def\colmessage#1#2{COL=#2 exceeds bounds(=\csname#1COLS\endcsname) for #1.}
+%
+\def\the at showargs@rule{\kern.2pt\rule{.8ex}{1.6ex}\hspace{.2pt}}%
+\def\readarrayboundfailmsg{?}% DISPLAYED WHEN ARRAY CALL OUT OF BOUNDS
+%
+% SUPPORT/DEBUG ROUTINES
+%
+% \arraydump INITIALIZATIONS
+\def\row at spacer{\\}
+\def\row at msg{\the at showargs@rule\hfill{\scriptsize\scshape$<$\row at sign~\arabic{@row}$>$}}
+\def\header at msg{{\bfseries\ra at rank:}~}
+\def\last at row{\\}
+\def\plane at msg{\plane at sign\hrulefill\mbox{}\\}
+\def\close at out{}
+%
+\newcommand\arraydump[1]{%
+ \edef\@arrayident{\rdar at macroname#1}%
+ \expandafter\ifx\csname\@arrayident\endcsname\relax\else%
+ \edef\ra at TmpA{\csname\@arrayident PLANES\endcsname}%
+ \edef\ra at TmpB{\csname\@arrayident COLS\endcsname}%
+ \def\ra at rank{3-D}%
+ \ifnum\ra at TmpA=0\relax\def\ra at TmpA{1}\def\plane at sign{\mbox{}}\def\ra at rank{2-D}%
+ \else\def\plane at sign{{\scriptsize\scshape Plane \arabic{@plane}}}\fi%
+ \ifnum\ra at TmpB=0\relax\def\ra at TmpB{1}\def\row at sign{Record}\def\ra at rank{1-D}%
+ \else\def\row at sign{Row}\fi%
+ \par\noindent\header at msg%
+ \setcounter{@plane}{0}%
+ \whiledo{\value{@plane}<\ra at TmpA}{%
+ \stepcounter{@plane}%
+ \plane at msg%
+ \setcounter{@row}{0}%
+ \whiledo{\value{@row}<\csname\@arrayident ROWS\endcsname}{%
+ \ifnum\value{@row}=0\relax\else\row at spacer\fi%
+ \stepcounter{@row}%
+ \setcounter{@col}{0}%
+ \whiledo{\value{@col}<\ra at TmpB}{%
+ \the at showargs@rule%
+ \stepcounter{@col}%
+ \ifnum\csname\@arrayident COLS\endcsname=0\relax%
+ #1[\the at row]%
+ \else%
+ \ifnum\csname\@arrayident PLANES\endcsname=0\relax%
+ #1[\the at row,\the at col]%
+ \else%
+ #1[\the at plane,\the at row,\the at col]%
+ \fi%
+ \fi%
+ }\row at msg%
+ }\last at row%
+ }\close at out\mbox{}\hrulefill\mbox{}\par%
+ \fi%
}
%
-\newcommand\Arrayij[4][$]{%
- \ifthenelse{\value{@row}<1 \OR \value{@col}<1}{%
- \if$#1\nonposmessage\else#1\fi}{%
- \ifthenelse{#3 > \csname#2ROWS\endcsname}{%
- \if$#1\rowmessage{#2}{#3}\else#1\fi}{%
- \ifthenelse{#4 > \csname#2COLS\endcsname}{%
- \if$#1\colmessage{#2}{#4}\else#1\fi}{%
- \csname#2X\romannumeral#3X\romannumeral#4\endcsname}%
- }%
- }%
+\newcommand\scalardump[1]{\bgroup%
+ \def\row at spacer{}%
+ \def\row at msg{}%
+ \def\header at msg{{\bfseries\csname\@arrayident CELLS\endcsname\ ELEMENTS:}%
+ ~\hrulefill\mbox{}\\}%
+ \def\last at row{}%
+ \def\plane at msg{}%
+ \def\close at out{\the at showargs@rule\\}%
+ \arraydump#1\egroup%
}
%
+% DEPRECATED COMMANDS (NOT PREFERRED EMBODIMENT OF PACKAGE SYNTAX)
+%
+\newcommand\readArrayijk{\@ifstar{\read at Arrayijk[*]}{\read at Arrayijk}}
+\newcommand\readArrayij{\@ifstar{\read at Arrayij[*]}{\read at Arrayij}}
+\newcommand\arrayijk[4]{\csname#1[#2,#3,#4]\endcsname}
+\newcommand\arrayij[3]{\csname#1[#2,#3]\endcsname}
+\newcommand\Arrayijk[5][\relax]{%
+ \bgroup%
+ \ifx\relax#1\else\def\readarrayboundfailmsg{#1}\fi\csname#2\endcsname[#3,#4,#5]%
+ \egroup%
+}
+\newcommand\Arrayij[4][\relax]{%
+ \bgroup%
+ \ifx\relax#1\else\def\readarrayboundfailmsg{#1}\fi\csname#2\endcsname[#3,#4]%
+ \egroup%
+}
\newcommand\copyrecords[1]{%
+ \clear at array{#1}%
+ \edef\former at recordcount{\csname #1CELLS\endcsname}%
\setcounter{@record}{0}%
\whiledo{\value{@record} < \nrecords}{%
\addtocounter{@record}{1}%
- \expandafter\protected at edef\csname#1X\roman{@record}Xi\endcsname{%
- \csname record\roman{@record}\endcsname}%
+ \def\arg at name{\csname#1[\the at record]\endcsname}%
+ \expandafter\expandafter\expandafter\expandafter\expandafter\expandafter%
+ \expandafter\def\expandafter\arg at name\expandafter{%
+ \csname ArrayRecord[\the at record]\endcsname}%
}%
- \expandafter\edef\csname#1PLANES\endcsname{1}%
+ \expandafter\edef\csname#1PLANES\endcsname{0}%
\expandafter\edef\csname#1ROWS\endcsname{\nrecords}%
- \expandafter\edef\csname#1COLS\endcsname{1}%
+ \expandafter\edef\csname#1COLS\endcsname{0}%
\expandafter\edef\csname#1CELLS\endcsname{\nrecords}%
+ \define at rootmacro{#1}%
}
-%
-\newcommand\showrecord[2][$]{%
- \ifthenelse{#2<1}{%
- \if$#1\nonposrecordmessage\else#1\fi}{%
- \ifthenelse{#2 > \nrecords}{%
- \if$#1\recordmessage{#2}\else#1\fi}{%
- \csname record\romannumeral#2\endcsname}%
- }%
+\newcommand\showargs[1][0]{\bgroup%
+ \def\Arg at listPLANES{0}%
+ \def\Arg at listCOLS{0}%
+ \let\Arg at listROWS\Arg at listCELLS%
+ \scalardump\Arg at list\egroup%
}
-%
-\newread\file%
-%
-\newcommand\readdef[2]{%
-\def\first at row{T}%
-\def\first at plane{T}%
-\catcode\endlinechar=10\relax%
-\def#2{}%
-\setcounter{@record}{0}%
-\openin\file=#1%
-\loop\unless\ifeof\file%
- \read\file to\fileline % Reads a line of the file into \fileline%
- \addtocounter{@record}{1}%
- \protected at edef#2{#2\fileline}%
- \if T\first at row\getargsC{#2}\setcounter{@col}{\numexpr(\narg-1)}%
- \edef\ncols{\arabic{@col}}\def\first at row{F}\setcounter{@row}{1}%
- \else%
- \if T\first at plane\getargsC{\fileline}\ifthenelse{\equal{\narg}{1}}{%
- \edef\nrows{\arabic{@row}}\def\first at plane{F}}{%
- \addtocounter{@row}{1}}%
- \fi%
- \fi%
- \expandafter\protected at edef\csname record\roman{@record}\endcsname{%
- \fileline}%
-\repeat%
-\edef\nrecords{\arabic{@record}}%
-\closein\file%
-\catcode\endlinechar=5\relax%
+\newcommand\showrecord[2][\relax]{%
+ \bgroup\ifx\relax#1\else\def\readarrayboundfailmsg{#1}\fi\ArrayRecord[#2]\egroup%
}
-%
-\newcommand\showargs[1][0]{%
- narg=\narg:~%
- \the at rule%
- \setcounter{arg at index}{0}%
- \setcounter{break at count}{0}%
- \whiledo{\value{arg at index} < \narg}{%
- \addtocounter{arg at index}{1}%
- \addtocounter{break at count}{1}%
- \csname arg\roman{arg at index}\endcsname%
- \the at rule%
- \ifthenelse{\equal{#1}{\value{break at count}}}{%
- \ifthenelse{\equal{\value{arg at index}}{\narg}}{}{%
- \newline\the at rule\addtocounter{break at count}{-#1}}%
- }%
- {}%
+% The support routine \getargs{} is provided for backward compatibility.
+% It is preferable to directly use facilities of the
+% listofitems package to accomplish these tasks.
+\def\getargsC#1{%
+ \bgroup%
+ \expandafter\setsepchar\expandafter{\read at array@sepchar}%
+ \greadlist\Arg at list{#1}%
+ \egroup%
+ \edef\narg{\Arg at listlen}%
+ \let\Arg at listCELLS\narg%
+ \setcounter{@index}{0}%
+ \whiledo{\value{@index}<\narg}{%
+ \stepcounter{@index}%
+ \expandafter\edef\csname arg\romannumeral\value{@index}\endcsname{%
+ \Arg at list[\value{@index}]}%
}%
- \setcounter{arg at index}{0}%
}
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-% The \getargsC macro mimics the behavior of the \getargs macro
-% of the stringstrings package, but runs faster, and can handle
-% arbitrary tokens. For the development of \getargsC, significant
-% assistance was provided by David Carlisle, for which the author is
-% most appreciative.
-% http://tex.stackexchange.com/questions/101604/
-% parsing-strings-containing-diacritical-marks-macros
-%
-\def\string at end{$\SaveHardspace}
-\def\converttilde{F}
-\newcounter{arg at index}
-\newcounter{break at count}
-\let\SaveHardspace~%%%
-%
-\def\getargsC#1{%
- \if T\converttilde\def~{ }\else\catcode`~=12\fi
- \protected at edef\the at string{#1}%
- \setcounter{arg at index}{0}%
- \lowercase{\expandafter\parse at Block\the at string} \string at end
- \let~\SaveHardspace%
- \catcode`~=13
-}
-%
-\def\parse at Block#1 {%
- \stepcounter{arg at index}%
- \@namedef{arg\roman{arg at index}}{#1}%
- \futurelet\tmp\parse at Block@}
-%
-\def\parse at Block@{%
-\ifx\tmp\string at end\edef\narg{\thearg at index}\expandafter\@gobble
-\else\expandafter\parse at Block\fi}
-%
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\endinput
More information about the tex-live-commits
mailing list