2020-12-28 21:40:37 +00:00
# libtommath
2019-06-09 20:44:26 +00:00
2020-12-28 21:40:37 +00:00
This is the git repository for [LibTomMath ](http://www.libtom.net/LibTomMath/ ), a free open source portable number theoretic multiple-precision integer (MPI) library written entirely in C.
2019-06-09 20:44:26 +00:00
2020-12-28 21:40:37 +00:00
## Build Status
### Travis CI
master: [](https://travis-ci.org/libtom/libtommath)
develop: [](https://travis-ci.org/libtom/libtommath)
### AppVeyor
master: [](https://ci.appveyor.com/project/libtom/libtommath/branch/master)
develop: [](https://ci.appveyor.com/project/libtom/libtommath/branch/develop)
### ABI Laboratory
API/ABI changes: [check here ](https://abi-laboratory.pro/tracker/timeline/libtommath/ )
## Summary
2019-06-09 20:44:26 +00:00
The `develop` branch contains the in-development version. Stable releases are tagged.
2020-12-28 21:40:37 +00:00
Documentation is built from the LaTeX file `bn.tex` . There is also limited documentation in `tommath.h` .
There is also a document, `tommath.pdf` , which describes the goals of the project and many of the algorithms used.
2019-06-09 20:44:26 +00:00
2020-12-28 21:40:37 +00:00
The project can be build by using `make` . Along with the usual `make` , `make clean` and `make install` ,
there are several other build targets, see the makefile for details.
There are also makefiles for certain specific platforms.
## Testing
2019-06-09 20:44:26 +00:00
Tests are located in `demo/` and can be built in two flavors.
2020-12-28 21:40:37 +00:00
* `make test` creates a stand-alone test binary that executes several test routines.
* `make mtest_opponent` creates a test binary that is intended to be run against `mtest` .
`mtest` can be built with `make mtest` and test execution is done like `./mtest/mtest | ./mtest_opponent` .
`mtest` is creating test vectors using an alternative MPI library and `test` is consuming these vectors to verify correct behavior of ltm
## Building and Installing
Building is straightforward for GNU Linux only, the section "Building LibTomMath" in the documentation in `doc/bn.pdf` has the details.
