From 3fe705bb549d543dc61d85ea3331c44dd807bc1e Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sat, 20 May 2023 20:16:53 +0000 Subject: counterz (20may23) git-svn-id: svn://tug.org/texlive/trunk@67169 c570f23f-e606-0410-a88d-b1316a301751 --- .../texmf-dist/source/latex/counterz/counterz.dtx | 1409 ++++++++++++++++++++ .../texmf-dist/source/latex/counterz/counterz.ins | 89 ++ 2 files changed, 1498 insertions(+) create mode 100644 Master/texmf-dist/source/latex/counterz/counterz.dtx create mode 100644 Master/texmf-dist/source/latex/counterz/counterz.ins (limited to 'Master/texmf-dist/source/latex') diff --git a/Master/texmf-dist/source/latex/counterz/counterz.dtx b/Master/texmf-dist/source/latex/counterz/counterz.dtx new file mode 100644 index 00000000000..82857faf4cb --- /dev/null +++ b/Master/texmf-dist/source/latex/counterz/counterz.dtx @@ -0,0 +1,1409 @@ +% \iffalse meta-comment +% !TEX program = pdfLaTeX + +%<*internal> +\iffalse +% + +%<*readme> +---------------------------------------------------------------------- +`counterz' --- 2023/05/19 Version 1.0.0 + +Copyright (C) 2023 by Christopher McClain +E-mail: christopher.mcclain@mail.wvu.edu + +Released under the LaTeX Project Public License v1.3c or later +See https://www.latex-project.org/lppl.txt +---------------------------------------------------------------------- + +The `counterz' package provides additional tools for manipulating +counters. The package facilitates the use of stealth prefixes for +counter names in order to help distinguish between counters from +multiple input files. The package also provides a means to generate +random counters and save such counter values for future typesetting. +% + +%<*internal> +\fi +\def\nameofplainTeX{plain} +\ifx\fmtname\nameofplainTeX\else + \expandafter\begingroup +\fi +% + +%<*install> +\input docstrip.tex +\keepsilent +\askforoverwritefalse + +\preamble +---------------------------------------------------------------------- +`counterz' --- 2023/05/19 Version 1.0.0 Additional tools for counters +E-mail: christopher.mcclain@mail.wvu.edu +Released under the LaTeX Project Public License v1.3c or later +See https://www.latex-project.org/lppl.txt +---------------------------------------------------------------------- + +\endpreamble +\postamble + +Copyright (C) 2023 by Christopher McClain + +This work may be distributed and/or modified under the +conditions of the LaTeX Project Public License (LPPL), either +version 1.3c of this license or (at your option) any later +version. The latest version of this license is in the file: + +https://www.latex-project.org/lppl.txt + +and version 1.3 or later is part of all distributions of +LaTeX version 2005/12/01 or later. + +This work has the LPPL maintenance status `maintained'. + +The Current Maintainer of this work is Christopher McClain. + +This work consists of the file counterz.dtx +and the derived files counterz.ins, + counterz.pdf and + counterz.sty. + +\endpostamble + +\usedir{tex/latex/counterz} +\generate{ + \file{\jobname.sty}{\from{\jobname.dtx}{package}} +} + +% +%\endbatchfile + +%<*internal> +\usedir{source/latex/counterz} +\generate{ + \file{\jobname.ins}{\from{\jobname.dtx}{install}} +} +\nopreamble\nopostamble +\usedir{doc/latex/counterz} +\generate{ + \file{README.txt}{\from{\jobname.dtx}{readme}} +} +\ifx\fmtname\nameofplainTeX + \expandafter\endbatchfile +\else + \expandafter\endgroup +\fi +% + +%<*package> +\NeedsTeXFormat{LaTeX2e} +% + +%<*driver> +\documentclass{ltxdoc} +\usepackage{\jobname} +\usepackage[numbered]{hypdoc} +\EnableCrossrefs +\DoNotIndex{\addtocounter,\Alph,\alph,\arabic,\begingroup,\boolfalse,\booltrue, + \catcode,\endgroup,\fnsymbol,\gdef,\ifbool,\ifboolexpr,\ifnumequal, + \ifnumgreater,\ifnumless,\immediate,\jobname,\newcommand, + \newcounter,\newbool,\newwrite,\numexpr,\openout,\pdfuniformdeviate, + \providecounter,\ProvidesPackage,\relax,\renewcommand, + \RequirePackage,\Roman,\roman,\setcounter,\the,\unexpanded,\value, + \whileboolexpr,\write} +\CodelineIndex +\RecordChanges +\begin{document} + \newenvironment{codeoutput}{\newline\newline}{\newline\newline} + \DocInput{\jobname.dtx} +\end{document} +% +% +% \fi +% +%\GetFileInfo{\jobname.sty} +% +%\title{^^A +% The \textsf{counterz} package\thanks{^^A +% This file describes version \fileversion, last revised \filedate.^^A +% }^^A +%} +%\author{^^A +% Christopher McClain\thanks{E-mail: christopher.mcclain@mail.wvu.edu}^^A +%} +%\date{Released \filedate} +% +%\maketitle +% +%\changes{v1.0.0}{2023/05/19}{First public release} +% +% +%\begin{abstract} +% The \textsf{counterz} package provides additional tools for manipulating +% counters. The package facilitates the use of stealth prefixes for +% counter names in order to help distinguish between counters from +% multiple input files. The package also provides a means to generate +% random counters and save such counter values for future typesetting. +%\end{abstract} +% +%\begin{multicols}{2} +% \tableofcontents +%\end{multicols} +% +%\section{Introduction} +% +%\subsection{About} +% +% This project emerged from the author's frequent use of \LaTeX\ counters as +% traditional integer type variables when generating mathematics documents with +% random elements. While pdf\TeX\ primitives such as \cs{pdfuniformdeviate} may +% be used to generate random integers, these integer values will be randomized +% with every typesetting. The \textsf{counterz} package provides a way to save +% the values of counters. Another \textsf{.tex} file is created so that, if +% desired, it can be inputted upon a subsequent typesetting in order to +% initialize the counters with the previously generated values. A boolean +% variable and accompanying commands allow an author to toggle between reusing +% and rerandomizing counters. +% +% One of the consequences of preloading counter values in large projects with +% multiple source files is that one must take care to use distinct counter names +% throughout all of the different files. If the file \textsf{Main.tex} inputs +% \textsf{File1.tex} and \textsf{File2.tex}, and both input files define the +% counter \textit{mycounter}, then this could result in typesetting errors. One +% way to address this problem is to prefix every counter name with the file name +% or some other marker so that the counter names will actually be distinct. For +% example, \textit{File1mycounter} is distinct from \textit{File2mycounter}. +% Very long counter names, however, can make code difficult to read and hinder +% consistent application of this practice. The \textsf{counterz} package +% provides a way to stealthily define and recall such prefixes so that the +% shorter non-prefixed names can be used for the manipulation, recall, and +% typesetting of counters. +% +%\subsection{License} +% +% Copyright \copyright\ 2023 Christopher McClain. This software may be copied, +% distributed, and/or modified under the %terms of the +% \href{https://www.latex-project.org/lppl/}{LaTeX Project Public License}, +% either version 1.3c of this license or any later version. +% +%\subsection{Installation} +% +% This package may be installed by copying the file \textsf{counterz.sty} to +% your local texmf directory. The code and documentation may also be generated +% from \textsf{\jobname.dtx}. Typesetting the documentation requires +% the package \textsf{hypdoc} which is included in \TeX\ distributions and at +% \href{http://www.ctan.org}{The Comprehensive TeX Archive Network}. +% +%\section{User Guide} +% +% To use this package, include the following line in the preamble of your +% document: +% +%\begin{verbatim} +%\usepackage{counterz} +%\end{verbatim} +% The package \textsf{counterz} loads the packages \textsf{etoolbox} and +% \textsf{makecmds}, both of which are included in \TeX\ distributions +% and at \href{http://www.ctan.org}{The Comprehensive TeX Archive Network}. +% +%\subsection{Counter Prefixes} +% +%\DescribeMacro{\setcounterprefix} +%\DescribeMacro{\clearcounterprefix} +% Counter prefixes are stored in an internal macro whose default value is an +% empty string. The command \cs{setcounterprefix}\marg{prefix} is used to change +% this value. For example, to change the prefix to \textit{PurpleMonkey}, use +%\begin{verbatim} +%\setcounterprefix{PurpleMonkey} +%\end{verbatim} +% and to change it from \textit{PurpleMonkey} to \textit{Dishwasher}, use +%\begin{verbatim} +%\setcounterprefix{Dishwasher} +%\end{verbatim} +% The command \cs{clearcounterprefix} returns the prefix to its empty default: +%\begin{verbatim} +%\clearcounterprefix +%\end{verbatim} +% +%\subsection{Manipulating Counters} +% +%\DescribeMacro{\xnewcounter} +%\DescribeMacro{\xprovidecounter} +%\DescribeMacro{\xsetcounter} +%\DescribeMacro{\xaddtocounter} +%\DescribeMacro{\xvalue} +% The command \cs{xnewcounter}\marg{countername} creates a counter with a +% prefixed name. The command \cs{xsetcounter}\marg{countername}\marg{integer} +% assigns the specified value to the counter with the prefixed name. For +% example, suppose that the file \textsf{BoringFile1.tex} contains the +% following: +%\begin{verbatim} +%\xnewcounter{bestcounterever} +%\xsetcounter{bestcounterever}{100} +%\end{verbatim} +% and suppose that the file \textsf{BoringFile2.tex} contains the following: +%\begin{verbatim} +%\xnewcounter{bestcounterever} +%\xsetcounter{bestcounterever}{-29} +%\end{verbatim} +% and, finally, suppose that the file Main.tex contains (in part) the following: +%\begin{verbatim} +%\setcounterprefix{PurpleMonkey} +%\input{BoringFile1} +%\setcounterprefix{Dishwasher} +%\input{BoringFile2} +%\end{verbatim} +% Then typesetting \textsf{Main.tex} will create a counter +% \textit{PurpleMonkeybestcounterever} with the value 100 and a counter +% \textit{Dishwasherbestcounterever} with the value $-29$. By using commands +% \cs{xnewcounter} and \cs{xsetcounter} instead of \cs{newcounter} and +% \cs{setcounter}, \textsf{BoringFile1.tex} and \textsf{BoringFile2.tex} +% may be written independently without considering any counter name conflicts. +% The distinction between the counters is determined by the prefixes defined +% in the file \textsf{Main.tex}. By changing prefixes, \textsf{Main.tex} can +% even input the same file multiple times without conflict. +% +% The commands \cs{xprovidecounter}, \cs{xaddtocounter}, and \cs{xvalue} are +% likewise prefix versions of commands \cs{providecounter}, \cs{addtocounter}, +% and \cs{value}, respectively. When the prefix is empty, the commands expand +% like their standard counterparts. (Note: \cs{providecounter} defines a counter +% if it has not already been defined. See the documentation for the package +% \textsf{makecmds} for details.) +% +%\subsection{Conditional Statements} +% +%\DescribeMacro{\ifctrequal} +%\DescribeMacro{\ifctrless} +%\DescribeMacro{\ifctrmore} +% The command \cs{ifctrequal}\marg{counter1}\marg{counter2}\marg{foo}\marg{bar} +% uses the command \cs{xvalue} to compare the values of the (prefixed) counters +% and then executes \meta{foo} if the values are equal and otherwise executes +% \meta{bar}. The commands \cs{ifctrless} and \cs{ifctrmore} work analogously, +% based on whether the value of prefixed \meta{counter1} is less than that of +% of prefixed \meta{counter2} or more than that of prefixed \meta{counter2}, +% respectively. Consider the example code +%\begin{verbatim} +%\setcounterprefix{TigerTiger} +%\xnewcounter{Small} +%\xsetcounter{Small}{7} +%\xnewcounter{Large} +%\xsetcounter{Large}{11} +%\ifctrequal{Small}{Large}{January}{February} +%\ifctrless{Small}{Large}{March}{April} +%\ifctrmore{Small}{Large}{May}{June} +%\end{verbatim} +% which produces the output +% \begin{codeoutput} +%\setcounterprefix{TigerTiger} +%\xnewcounter{Small} +%\xsetcounter{Small}{7} +%\xnewcounter{Large} +%\xsetcounter{Large}{11} +%\ifctrequal{Small}{Large}{January}{February} +%\ifctrless{Small}{Large}{March}{April} +%\ifctrmore{Small}{Large}{May}{June} +% \end{codeoutput} +% because the value of the counter \textit{TigerTigerSmall} is 7 which is less +% than 11, the value of the counter \textit{TigerTigerLarge}. +% +%\DescribeMacro{\ifctrzero} +%\DescribeMacro{\ifctrneg} +%\DescribeMacro{\ifctrpos} +% The command \cs{ifctrzero}\marg{counter}\marg{foo}\marg{bar} executes +% \meta{foo} if the value of the (prefixed) counter is zero and otherwise +% executes \meta{bar}. The commands \cs{ifctrneg} and \cs{ifctrpos} work +% analogously based on whether the value is negative or positive, respectively. +% The example code +%\begin{verbatim} +%\setcounterprefix{TigerTiger} +%\xprovidecounter{Small} +%\xsetcounter{Small}{7} +%\ifctrzero{Small}{January}{February} +%\ifctrneg{Small}{March}{April} +%\ifctrpos{Small}{May}{June} +%\end{verbatim} +% produces the output +% \begin{codeoutput} +%\setcounterprefix{TigerTiger} +%\xprovidecounter{Small} +%\xsetcounter{Small}{7} +%\ifctrzero{Small}{January}{February} +%\ifctrneg{Small}{March}{April} +%\ifctrpos{Small}{May}{June} +% \end{codeoutput} +% because the value of the counter \textit{TigerTigerSmall} is 7 which is +% positive (and thus nonzero, as well). +% +%\subsection{Displaying Counters} +% +%\DescribeMacro{\xarabic} +%\DescribeMacro{\xroman} +%\DescribeMacro{\xRoman} +%\DescribeMacro{\xalph} +%\DescribeMacro{\xAlph} +%\DescribeMacro{\xfnsymbol} +% The command \cs{xarabic}\marg{counter} is simply a prefix version of the +% standard display command \cs{arabic}. The commands \cs{xroman}, \cs{xRoman}, +% \cs{xalph}, \cs{xAlph}, and \cs{xfnsymbol} are likewise prefix versions of +% the standard display commands \cs{roman}, \cs{Roman}, \cs{alph}, \cs{Alph}, +% and \cs{fnsymbol}, inheriting the restrictions of their parent commands. +% Note that the code +%\begin{verbatim} +%\setcounterprefix{Sneaky} +%\xprovidecounter{Pete} +%\xsetcounter{Pete}{42} +%\arabic{Pete} +%\end{verbatim} +% produces an error because the counter \textit{Pete} is not defined, but the +% code +%\begin{verbatim} +%\setcounterprefix{Sneaky} +%\xprovidecounter{Pete} +%\xsetcounter{Pete}{42} +%\xarabic{Pete} +%\end{verbatim} +% produces the output +% \begin{codeoutput} +%\setcounterprefix{Sneaky} +%\xprovidecounter{Pete} +%\xsetcounter{Pete}{42} +%\xarabic{Pete} +% \end{codeoutput} +% which is the value of the counter \textit{SneakyPete}. The code +%\begin{verbatim} +%\setcounterprefix{Sneaky} +%\xprovidecounter{Pete} +%\xsetcounter{Pete}{42} +%\clearcounterprefix +%\xarabic{Pete} +%\end{verbatim} +% also generates error because the final line is trying to use the +% undefined counter \textit{Pete} after the prefix was returned to its +% default value. +% +% In addition to prefix versions of the standard display commands, the package +% \textsf{counterz} defines some variants of \cs{xarabic} that are useful in +% the display of mathematical expressions. For example, consider the following +% code: +%\begin{verbatim} +%\xprovidecounter{a} +%\xsetcounter{a}{5} +%\xprovidecounter{b} +%\xsetcounter{b}{0} +%\xprovidecounter{c} +%\xsetcounter{c}{-7} +%$\xarabic{a}+\xarabic{b}+\xarabic{c}$ +%\end{verbatim} +% which produces +% \begin{codeoutput} +%\xprovidecounter{a} +%\xsetcounter{a}{5} +%\xprovidecounter{b} +%\xsetcounter{b}{0} +%\xprovidecounter{c} +%\xsetcounter{c}{-7} +%$\xarabic{a}+\xarabic{b}+\xarabic{c}$ +% \end{codeoutput} +% Using \cs{arabicx} causes the expression to +% contain the consecutive pair $+-$. The command +%\DescribeMacro{\xsigned} +% \cs{xsigned}\marg{counter} is like \cs{xarabic} except that nonnegative values +% are preceded by a plus sign ``+''. The code +%\begin{verbatim} +%$\xarabic{a}\xsigned{b}\xsigned{c}$ +%\end{verbatim} +% produces +% \begin{codeoutput} +%$\xarabic{a}\xsigned{b}\xsigned{c}$ +% \end{codeoutput} +% If we wish to suppress the $0$, we can instead use the command +%\DescribeMacro{\xsignednz} +%\DescribeMacro{\xarabicnz} +% \cs{xsignednz}\marg{counter} which is a nonzero version of \cs{xsigned} and, +% if desired or necessary, the command \cs{xarabicnz}\marg{counter} which is a +% nonzero version of \cs{xarabic}. +% The code +%\begin{verbatim} +%$\xarabicnz{a}\xsignednz{b}\xsignednz{c}$ +%\end{verbatim} +% produces +% \begin{codeoutput} +%$\xarabicnz{a}\xsignednz{b}\xsignednz{c}$ +% \end{codeoutput} +%\DescribeMacro{\xnegof} +%\DescribeMacro{\xnegofnz} +%\DescribeMacro{\xnegsigned} +%\DescribeMacro{\xnegsignednz} +% The package also contains variants of these commands for displaying the +% negatives of counters, as demonstrated by the following code: +%\begin{verbatim} +%\xprovidecounter{d} +%\xsetcounter{d}{-2} +%$\xarabic{a}\xsigned{b}\xsigned{c}=\xarabic{d}$\\ +%$\xnegof{d}=\xnegof{a}\xnegsigned{b}\xnegsigned{c}$\\ +%$\xnegofnz{d}=\xnegofnz{a}\xnegsignednz{b}\xnegsignednz{c}$ +%\end{verbatim} +% which produces +%\begin{codeoutput} +%\xprovidecounter{d} +%\xsetcounter{d}{-2} +%$\xarabic{a}\xsigned{b}\xsigned{c}=\xarabic{d}$\\ +%$\xnegof{d}=\xnegof{a}\xnegsigned{b}\xnegsigned{c}$\\ +%$\xnegofnz{d}=\xnegofnz{a}\xnegsignednz{b}\xnegsignednz{c}$ +%\end{codeoutput} +% The preceding commands for displaying values related to counters were created +% by using some other commands that we make available in case they prove useful. +%\DescribeMacro{\xabsof} +%\DescribeMacro{\xsignof} +%\DescribeMacro{\xnegsignof} +% The command \cs{xabsof}\marg{counter} prints the absolute value of +% \meta{counter}. The command \cs{xsignof}\marg{counter} prints a minus sign +% ``-'' if \meta{counter} is negative and otherwise prints a plus sign ``+''. +% (Note that the latter case includes the value zero.) The command +% \cs{xnegsignof}\marg{counter} prints a plus sign ``+'' if \meta{counter} is +% negative and otherwise prints a minus sign ``-''. (Note that the former case +% includes the value zero.) +% +% Additional variants of these commands suppress certain output, as is +% conventional when using integers as coefficients in algebraic expressions. +%\DescribeMacro{\xabsofcoef} +%\DescribeMacro{\xsignofcoef} +%\DescribeMacro{\xnegsignofcoef} +% The command \cs{xabsofcoef}\marg{counter} prints the absolute value of +% \meta{counter} except that it suppresses the values of 1 and 0. The command +% \cs{xsignofcoef}\marg{counter} prints the sign of \meta{counter} if the value +% of \meta{counter} is nonzero. The command \cs{xnegsignofcoef}\marg{counter} +% prints the opposite sign of \meta{counter} if the value of \meta{counter} is +% nonzero. These commands are used to build versions of \cs{xarabic} and +% \cs{xsigned} specific to typesetting coefficients, as we now illustrate. +% +% Consider the following code +%\begin{verbatim} +%\xprovidecounter{a0} +%\xsetcounter{a0}{-10} +%\xprovidecounter{a1} +%\xsetcounter{a1}{1} +%\xprovidecounter{a2} +%\xsetcounter{a2}{-5} +%\xprovidecounter{a3} +%\xsetcounter{a3}{-1} +%\xprovidecounter{a4} +%\xsetcounter{a4}{0} +%\xprovidecounter{a5} +%\xsetcounter{a5}{11} +%$\xarabic{a5}x^5 + \xarabic{a4}x^4 + \xarabic{a3}x^3 + \xarabic{a2}x^2 +% + \xarabic{a1}x + \xarabic{a0} = 42$ +%\end{verbatim} +% and its output +%\begin{codeoutput} +%\xprovidecounter{a0} +%\xsetcounter{a0}{-10} +%\xprovidecounter{a1} +%\xsetcounter{a1}{1} +%\xprovidecounter{a2} +%\xsetcounter{a2}{-5} +%\xprovidecounter{a3} +%\xsetcounter{a3}{-1} +%\xprovidecounter{a4} +%\xsetcounter{a4}{0} +%\xprovidecounter{a5} +%\xsetcounter{a5}{11} +%$\xarabic{a5}x^5 + \xarabic{a4}x^4 + \xarabic{a3}x^3 + \xarabic{a2}x^2 +% + \xarabic{a1}x + \xarabic{a0} = 42$ +%\end{codeoutput} +% We seek a better way to handle the coefficients, especially $1$ and $-1$. +%\DescribeMacro{\xcoef} +%\DescribeMacro{\xsignedcoef} +% The command \cs{xcoef}\marg{counter} prints the value of \meta{counter} except +% that it suppresses the values of 1, 0, and -1, printing a minus sign ``-'' in +% the latter case. The command \cs{xsignedcoef}\marg{counter} is like \cs{xcoef} +% except that positive values are preceded by a plus sign ``+''. We use these to +% write the code +%\begin{verbatim} +%$\xarabic{a5}x^5 + \xarabic{a4}x^4 + \xarabic{a3}x^3 + \xarabic{a2}x^2 +% + \xarabic{a1}x + \xarabic{a0} = 42$\\ +%$\xcoef{a5}\ifctrzero{a5}{}{x^5} \xsignedcoef{a4}\ifctrzero{a4}{}{x^4} +% \xsignedcoef{a3}\ifctrzero{a3}{}{x^3} \xsignedcoef{a2}\ifctrzero{a2}{}{x^2} +% \xsignedcoef{a1}\ifctrzero{a1}{}{x} \xsignednz{a0} = 42$ +%\end{verbatim} +% whose output is +%\begin{codeoutput} +%$\xarabic{a5}x^5 + \xarabic{a4}x^4 + \xarabic{a3}x^3 + \xarabic{a2}x^2 +% + \xarabic{a1}x + \xarabic{a0} = 42$\\ +%$\xcoef{a5}\ifctrzero{a5}{}{x^5} \xsignedcoef{a4}\ifctrzero{a4}{}{x^4} +% \xsignedcoef{a3}\ifctrzero{a3}{}{x^3} \xsignedcoef{a2}\ifctrzero{a2}{}{x^2} +% \xsignedcoef{a1}\ifctrzero{a1}{}{x} \xsignednz{a0} = 42$ +%\end{codeoutput} +%\DescribeMacro{\xnegcoef} +%\DescribeMacro{\xnegsignedcoef} +% The command \cs{xnegcoef}\marg{counter} prints the negative of the value of +% \meta{counter} except that it suppresses the values of 1, 0, and -1, printing +% a ``-'' in the latter case. The command \cs{xnegsignedcoef}\marg{counter} is +% like \cs{xnegcoef} except that positive values are preceded by a plus sign +% ``+''. We use these to write the code +%\begin{verbatim} +%$\xcoef{a5}\ifctrzero{a5}{}{x^5} \xsignedcoef{a4}\ifctrzero{a4}{}{x^4} +% \xsignedcoef{a3}\ifctrzero{a3}{}{x^3} \xsignedcoef{a2}\ifctrzero{a2}{}{x^2} +% \xsignedcoef{a1}\ifctrzero{a1}{}{x} \xsignednz{a0} = 42$\\ +%$\xcoef{a5}\ifctrzero{a5}{}{x^5} \xsignedcoef{a4}\ifctrzero{a4}{}{x^4} +% \xsignedcoef{a2}\ifctrzero{a2}{}{x^2} \xsignednz{a0} +% = \xnegcoef{a3}\ifctrzero{a3}{}{x^3} \xnegsignedcoef{a1}\ifctrzero{a1}{}{x} +% +42$ +%\end{verbatim} +% whose output is +%\begin{codeoutput} +%$\xcoef{a5}\ifctrzero{a5}{}{x^5} \xsignedcoef{a4}\ifctrzero{a4}{}{x^4} +% \xsignedcoef{a3}\ifctrzero{a3}{}{x^3} \xsignedcoef{a2}\ifctrzero{a2}{}{x^2} +% \xsignedcoef{a1}\ifctrzero{a1}{}{x} \xsignednz{a0} = 42$\\ +%$\xcoef{a5}\ifctrzero{a5}{}{x^5} \xsignedcoef{a4}\ifctrzero{a4}{}{x^4} +% \xsignedcoef{a2}\ifctrzero{a2}{}{x^2} \xsignednz{a0} +% = \xnegcoef{a3}\ifctrzero{a3}{}{x^3} \xnegsignedcoef{a1}\ifctrzero{a1}{}{x} +% +42$ +%\end{codeoutput} +% As the reader has probably already observed in the code above, these display +% commands appear to be less efficient than a manual adjustment of signs and +% numbers. For fixed, known values of counters, this assessment is correct. The +% real utility of these commands is not apparent until they are combined with +% randomly generated counter values. +% +%\subsection{Random Counters} +% +%\DescribeMacro{\xrandsetcounter} +%\DescribeMacro{\xrandaddtocounter} +% We first define random versions of \cs{xsetcounter} and \cs{xaddtocounter}. +% The command \cs{xrandsetcounter}\marg{counter}\marg{min}\marg{max} assigns +% to the prefixed \meta{counter} a random integer value between \meta{min} and +% \meta{max}. Analogously, the command +% \cs{xrandaddtocounter}\marg{counter}\marg{min}\marg{max} adds to the prefixed +% \meta{counter} a random integer value between \meta{min} and \meta{max}. The +% following code may be used to produce an expression in the form $ax+b$, where +% $a$ and $b$ are random integers between $-10$ and $10$: +%\begin{verbatim} +%\xprovidecounter{a} +%\xprovidecounter{b} +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ +%\end{verbatim} +% Organized in the following table are sixty instances of output that are +% randomly generated by the typesetting of this document: +%\begin{codeoutput} +%\xprovidecounter{a} +%\xprovidecounter{b} +%\begin{tabular}{rrrrrr} +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ \\ +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ \\ +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ \\ +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ \\ +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ \\ +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ \\ +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ \\ +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ \\ +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ \\ +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ & +%\xrandsetcounter{a}{-10}{10} +%\xrandsetcounter{b}{-10}{10} +%$\xcoef{a}\ifctrzero{a}{\xarabic{b}}{x \xsignednz{b}}$ \\ +%\end{tabular} +%\end{codeoutput} +% +% If our document contains randomly generated counters, but we wish to typeset +% the document again without changing those values, then we need a way to save +% those values. The \textsf{counterz} package offers the following solution: a +% file \textsf{\meta{jobname}.counters.tex} may be created during the +% typesetting process to store the necessary information. For example, if the +% document is named \textsf{Yellowdog.tex}, then the previously generated +% counters and their assigned values will be stored the file +% \textsf{Yellowdog.counters.tex}. +%\DescribeMacro{\opencountersfile} +% The command \cs{opencountersfile} creates and opens the write stream to this +% file. The author only has to include this command once, prior to any commands +% used to save the counter values. +% +%\DescribeMacro{\xsavecounter} +% The command \cs{xsavecounter}\marg{counter} ``saves'' the value of +% \textit{counter} by writing to the file \textsf{\meta{jobname}.counters.tex} +% the relevant \cs{providecounter} and \cs{setcounter} commands. The commands +% written to the file explicitly include the necessary counter prefixes, and +% consequently an author can, if necessary, manually find in the file the +% specific assignment for any counter. The counters file may then be inputted +% near the beginning of a subsequent typesetting to preassign all of the +% values. +% +%\DescribeMacro{\randomizectr} +%\DescribeMacro{\norandomizectr} +%\DescribeMacro{\ifrandomizectr} +% In order to effectively manage the options of randomizing counter values or +% reusing counter values, the \textsf{counterz} package offers the commands +% \cs{randomizectr} and \cs{norandomizectr} that toggle an internal boolean +% variable, and a conditional \cs{ifrandomizectr}\marg{foo}\marg{bar} that +% executes \meta{foo} when the boolean is true and otherwise executes +% \meta{bar}. For example, a document named \textsf{Yellowdog.tex} might +% include the code +%\begin{verbatim} +%\ifrandomizectr{}{input{Yellowdog.counters}} +%\end{verbatim} +% to determine whether to preload previously stored counter values. +% +%\DescribeMacro{\xrandprovidecounter} +%\DescribeMacro{\xrandprovidecounternz} +% The command \cs{xrandprovidecounter}\marg{counter}\marg{min}\marg{max} +% combines the four commands \cs{xprovidecounter}, \cs{ifrandomizectr}, +% \cs{xrandsetcounter}, and \cs{xsavecounter} to define a command that creates +% \meta{counter} if it has not already been defined and, if the document is +% randomized, assigns to \meta{counter} a random integer value between +% \meta{min} and \meta{max} and saves this value to the counters file. The +% command \cs{xrandprovidecounternz} is like \cs{xrandprovidecounter} except +% that the generated value is nonzero. Suppose that \textsf{Neverending.tex} +% contains the code +%\begin{verbatim} +%\randomizectr +%\ifrandomizectr{\opencountersfile}{} +%\setcounterprefix{Southern} +%\xrandprovidecounternz{Oracle}{-10}{10} +%\xcoef{Oracle}x+42 +%\end{verbatim} +% After typesetting once, the resulting document might display an expression +% such as $-9x+42$ and print to \textsf{Neverending.counters.tex} the line +%\begin{verbatim} +%\providecounter {SouthernOracle} \setcounter {SouthernOracle}{-9} +%\end{verbatim} +% After typesetting a second time, the resulting document might display $4x+42$ +% and print to \textsf{Neverending.counters.tex} the line +%\begin{verbatim} +%\providecounter {SouthernOracle} \setcounter {SouthernOracle}{4} +%\end{verbatim} +% If, however, the command \cs{randomizectr} is replaced by \cs{norandomizectr}, +% then a third typesetting will leave both the displayed text and the counters +% file unchanged. (Tip: Users who are concerned about accidental randomization +% might create a terminal prompt with the commands \cs{typeout} and \cs{typein} +% to input the randomization preference, as an added layer of security.) +% +%\StopEventually{^^A +% \PrintChanges +% \PrintIndex +%} +% +%\section{Implementation} +% +% The \textsf{counterz} package loads the two packages \textsf{etoolbox} and +% \textsf{makecmds} for the use of conditional tests (boolean and numerical) +% and the macro \cs{providecounter}. +% +% \begin{macrocode} +%<*package> +\ProvidesPackage{counterz}[2023/05/19 v1.0.0 Additional tools for counters] +\RequirePackage{etoolbox,makecmds} +% \end{macrocode} +% +%\subsection{Counter Prefixes} +% +%\begin{macro}{\@counterz@counterprefix} +%\begin{macro}{\setcounterprefix} +%\begin{macro}{\clearcounterprefix} +% +% The default expansion of \cs{@counterz@counterprefix} is null, but it can be +% changed with the commands \cs{setcounterprefix} and \cs{clearcounterprefix}. +% +% \begin{macrocode} +\newcommand{\@counterz@counterprefix}{} +\newcommand{\setcounterprefix}[1]{\renewcommand{\@counterz@counterprefix}{#1}} +\newcommand{\clearcounterprefix}{\setcounterprefix{}} +% \end{macrocode} +% +%\end{macro} +%\end{macro} +%\end{macro} +% +%\subsection{Manipulating Counters} +% +%\begin{macro}{\xnewcounter} +%\begin{macro}{\xprovidecounter} +%\begin{macro}{\xsetcounter} +%\begin{macro}{\xaddtocounter} +%\begin{macro}{\xvalue} +% +% These commands are prefix versions of commands \cs{newcounter}, +% \cs{providecounter}, \cs{setcounter}, \cs{addtocounter}, and \cs{value}, +% respectively. The creation, modification, or use of the counters is carried +% out on a prefixed version of the specified counter name. When +% \cs{@counterz@counterprefix} is null, the commands expand like their standard +% counterparts. +% +% \begin{macrocode} +\newcommand{\xnewcounter}[1]{\newcounter{\@counterz@counterprefix #1}} +\newcommand{\xprovidecounter}[1]{\providecounter{\@counterz@counterprefix #1}} +\newcommand{\xsetcounter}[2]{\setcounter{\@counterz@counterprefix #1}{#2}} +\newcommand{\xaddtocounter}[2]{\addtocounter{\@counterz@counterprefix #1}{#2}} +\newcommand{\xvalue}[1]{\value{\@counterz@counterprefix #1}} +% \end{macrocode} +% +%\end{macro} +%\end{macro} +%\end{macro} +%\end{macro} +%\end{macro} +% +%\subsection{Conditional Statements} +% +% The following commands provide if-then-else constructs analogous to those in +% the package \textsf{etoolbox}. The notable difference is that the arguments +% are counter names. The command \cs{xvalue} is used to determine the values of +% the counters, so that the stored prefix is applied to the specified counter +% names before execution. +% +%\begin{macro}{\ifctrequal} +% +% \cs{ifctrequal}\marg{counter1}\marg{counter2}\marg{foo}\marg{bar} executes +% \meta{foo} if the value of \meta{counter1} is equal to the value of +% \meta{counter2} and otherwise executes \meta{bar}. +% +% \begin{macrocode} +\newcommand{\ifctrequal}[4]{\ifnumequal{\xvalue{#1}}{\xvalue{#2}}{#3}{#4}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\ifctrless} +% +% \cs{ifctrless}\marg{counter1}\marg{counter2}\marg{foo}\marg{bar} executes +% \meta{foo} if the value of \meta{counter1} is less than the value of +% \meta{counter2} and otherwise executes \meta{bar}. +% +% \begin{macrocode} +\newcommand{\ifctrless}[4]{\ifnumless{\xvalue{#1}}{\xvalue{#2}}{#3}{#4}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\ifctrmore} +% +% \cs{ifctrmore}\marg{counter1}\marg{counter2}\marg{foo}\marg{bar} executes +% \meta{foo} if the value of \meta{counter1} is more than the value of +% \meta{counter2} and otherwise executes \meta{bar}. +% +% \begin{macrocode} +\newcommand{\ifctrmore}[4]{\ifnumless{\xvalue{#2}}{\xvalue{#1}}{#3}{#4}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\ifctrzero} +% +% \cs{ifctrzero}\marg{counter}\marg{foo}\marg{bar} executes \meta{foo} if +% the value of \meta{counter} is zero and otherwise executes \meta{bar}. +% +% \begin{macrocode} +\newcommand{\ifctrzero}[3]{\ifnumequal{\xvalue{#1}}{0}{#2}{#3}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\ifctrneg} +% +% \cs{ifctrneg}\marg{counter}\marg{foo}\marg{bar} executes \meta{foo} if the +% value of \meta{counter} is negative and otherwise executes \meta{bar}. +% +% \begin{macrocode} +\newcommand{\ifctrneg}[3]{\ifnumless{\xvalue{#1}}{0}{#2}{#3}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\ifctrpos} +% +% \cs{ifctrpos}\marg{counter}\marg{foo}\marg{bar} executes \meta{foo} if the +% value of \meta{counter} is positive and otherwise executes \meta{bar}. +% +% \begin{macrocode} +\newcommand{\ifctrpos}[3]{\ifnumless{\xvalue{#1}}{1}{#3}{#2}} +% \end{macrocode} +% +%\end{macro} +% +%\subsection{Displaying Counters} +% +%\begin{macro}{\xarabic} +%\begin{macro}{\xroman} +%\begin{macro}{\xRoman} +%\begin{macro}{\xalph} +%\begin{macro}{\xAlph} +%\begin{macro}{\xfnsymbol} +% +% These commands include prefix versions of the standard display commands. +% +% \begin{macrocode} +\newcommand{\xarabic}[1]{\arabic{\@counterz@counterprefix #1}} +\newcommand{\xroman}[1]{\roman{\@counterz@counterprefix #1}} +\newcommand{\xRoman}[1]{\Roman{\@counterz@counterprefix #1}} +\newcommand{\xalph}[1]{\alph{\@counterz@counterprefix #1}} +\newcommand{\xAlph}[1]{\Alph{\@counterz@counterprefix #1}} +\newcommand{\xfnsymbol}[1]{\fnsymbol{\@counterz@counterprefix #1}} +% \end{macrocode} +% +%\end{macro} +%\end{macro} +%\end{macro} +%\end{macro} +%\end{macro} +%\end{macro} +% The following commands likewise apply the stored prefix to the counter name. +% These commands are designed to aid in the typesetting of counter values within +% algebraic expressions while observing particular conventions about the display +% of numbers and their and their signs. +% +%\begin{macro}{\xabsof} +% +% \cs{xabsof}\marg{counter} prints the absolute value of \meta{counter}. +% +% \begin{macrocode} +\newcommand{\xabsof}[1]{% + \ifctrneg{#1}{% + \the \numexpr 0 - \xvalue{#1} \relax% + }{% + \xarabic{#1}% + }% +} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xsignof} +% +% \cs{xsignof}\marg{counter} prints a minus sign ``-'' if \meta{counter} is +% negative and otherwise prints a plus sign ``+''. Note that the latter case +% includes the value zero. +% +% \begin{macrocode} +\newcommand{\xsignof}[1]{\ifctrneg{#1}{-}{+}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xnegsignof} +% +% \cs{xnegsignof}\marg{counter} prints a plus sign ``+'' if \meta{counter} is +% negative and otherwise prints a minus sign ``-''. Note that the latter case +% includes the value zero. +% +% \begin{macrocode} +\newcommand{\xnegsignof}[1]{\ifctrneg{#1}{+}{-}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xsigned} +% +% \cs{xsigned}\marg{counter} prints the absolute value of \meta{counter}, +% preceded by a plus sign ``+'' or a minus sign ``-'' as defined by +% \cs{xsignof}. +% +% \begin{macrocode} +\newcommand{\xsigned}[1]{\xsignof{#1} \xabsof{#1}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xsignednz} +% +% \cs{xsignednz}\marg{counter} is like \cs{xsigned} but suppresses the number +% zero. +% +% \begin{macrocode} +\newcommand{\xsignednz}[1]{\ifctrzero{#1}{}{\xsigned{#1}}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xarabicnz} +% +% \cs{xarabicnz}\marg{counter} is like \cs{xarabic} but suppresses the number +% zero. +% +% \begin{macrocode} +\newcommand{\xarabicnz}[1]{\ifctrzero{#1}{}{\xarabic{#1}}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xnegsigned} +% +% \cs{xnegsigned}\marg{counter} prints the absolute value of \meta{counter}, +% preceded by a plus sign ``+'' or a minus sign ``-'' as defined by +% \cs{xnegsignof}. +% +% \begin{macrocode} +\newcommand{\xnegsigned}[1]{\xnegsignof{#1} \xabsof{#1}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xnegsignednz} +% +% \cs{xnegsignednz}\marg{counter} is like \cs{xnegsigned} but suppresses the +% number zero. +% +% \begin{macrocode} +\newcommand{\xnegsignednz}[1]{\ifctrzero{#1}{}{\xnegsigned{#1}}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xnegof} +% +% \cs{xnegof}\marg{counter} prints the negative of the value of \meta{counter}. +% +% \begin{macrocode} +\newcommand{\xnegof}[1]{\ifctrpos{#1}{-}{}\xabsof{#1}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xnegofnz} +% +% \cs{xnegofnz}\marg{counter} is like \cs{xnegof} but suppresses the number +% zero. +% +% \begin{macrocode} +\newcommand{\xnegofnz}[1]{\ifctrzero{#1}{}{\xnegof{#1}}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xcoef} +% +% \cs{xcoef}\marg{counter} prints the value of \meta{counter} except that it +% suppresses the values of 1, 0, and -1, printing a ``-'' in the latter case. +% +% \begin{macrocode} +\newcommand{\xcoef}[1]{% + \ifboolexpr{test {\ifnumless{\xvalue{#1}}{-1}}% + or test {\ifnumgreater{\xvalue{#1}}{1}}}{% + \xarabic{#1}% + }{% + }% + \ifnumequal{\xvalue{#1}}{-1}{-}{}% +} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xnegcoef} +% +% \cs{xnegcoef}\marg{counter} prints the value of \meta{counter} except that it +% suppresses the values of 1, 0, and -1, printing a ``-'' in the former case. +% +% \begin{macrocode} +\newcommand{\xnegcoef}[1]{% + \ifboolexpr{test {\ifnumless{\xvalue{#1}}{-1}}% + or test {\ifnumgreater{\xvalue{#1}}{1}}}{% + \xnegof{#1}% + }{% + }% + \ifnumequal{\xvalue{#1}}{1}{-}{}% +} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xabsofcoef} +% +% \cs{xabsofcoef}\marg{counter} prints the absolute value of \meta{counter} +% except that it suppresses the values of 1 and 0. +% +% \begin{macrocode} +\newcommand{\xabsofcoef}[1]{% + \ifboolexpr{test {\ifnumless{\xvalue{#1}}{-1}}% + or test {\ifnumgreater{\xvalue{#1}}{1}}}{% + \xabsof{#1}% + }{% + } +} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xsignofcoef} +% +% \cs{xsignofcoef}\marg{counter} prints the sign of \meta{counter} if +% \meta{counter} is nonzero. +% +% \begin{macrocode} +\newcommand{\xsignofcoef}[1]{\ifctrzero{#1}{}{\xsignof{#1}}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xnegsignofcoef} +% +% \cs{xnegsignofcoef}\marg{counter} prints the opposite sign of \meta{counter} +% if \meta{counter} is nonzero. +% +% \begin{macrocode} +\newcommand{\xnegsignofcoef}[1]{\ifctrzero{#1}{}{\xnegsignof{#1}}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xsignedcoef} +% +% \cs{xsignedcoef}\marg{counter} is like \cs{xcoef} except that positive values +% are preceded by a plus sign ``+''. +% +% \begin{macrocode} +\newcommand{\xsignedcoef}[1]{\xsignofcoef{#1} \xabsofcoef{#1}} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xnegsignedcoef} +% +% \cs{xnegsignedcoef}\marg{counter} is like \cs{xsignedcoef} except using the +% opposite sign. +% +% \begin{macrocode} +\newcommand{\xnegsignedcoef}[1]{\xnegsignofcoef{#1} \xabsofcoef{#1}} +% \end{macrocode} +% +%\end{macro} +% +%\subsection{Random Counters} +% +% The commands \cs{xrandsetcounter} and \cs{xrandaddtocounter} use the pdf\TeX\ +% primitive \cs{pdfuniformdeviate} to provide random versions of +% \cs{xsetcounter} and \cs{xaddtocounter}. +% +%\begin{macro}{\xrandsetcounter} +% +% \cs{xrandsetcounter}\marg{counter}\marg{min}\marg{max} assigns to (the +% prefixed) \meta{counter} a random integer value between \meta{min} and +% \meta{max}. +% +% \begin{macrocode} +\newcommand{\xrandsetcounter}[3]{% + \xsetcounter{#1}{% + \the \numexpr #2+\pdfuniformdeviate \numexpr #3-#2+1 \relax + } +} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xrandaddtocounter} +% +% \cs{xrandaddtocounter}\marg{counter}\marg{min}\marg{max} adds to (the +% prefixed) \meta{counter} a random integer value between \meta{min} and +% \meta{max}. +% +% \begin{macrocode} +\newcommand{\xrandaddtocounter}[3]{% + \xaddtocounter{#1}{% + \the \numexpr #2+\pdfuniformdeviate \numexpr #3-#2+1 \relax + } +} +% \end{macrocode} +% +%\end{macro} +% The following commands are designed to provide a means by which authors can +% generate random values for counters but also preserve those values for future +% typesettings. This is accomplished by storing counters and their values in an +% external file and then inputting the file before a subsequent typesetting. +% +%\begin{macro}{\opencountersfile} +% +% The command \cs{opencountersfile} creates and opens the write stream to the +% file \textsf{\meta{jobname}.counters.tex}, referenced by the macro +% \cs{countersfile}. +% +% \begin{macrocode} +\newcommand{\opencountersfile}{% + \newwrite\countersfile + \immediate\openout\countersfile=\jobname.counters.tex +} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\@counterz@openbrace} +%\begin{macro}{\@counterz@closebrace} +% +% The commands \cs{@counterz@openbrace} and \cs{@counterz@closebrace} +% facilitate the writing of the brace delimiters to \cs{countersfile}. +% +% \begin{macrocode} +\begingroup + \catcode`<=1 \catcode`>=2 + \catcode`{=12 \catcode`}=12 + \gdef\@counterz@openbrace<{> + \gdef\@counterz@closebrace<}> +\endgroup +% \end{macrocode} +% +%\end{macro} +%\end{macro} +% +%\begin{macro}{\xsavecounter} +% +% \cs{xsavecounter}\marg{counter} writes \cs{providecounter} and \cs{setcounter} +% commands to the file \textsf{\meta{jobname}.counters.tex} so that they may be +% inputted as part of a future typesetting. +% +% \begin{macrocode} +\newcommand{\xsavecounter}[1]{% + \immediate\write\countersfile{% + \unexpanded{\providecounter}\@counterz@openbrace% + \@counterz@counterprefix #1\@counterz@closebrace% + \unexpanded{ \setcounter}\@counterz@openbrace% + \@counterz@counterprefix #1\@counterz@closebrace% + \@counterz@openbrace% + \arabic{\@counterz@counterprefix #1}\@counterz@closebrace% + }% +}% +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\randomizectr} +%\begin{macro}{\norandomizectr} +% +% In order to assign a random value to a counter during one typesetting and +% avoid overwriting this value with a random assignment during another +% typesetting, the boolean \textit{@counterz@random} is used to distinguish +% between the two typesettings. The value of \textit{@counterz@random} may +% be changed by the commands \cs{randomizectr} and \cs{norandomizectr}. +% +% \begin{macrocode} +\newbool{@counterz@random} +\newcommand{\randomizectr}{\booltrue{@counterz@random}} +\newcommand{\norandomizectr}{\boolfalse{@counterz@random}} +% \end{macrocode} +% +%\end{macro} +%\end{macro} +% +%\begin{macro}{\ifrandomizectr} +% +% \cs{ifrandomizectr}\marg{foo}\marg{bar} executes \meta{foo} if the boolean +% \textit{@counterz@random} is true and otherwise executes \meta{bar}. +% +% \begin{macrocode} +\newcommand{\ifrandomizectr}[2]{% + \ifbool{@counterz@random}{#1}{#2} +}% +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xrandprovidecounter} +% +% \cs{xrandprovidecounter}\marg{counter}\marg{min}\marg{max} creates +% \meta{counter} if it does not already exist, and if the boolean +% \textit{@counterz@random} is true then \meta{counter} is assigned a +% random integer value between \meta{min} and \meta{max} and then saved. +% +% \begin{macrocode} +\newcommand{\xrandprovidecounter}[3]{% + \xprovidecounter{#1} + \ifrandomizectr{% + \xrandsetcounter{#1}{#2}{#3} + \xsavecounter{#1} + }{% + } +} +% \end{macrocode} +% +%\end{macro} +% +%\begin{macro}{\xrandprovidecounternz} +% +% \cs{xrandprovidecounternz}\marg{counter}\marg{min}\marg{max} does the same +% job as the command \cs{xrandprovidecounter} except that the value of +% \meta{counter} is randomized until it is nonzero. +% +% \begin{macrocode} +\newcommand{\xrandprovidecounternz}[3]{% + \xprovidecounter{#1} + \ifrandomizectr{% + \xsetcounter{#1}{0} + \whileboolexpr{ test {\ifnumequal{\xvalue{#1}}{0}}}{% + \xrandsetcounter{#1}{#2}{#3} + } + \xsavecounter{#1} + }{% + } +} +% \end{macrocode} +% +%\end{macro}% +% +% \begin{macrocode} +% +% \end{macrocode} +%\Finale \ No newline at end of file diff --git a/Master/texmf-dist/source/latex/counterz/counterz.ins b/Master/texmf-dist/source/latex/counterz/counterz.ins new file mode 100644 index 00000000000..7de3d881876 --- /dev/null +++ b/Master/texmf-dist/source/latex/counterz/counterz.ins @@ -0,0 +1,89 @@ +%% +%% This is file `counterz.ins', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% counterz.dtx (with options: `install') +%% ---------------------------------------------------------------------- +%% `counterz' --- 2023/05/19 Version 1.0.0 Additional tools for counters +%% E-mail: christopher.mcclain@mail.wvu.edu +%% Released under the LaTeX Project Public License v1.3c or later +%% See https://www.latex-project.org/lppl.txt +%% ---------------------------------------------------------------------- +%% + + + + +\input docstrip.tex +\keepsilent +\askforoverwritefalse + +\preamble +---------------------------------------------------------------------- +`counterz' --- 2023/05/19 Version 1.0.0 Additional tools for counters +E-mail: christopher.mcclain@mail.wvu.edu +Released under the LaTeX Project Public License v1.3c or later +See https://www.latex-project.org/lppl.txt +---------------------------------------------------------------------- + +\endpreamble +\postamble + +Copyright (C) 2023 by Christopher McClain + +This work may be distributed and/or modified under the +conditions of the LaTeX Project Public License (LPPL), either +version 1.3c of this license or (at your option) any later +version. The latest version of this license is in the file: + +https://www.latex-project.org/lppl.txt + +and version 1.3 or later is part of all distributions of +LaTeX version 2005/12/01 or later. + +This work has the LPPL maintenance status `maintained'. + +The Current Maintainer of this work is Christopher McClain. + +This work consists of the file counterz.dtx +and the derived files counterz.ins, + counterz.pdf and + counterz.sty. + +\endpostamble + +\usedir{tex/latex/counterz} +\generate{ + \file{\jobname.sty}{\from{\jobname.dtx}{package}} +} + +\endbatchfile + + + +%% +%% Copyright (C) 2023 by Christopher McClain +%% +%% This work may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License (LPPL), either +%% version 1.3c of this license or (at your option) any later +%% version. The latest version of this license is in the file: +%% +%% https://www.latex-project.org/lppl.txt +%% +%% and version 1.3 or later is part of all distributions of +%% LaTeX version 2005/12/01 or later. +%% +%% This work has the LPPL maintenance status `maintained'. +%% +%% The Current Maintainer of this work is Christopher McClain. +%% +%% This work consists of the file counterz.dtx +%% and the derived files counterz.ins, +%% counterz.pdf and +%% counterz.sty. +%% +%% +%% End of file `counterz.ins'. -- cgit v1.2.3