ayaankhan98 / bigint

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

Hi there 👋 I'm Ayaan.

• 📫 You can reach me at
  • [email protected]
  • LinkedIn

bigint's Issues

[feat] implement a PRNG for largeInt

Description

• Implement a Pseudo Random Number Generator (PRNG) for largeInt class that will be able to generate Random Large integers

[feat] implement __builtin_clz(x) for largeInt

Description

• This function is used to count the leading zeros of the large integer. Note : clz = count leading zero’s
• include tests for new implementation

[feat] sqrt() implementation

sqrt(x) returns the square root of largeInt x
also implement tests

Issues with constructor with string in largeInt class

Describe the bug
When a largeInt object is initialized with a string of negative integer, then it prints double - sign when printed with cout.

To Reproduce
Steps to reproduce the behavior:
largeInt d("-234");
cout<<d<<endl;

Expected behavior
Output should be -234 but the output is --234

clang-formatter needs to be reconfigured

[feat] min() implementaion

min(a, b) returns the minimum of a and b

there could be different possible overloads
see #21 and implement the corrosponding min() overloads

[feat] doxygen documentation configuration

[feat] ostream overload with tests

overload ostream operator with tests

[feat] max() implementation

implement the following function for largeInt class

• max(a, b) returns the maximum of a and b
  max() can have overloads example

max(largeInt, largeInt);
max(largeInt, int);
max(largeInt, int64_t);

there are more possibile overloads
but for now aim is to implement these trivial overloads

[feat] operator overloads

• + overload

• - overload

• * overload

• / overload

• += overload

• -= overload

• *= overload

• /= overload

• % overload

• %= overload

• == overload

• = overload

• != overload

• < overload

• <= overload

• > overload

• >= overload

also include tests for corrosponding operators

[feat] implement __builtin_ctz(x) for largeInt

Description

• This function is used to count the trailing zeros of the given integer. Note : ctz = count trailing zeros.
• include tests for new implementation

[feat] implement libbig::largeInt::to_binary()

Description

• implement to_binary() function which returns the binary equivalent of a largeInt
• include tests for new implementation

Schonhage–Strassen algorithm Multiplication optimization

Description

Optimize the already exist large Integer mutiplication algorithm (Karastuba Algorithm) by Schonhage–Strassen algorithm

configure ctests and cmake

istream operator tests

write unit test for istream operator

[feat] implement _builtin_popcount(x) for largInts

Description

• a method on the class largeInt which return the count the number of one’s(set bits) in an large integer.
• include tests for new implementation

[feat] implement _builtin_parity(x) for largeInt

Description

• This function is used to check the parity of a large int. This function returns true(1) if the number has odd parity else it returns false(0) for even parity.
• include tests for new implementation

[feat] pow() implementation

pow(a, b) returns a^b

implement the possible overloads of pow()

Unnecessary copies

Many of the operator overloads are taking in arguments by value. This will cause unnecessary copies of the objects. Better to convert them to const ref wherever possible.

Not_Equal_To implementation

Returns false if numbers are equal else returns true.

Please assign this to me.

[feat] overload bitwise operators for large Integers

Description

Implement all bitwise operator overloads for large Integers

• Bitwise OR

• Bitwise AND

• Bitwise NOT

• Bitwise XOR

Command file(COPY) not working as expected.

Describe the bug
Command file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/input.txt DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/input.txt) in tests/operators/CMakeLists.txt actually copies input.txt under build/tests/operators/input.txt/input.txt

This means when tests try to open input.txt, they are opening a directory instead of actual *.txt file. Surprisingly std::ifstream::is_open() return true in such cases, causing the tests to be reported as pass with ever being run.

The command should be file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/input.txt DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/)

To Reproduce
Steps to reproduce the behavior:

1. Configure the project with cmake.
2. See the directory structure under build/tests/

Expected behavior
The additional input.txt directory should not be created.

Screenshots

Desktop:

• OS: Windows 10 and Ubuntu 20.04

[feat] addition overload with tests

overload addition operator

• largeInt + largeInt
• largeInt + int
• largeInt + int64_t
• largeint + long long

Some tests fails to open .txt files.

Describe the bug
Directory structure generated by MSVC compiler is a little different. This causes all the tests using txt files to fail, because they don't find the required input *.txt files. It seems cmake files will have to be modified to copy all the txt files to correct location depending on current platform.

To Reproduce
Steps to reproduce the behavior:

1. Clone this repo on a Windows machine.
2. Build it with cmake and MSVC compiler.
3. Run tests.
4. Some tests fail to open *.txt file.

Expected behavior
Tests should pass.

Desktop:

• OS: Windows 10

Additional context
if(WIN32) can be used.

[feat] Configure windows CI workflow

Description

Currently we have only macOS and ubuntu CI workflow,
task is to do the same for windows also.