diff options
Diffstat (limited to 'macros/latex/contrib/bnumexpr/README.md')
-rw-r--r-- | macros/latex/contrib/bnumexpr/README.md | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/macros/latex/contrib/bnumexpr/README.md b/macros/latex/contrib/bnumexpr/README.md new file mode 100644 index 0000000000..bda6edef58 --- /dev/null +++ b/macros/latex/contrib/bnumexpr/README.md @@ -0,0 +1,111 @@ +| Source: bnumexpr.dtx +| Version: v1.4, 2021/05/12 (doc: 2021/05/12) +| Author: Jean-Francois Burnol +| Info: Expressions with big integers +| License: LPPL 1.3c + +bnumexpr usage +============== + +The LaTeX package `bnumexpr` allows expandable computations with +integers and the four infix operators `+`, `-`, `*`, `/` using the +expression syntax familiar from the `\numexpr` e-TeX parser, with +these extensions: + +- arbitrarily big integers, +- floored division `//`, +- associated modulo `/:`, +- power operators `^` and `**`, +- factorial post-fix operator `!`, +- comma separated expressions, +- the space character as well as the underscore may serve + to separate groups of digits, +- optional conversion of output to hexadecimal. + +The expression parser is a scaled-down variant from the +`\xintiiexpr...\relax` +parser from package [xintexpr](http://ctan.org/pkg/xintexpr). + +To support hexadecimal input and output, the package +[xintbinhex](http://ctan.org/pkg/xint) is loaded automatically. + +The package loads by default [xintcore](http://ctan.org/pkg/xint) +but the option _custom_ together with macro `\bnumexprsetup` allow to map +the syntax elements to macros from an alternative big integer +expandable engine of the user own choosing, +and then [xintcore](http://ctan.org/pkg/xint) is not loaded. + +Note; the possibility not to use the xintcore macros might be +removed in the future: perhaps a future release will maintain during +computations a private internal representation (especially tailored +either for the xintcore macros or new ones which would be included +within `bnumexpr.sty` itself) and the constraints this implies may +render optional use of other macros impossible. + +Installation +============ + +Use your installation manager to install or update `bnumexpr`. + +Else, obtain `bnumexpr.dtx`, from CTAN: + +> <http://www.ctan.org/pkg/bnumexpr> + +Run `"etex bnumexpr.dtx"` to extract these files: + +`bnumexpr.sty` + : this is the style file. + +`README.md` + +`bnumexprchanges.tex` + : change history. + +`bnumexpr.tex` + : can be used to generate the documentation: + + : - with latex+dvipdfmx: `"latex bnumexpr.tex"` (thrice) then + `"dvipdfmx bnumexpr.dvi"`. + + : - with pdflatex: `"pdflatex bnumexpr.tex"` (thrice). + + : In both cases files `README.md` and `bnumexprchanges.tex` must + be located in the same repertory as `bnumexpr.tex` and `bnumexpr.dtx`. + +without `bnumexpr.tex`: + : `"pdflatex bnumexpr.dtx"` (thrice) extracts all files and + simultaneously generates the pdf documentation. + +Finishing the installation: + + bnumexpr.sty --> TDS:tex/latex/bnumexpr/ + + bnumexpr.dtx --> TDS:source/latex/bnumexpr/ + + bnumexpr.pdf --> TDS:doc/latex/bnumexpr/ + README.me --> TDS:doc/latex/bnumexpr/ + +License +======= + +Copyright (C) 2014-2021 by Jean-Francois Burnol + +| This Work may be distributed and/or modified under the +| conditions of the LaTeX Project Public License 1.3c. +| This version of this license is in + +> <http://www.latex-project.org/lppl/lppl-1-3c.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 "author-maintained". + +The Author and Maintainer of this Work is Jean-Francois Burnol. + +This Work consists of the main source file `bnumexpr.dtx` +and the derived files + + bnumexpr.sty, bnumexpr.pdf, bnumexpr.tex, bnumexprchanges.tex, + and README.md + |