diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/bnumexpr/README |
Initial commit
Diffstat (limited to 'macros/latex/contrib/bnumexpr/README')
-rw-r--r-- | macros/latex/contrib/bnumexpr/README | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/macros/latex/contrib/bnumexpr/README b/macros/latex/contrib/bnumexpr/README new file mode 100644 index 0000000000..a8f5c0341f --- /dev/null +++ b/macros/latex/contrib/bnumexpr/README @@ -0,0 +1,126 @@ +Source: bnumexpr.dtx +Version: v1.2e, 2019/01/08 (doc: 2019/01/08) +Author: Jean-Francois Burnol +Info: Expressions with big integers +License: LPPL 1.3c + + + +README: USAGE, INSTALLATION, LICENSE + + +Usage + +The package bnumexpr allows _expandable_ computations with big integers +and the four infix operators +, -, *, / familiar from the \numexpr e-TeX +parser. + +Besides extending the scope to arbitrarily big numbers (and having a +more complete syntax, for example -(1) is legal input), it adds the (by +default) floored division operator //, and its associated modulo /:, the +power operator ^ (or equivalently **), and the factorial post-fix +operator !. The space character as well as the underscore character _ +both may serve to optionally separate digits in long numbers, for better +readability of the input. + +For example: + + \bnumeval{( 92_874_927_979^5 - 31_9792_7979^6 ) / 30!} + + The above expands (in two steps) to `-4006240736596543944035189` + (the `/` does rounded division to match the `\numexpr` behaviour). + +The expression parser is scaled-down from the \xinttheiiexpr...\relax +parser as provided by package xintexpr[1]: it does not handle +hexadecimal input, boolean operators, dummy or user defined variables, +functions, etc... + +By default, the package loads xintcore[2] (release 1.3d is then +required) but it is possible via option _custom_ and macro +\bnumexprsetup to map the operators to macros of one's own choice. It is +the responsability of the user to load the packages providing these +custom macros. + +Notice that 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 + +Obtain bnumexpr.dtx (and possibly, bnumexpr.ins and the README) from +CTAN: + + http://www.ctan.org/pkg/bnumexpr + +Both "tex bnumexpr.ins" and "tex bnumexpr.dtx" extract from bnumexpr.dtx +the following files: + +bnumexpr.sty + this is the style file. + +README.md + reconstitutes this README. + +bnumexprchanges.tex + lists changes from the initial version. + +bnumexpr.tex + can be used to generate the documentation: + - with latex+dvipdfmx: "latex bnumexpr.tex" (thrice) then + "dvipdfmx bnumexpr.dvi". + + Ignore dvipdfmx warnings, but if the pdf file has problems with + fonts (possibly from an old dvipdfmx), use then rather pdflatex. + + - with pdflatex: "pdflatex bnumexpr.tex" (thrice). + + In both cases files README.md and bnumexprchanges.tex must be + present in the same repertory. + +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.ins --> TDS:source/latex/bnumexpr/ + + bnumexpr.pdf --> TDS:doc/latex/bnumexpr/ + README --> TDS:doc/latex/bnumexpr/ + +Files bnumexpr.tex, bnumexprchanges.tex, README.md may be discarded. + + +License + +Copyright (C) 2014-2019 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.ins, bnumexpr.tex, + bnumexprchanges.tex, README.md + +[1] http://www.ctan.org/pkg/xint + +[2] http://www.ctan.org/pkg/xint |