Changeset 599dc6a for doc/user

Timestamp:

Jun 30, 2023, 1:48:33 PM (2 years ago)

Author:

caparsons <caparson@…>

Branches:

master

Children:

4bae7b4

Parents:

c9019ce (diff), 48ee593 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge branch 'master' of plg.uwaterloo.ca:software/cfa/cfa-cc

Location:

doc/user

Files:

• Makefile (modified) (1 diff)
• user.tex (modified) (13 diffs)

doc/user/Makefile

@@ -68 +68 @@
         -${BibTeX} ${Build}/${basename $@}
         # Some citations reference others so run again to resolve these citations
-#       ${LaTeX} ${basename $@}.tex
-        -${BibTeX} ${Build}/${basename $@}
+        ${LaTeX} ${basename $@}.tex
+#       -${BibTeX} ${Build}/${basename $@}
         # Make index from *.aux entries and input index at end of document
         makeindex -s ${Macros}/indexstyle ${Build}/${basename $@}.idx

doc/user/user.tex

@@ -11 +11 @@
 %% Created On       : Wed Apr  6 14:53:29 2016
 %% Last Modified By : Peter A. Buhr
-%% Last Modified On : Mon Jun  5 21:18:29 2023
-%% Update Count     : 5521
+%% Last Modified On : Thu Jun 29 21:52:51 2023
+%% Update Count     : 5533
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
@@ -3981 +3981 @@
 
 The following \Index{manipulator}s control \Index{implicit output separation}.
-The effect of these manipulators is global for an output stream (except ©sepOn© and ©sepOff©).
+The effect of these manipulators is global for an output stream (except ©sep© and ©nosep©).
 \begin{enumerate}
 \item
-\Indexc{sepSet}\index{manipulator!sepSet@©sepSet©} and \Indexc{sep}\index{manipulator!sep@©sep©}/\Indexc{sepGet}\index{manipulator!sepGet@©sepGet©} set and get the separator string.
+\Indexc{sepSet}\index{manipulator!sepSet@©sepSet©} and \Indexc{sepVal}\index{manipulator!sepVal@©sepVal©}/\Indexc{sepGet}\index{manipulator!sepGet@©sepGet©} set and get the separator string.
 The separator string can be at most 16 characters including the ©'\0'© string terminator (15 printable characters).
 \begin{cfa}[belowskip=0pt]
 sepSet( sout, ", $\LstStringStyle{\textdollar}$" ); $\C{// set separator from " " to ", \$"}$
-sout | 1 | 2 | 3 | " \"" | ®sep® | "\"";
+sout | 1 | 2 | 3 | " \"" | ®sepVal® | "\"";
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt]
-1®, $\LstStringStyle{\textdollar}$®2®, $\LstStringStyle{\textdollar}$®3 ®", $\LstStringStyle{\textdollar}$"®
+1®, $\color{red}\LstStringStyle{\textdollar}$®2®, $\color{red}\LstStringStyle{\textdollar}$®3 ®", $\color{red}\LstStringStyle{\textdollar}$"®
 \end{cfa}
 \begin{cfa}[belowskip=0pt]
@@ -4019 +4019 @@
 
 \item
-\Indexc{sepSetTuple}\index{manipulator!sepSetTuple@©sepSetTuple©} and \Indexc{sepTuple}\index{manipulator!sepTuple@©sepTuple©}/\Indexc{sepGetTuple}\index{manipulator!sepGetTuple@©sepGetTuple©} get and set the tuple separator-string.
+\Indexc{sepSetTuple}\index{manipulator!sepSetTuple@©sepSetTuple©} and \Indexc{sepTupleVal}\index{manipulator!sepTupleVal@©sepTupleVal©}/\Indexc{sepGetTuple}\index{manipulator!sepGetTuple@©sepGetTuple©} get and set the tuple separator-string.
 The tuple separator-string can be at most 16 characters including the ©'\0'© string terminator (15 printable characters).
 \begin{cfa}[belowskip=0pt]
 sepSetTuple( sout, " " ); $\C{// set tuple separator from ", " to " "}$
-sout | t1 | t2 | " \"" | ®sepTuple® | "\"";
+sout | t1 | t2 | " \"" | ®sepTupleVal® | "\"";
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt]
@@ -4038 +4038 @@
 
 \item
-\Indexc{sepDisable}\index{manipulator!sepDisable@©sepDisable©} and \Indexc{sepEnable}\index{manipulator!sepEnable@©sepEnable©} globally toggle printing the separator.
+\Indexc{sepOff}\index{manipulator!sepOff@©sepOff©} and \Indexc{sepOn}\index{manipulator!sepOn@©sepOn©} globally toggle printing the separator.
 \begin{cfa}[belowskip=0pt]
