hpez / phpbignum

A bignum library for PHP

PHPBignum

A bignum library for PHP.

Type	Addition	Subtraction	Division	Multiplication	Square root	Power
BigInt	done	done	done	done	done	done
BigFloat	done	done	done	done	done	done

Setting up for developers

Just clone the project, go to the project directory and run composer install and should be good to go! Oh and also for running tests you should do vendor/phpunit/phpunit/phpunit tests/.

Installation

The package is installable via composer require hpez/php-bignum or packagist repo

Usage

<?php

// BigInteger Addition
$bigInt1 = new BigInt('123456')
$bigInt2 = new BigInt('654321');
$bigInt1->add($bigInt2);
echo $bigInt1; // "777777"

// BigFloat Addition
$bigFloat1 = new BigFloat('123456.111');
$bigFloat2 = new BigFloat('654321.22');
$bigFloat1->add($bigFloat2)
echo $bigFloat1; // "777777.331"

// BigInteger Subtraction
$bigInt3 = new BigInt('777777');
$bigInt4 = new BigInt('654321');
$bigInt3->sub($bigInt4);
echo $bigInt3; // "123456"

// BigFloat Subtraction
$bigFloat3 = new BigFloat('123456.111');
$bigFloat4 = new BigFloat('654321.22');
$bigFloat3->sub($bigFloat4);
echo $bigFloat3; // results "530865.109"

// BigInteger Division
$bigInt5 = new BigInt('777777');
$bigInt6 = new BigInt('654321');
$bigInt5->div($bigInt6);
echo $bigInt5; // "1"

// BigFloat Division
$bigFloat5 = new BigFloat('123456.111');
$bigFloat6 = new BigFloat('654321.22');
$bigFloat5->div($bigFloat6);
echo $bigFloat5; // "0.188678"

// BigInteger Multiplication
$bigInt7 = new BigInt('777777');
$bigInt8 = new BigInt('654321');
$bigInt7->multiply($bigInt8);
echo $bigInt7; // "508915824417"

// BigFloat Multiplication
$bigFloat7 = new BigFloat('123456.111');
$bigFloat8 = new BigFloat('654321.22');
$bigFloat7->multiply($bigFloat8);
echo $bigFloat7; // "80779953165.97542"

// BigInteger Modulo
$bigInt9 = new BigInt('777777');
$bigInt10 = new BigInt('654321');
$bigInt9->mod($bigInt10);
echo $bigInt9; // "123456"

// BigInteger Power
$bigInt11 = new BigInt('777777');
$bigInt12 = new BigInt('1');
$bigInt11->pow($bigInt12);
echo $bigInt11; // "777777"

// BigFloat Power
$bigFloat9 = new BigFloat('12345.12345');
$bigInt13 = new BigInt('3');
$bigFloat9->pow($bigInt13);
echo $bigFloat9 // "1881422405168.320420453463625"

// BigInteger Square Root
$bigInt14 = new BigInt('10000');
$bigInt15->sqrt();
echo $bigInt14; // "100"

// BigFloat Square Root
$bigFloat10 = new BigFloat('2');
$bigFloat11->sqrt(7);
echo $bigFloat10; // "1.4142136"

// BigInteger Lesser-Than
$bigInt16 = new BigInt('1234567890');
$bigInt17 = new BigInt('1234567891');
echo $bigInt16->isLesserThan($bigInt17); // True

$bigInt18 = new BigInt('1234567891');
$bigInt19 = new BigInt('1234567891');
echo $bigInt18->isLesserThan($bigInt19); // False

// BigInteger Bigger-Than
$bigInt20 = new BigInt('1234567891');
$bigInt21 = new BigInt('1234567890');
echo $bigInt20->isBiggerThan($bigInt21); // True

$bigInt22 = new BigInt('1234567891');
$bigInt23 = new BigInt('1234567891');
echo $bigInt22->isBiggerThan($bigInt23); // False

Roadmap

The goal of this project is making a complete Bignum library for PHP language, so operations other than the ones mentioned in the table should be added too (trigonometric functions, ...).

Contribution

Any contribution in the form of an issue or a pull request is more than welcome! Also if you have any questions, feel free to create a new issue or comment on existing ones.

phpbignum's Issues

BigFloat square root

Square root function implementation for BigFloat class

General discussion

Good morning, I saw your comment at dev.to, so to be able to help you I want to understand some of the design desitions you're making here.

1. Why you're not using PSR-4 for class autoloading?
2. Why are you requiring the composer autoload file on every class?

😄

Add usage to documentation

Documentation should include usage samples of BigInt and BigFloat class.

BigFloat trigonometric functions

Sin, Cos, Tan, Cot, Sec, Cosec should be added for BigFloat.

BigFloat power

Power function implementation for BigFloat class

BigFloat Division

Div method should be added for BigFloat class.

BigInt square root

Square root for Bigint class.

Tests should cover more testcases

Tests for BigInt class which are located in tests/BigIntTest.php, should cover more testcases, meaning there need to be more testcases for each functionallity. Actually means improving code coverage
Any pull request improving coverage would be merged.

Project roadmap?

Hello, I've come here from Dev.to and had a query. What's the roadmap for the project ahead? Currently I see that only four arithmetic operations need implementation on BigFloat. Once these are done, is the project finished? 🤔

BigInt power

BigInt class power function implementation

Add travis-ci to repo

Problem with div

PHPBignum/tests/BigFloatTest.php

Line 1 in 226b107

<?php

public function testDivWorks4(): void
{
    $bigFloat1 = new BigFloat('3.1415926535898');
    $bigFloat2 = new BigFloat('180');
    $this->assertEquals(
        new BigFloat('0.01745327777777777777777777777778'),
        $bigFloat1->
        div($bigFloat2)
    );
}

Failed asserting that two objects are equal.
--- Expected
+++ Actual
@@ @@
hpez\bignum\BigFloat Object (

• 'number' => '0.01745327777777777777777777777778'

• 'number' => '1745.329252'
  )

BigFloat Subtraction

Sub method for BigFloat class should be added.

BigFloat Multiplication

Multiply method should be added for BigFloat class.