Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ayaankhan98/bigint

Efficient OpenSource Big Integer(Library) Support for C++
https://github.com/ayaankhan98/bigint

algorithms biginteger biginteger-cpp c-plus-plus cmake cpp hacktoberfest hacktoberfest2020 large-numbers mathematics open-source opensource-library

Last synced: 3 months ago
JSON representation

Efficient OpenSource Big Integer(Library) Support for C++

Awesome Lists containing this project

README

        




![Awesome CI Workflow](https://github.com/ayaankhan98/bigINT/workflows/Awesome%20CI%20Workflow/badge.svg)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ef219f076b1a4fb184fba0108c3ea3c5)](https://www.codacy.com/gh/ayaankhan98/bigINT/dashboard?utm_source=github.com&utm_medium=referral&utm_content=ayaankhan98/bigINT&utm_campaign=Badge_Grade)
[![License: BSL](https://img.shields.io/badge/License-BSL-green.svg)](https://github.com/ayaankhan98/bigINT/blob/main/LICENSE)
![GitHub forks](https://img.shields.io/github/forks/ayaankhan98/bigINT?style=social)

# bigINT
Big Integer(Library) Support for C++

### LICENSE
Boost Software License - Version 1.0 - August 17th, 2003

Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:

The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

### Contributions

Contributors are welcome!

Currently we have the minimal project setup, we will keep on improving the repository standards as soon as we progress.

We aim to build a library for C++ 17 or above for big integer support

- Feel free to give suggestions or point bugs by rasing issues

## Required Tools
- CMake 3.16.8 or above
( you can download CMake from [here](https://cmake.org/download/) )
- GCC 7.5.0 or above

## Installation

```
# fork the repository in your account
# clone the forked repository on your system

git clone https://github.com/[username]/bigINT.git

# for building the project locally make a build directory

mkdir build && cd build

# configure the project using CMake

cmake ..

# after configuration run

make

## for running tests go to /scripts and execute

sh test_runner.sh

# or alternatively you can use

# for running tests of operators

cd build/tests/operators
ctest

# for running tests of operations

cd build/tests/operations
ctest
```