2023-12-05 14:22:58 -05:00
# libtommath
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.
## Build Status
### Travis CI
master: [](https://github.com/libtom/libtommath/actions/workflows/main.yml?query=branch%3Amaster+++)
develop: [](https://github.com/libtom/libtommath/actions/workflows/main.yml?query=branch%3Adevelop+++)
### 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/ )
2024-03-06 15:11:36 -05:00
### Pre-built packages
We sometimes upload `deb` packages of the latest state from the develop branch to [packagecloud.io ](https://packagecloud.io/libtom/packages ).
Use those packages with caution and at your own discretion.
2023-12-05 14:22:58 -05:00
## Summary
The `develop` branch contains the in-development version. Stable releases are tagged.
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.
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
Tests are located in `demo/` and can be built in two flavors.
* `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.
### CMake support
The project provides support for the CMake build system.
```
git clone https://github.com/libtom/libtommath.git
mkdir -p libtommath/build
cd libtommath/build
cmake ..
make -j$(nproc)
```
A shared library build can be done by setting `-DBUILD_SHARED_LIBS=On` when invoking the `cmake` command.