-sout | sepDisable | 1 | 2 | 3; $\C{// turn off implicit separator}$
+sout | ®sepOff® | 1 | 2 | 3; $\C{// turn off implicit separator}$
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
@@ -4046 +4046 @@
 \end{cfa}
 \begin{cfa}[belowskip=0pt]
-sout | sepEnable | 1 | 2 | 3; $\C{// turn on implicit separator}$
+sout | ®sepOn® | 1 | 2 | 3; $\C{// turn on implicit separator}$
 \end{cfa}
 \begin{cfa}[mathescape=off,showspaces=true,aboveskip=0pt,belowskip=0pt]
@@ -4053 +4053 @@
 
 \item
-\Indexc{sepOn}\index{manipulator!sepOn@©sepOn©} and \Indexc{sepOff}\index{manipulator!sepOff@©sepOff©} locally toggle printing the separator with respect to the next printed item, and then return to the global separator setting.
+\Indexc{sep}\index{manipulator!sep@©sep©} and \Indexc{nosep}\index{manipulator!nosep@©nosep©} locally toggle printing the separator with respect to the next printed item, and then return to the global separator setting.
 \begin{cfa}[belowskip=0pt]
-sout | 1 | sepOff | 2 | 3; $\C{// turn off implicit separator for the next item}$
+sout | 1 | ®nosep® | 2 | 3; $\C{// turn off implicit separator for the next item}$
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
@@ -4061 +4061 @@
 \end{cfa}
 \begin{cfa}[belowskip=0pt]
-sout | sepDisable | 1 | sepOn | 2 | 3; $\C{// turn on implicit separator for the next item}$
+sout | sepOff | 1 | ®sep® | 2 | 3; $\C{// turn on implicit separator for the next item}$
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
@@ -4068 +4068 @@
 The tuple separator also responses to being turned on and off.
 \begin{cfa}[belowskip=0pt]
-sout | t1 | sepOff | t2; $\C{// turn off implicit separator for the next item}$
+sout | t1 | ®nosep® | t2; $\C{// turn off implicit separator for the next item}$
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
 1, 2, 34, 5, 6
 \end{cfa}
-©sepOn© \emph{cannot} be used to start/end a line with a separator because separators do not appear at the start/end of a line;
+©sep© \emph{cannot} be used to start/end a line with a separator because separators do not appear at the start/end of a line;
 use ©sep© to accomplish this functionality.
 \begin{cfa}[belowskip=0pt]
-sout | sepOn | 1 | 2 | 3 | sepOn; $\C{// sepOn does nothing at start/end of line}$
+sout | ®sep® | 1 | 2 | 3 | ®sep®; $\C{// sep does nothing at start/end of line}$
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
@@ -4082 +4082 @@
 \end{cfa}
 \begin{cfa}[belowskip=0pt]
-sout | sep | 1 | 2 | 3 | sep ; $\C{// use sep to print separator at start/end of line}$
+sout | ®sepVal® | 1 | 2 | 3 | ®sepVal® ; $\C{// use sepVal to print separator at start/end of line}$
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
@@ -4116 +4116 @@
 \Indexc{nl}\index{manipulator!nl@©nl©} inserts a newline.
 \begin{cfa}
-sout | nl; $\C{// only print newline}$
+sout | ®nl®; $\C{// only print newline}$
 sout | 2; $\C{// implicit newline}$
-sout | 3 | nl | 4 | nl; $\C{// terminating nl merged with implicit newline}$
-sout | 5 | nl | nl; $\C{// again terminating nl merged with implicit newline}$
+sout | 3 | ®nl® | 4 | ®nl®; $\C{// terminating nl merged with implicit newline}$
+sout | 5 | ®nl® | ®nl®; $\C{// again terminating nl merged with implicit newline}$
 sout | 6; $\C{// implicit newline}$
 
@@ -4286 +4286 @@
 For the C-string type, precision is the maximum number of printed characters, so the string is truncated if it exceeds the maximum.
 \begin{cfa}[belowskip=0pt]
-sout | wd( 6,8, "abcd" ) | wd( 6,8, "abcdefghijk" ) | wd( 6,3, "abcd" );
+sout | wd( 6,8, "abcd" ) | wd( 6,8, "abcdefghijk" ) | wd( 6,3, "abcd" ) | ®wd( 10, "" )® | 'X';
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
-  abcd abcdefgh    abc
-\end{cfa}
+  abcd abcdefgh    abc®          ®X
+\end{cfa}
+Note, printing the null string with minimum width L pads with L spaces.
 
 \item
@@ -4373 +4374 @@
         sout | t1 | t2 | " \"" | sepGetTuple( sout ) | "\"";
 
-        sout | sepDisable | 1 | 2 | 3;          // globally turn off implicit separator
-        sout | sepEnable | 1 | 2 | 3;           // globally turn on implicit separator
-
-        sout | 1 | sepOff | 2 | 3;                      // locally turn on implicit separator
-        sout | sepDisable | 1 | sepOn | 2 | 3; // globally turn off implicit separator
-        sout | sepEnable;
-        sout | t1 | sepOff | t2;                                // locally turn on/off implicit separator
-
-        sout | sepOn | 1 | 2 | 3 | sepOn ;      // sepOn does nothing at start/end of line
+        sout | sepOff | 1 | 2 | 3;              // globally turn off implicit separator
+        sout | sepOn | 1 | 2 | 3;               // globally turn on implicit separator
+
+        sout | 1 | nosep | 2 | 3;                       // locally turn on implicit separator
+        sout | sepOff | 1 | sep | 2 | 3; // globally turn off implicit separator
+        sout | sepOn;
+        sout | t1 | nosep | t2;                         // locally turn on/off implicit separator
+
+        sout | sep | 1 | 2 | 3 | sep ;  // sep does nothing at start/end of line
         sout | sep | 1 | 2 | 3 | sep ;          // use sep to print separator at start/end of line
 }
@@ -4692 +4693 @@
         sout  | i | j | k | x | y | s;
 }
-
+\end{cfa}
+\begin{cfa}[showspaces=true]
 3 0x5          7 1.234568e+07 987.654n abc
 3 0x5          7 1.234568e+07 987.654n abc