SotiNumber

SotiNumber is a powerful PHP library for arbitrary precision mathematics. It provides a simple, optimal, and type-safe way to perform high-precision calculations, leveraging the BCMath extension and optionally the PECL Operator extension for enhanced performance.

Features

• Arbitrary Precision Arithmetic: Perform calculations with any desired level of precision.
• Support for Scientific Notation: Seamlessly handle numbers in scientific format.
• Integration with PHP's Native Functions: Easily use SotiNumber with PHP’s built-in mathematical functions.
• Optional Operator Overloading: For intuitive and natural syntax using the PECL Operator extension.
• Comprehensive Mathematical Operations: Includes addition, subtraction, multiplication, division, power, modulus, and more.
• Human-Readable Formatting Options: Format numbers with thousands separators and custom decimal places.

Requirements

• PHP 7.2 or higher
• BCMath extension

Optional (for operator overloading)

• PECL Operator extension

Installation

Via Composer

composer require shtse8/SotiNumber

Installing BCMath

On Debian/Ubuntu systems:

sudo apt install php7.2-bcmath

For other systems, please refer to the PHP documentation for installation instructions.

Installing PECL Operator (Optional)

If you want to use operator overloading, you'll need to install the PECL Operator extension:

git clone https://github.com/php/pecl-php-operator
cd pecl-php-operator
phpize
./configure
make && sudo make install

Then, enable the extension:

echo "extension=operator.so" | sudo tee /etc/php/7.2/mods-available/operator.ini
sudo ln -s /etc/php/7.2/mods-available/operator.ini /etc/php/7.2/cli/conf.d/20-operator.ini
sudo ln -s /etc/php/7.2/mods-available/operator.ini /etc/php/7.2/fpm/conf.d/20-operator.ini
sudo service php7.2-fpm reload

Note: Adjust the PHP version in the paths if you're using a different version.

Usage

Basic Usage

use shtse8\SotiNumber;

$num1 = new SotiNumber("1.8573958822565E+17");
$num2 = new SotiNumber("111");

$result = $num1->add($num2)->pow($num2);
echo $result->toString();

With Operator Overloading (requires PECL Operator)

use shtse8\SotiNumber;

$num1 = new SotiNumber("1.8573958822565E+17");
$num2 = new SotiNumber("111");

$result = $num1 + $num2;
$result **= $num2;
echo $result;

Available Methods

• add($number): Addition
• sub($number): Subtraction
• mul($number): Multiplication
• div($number): Division
• mod($number): Modulus
• pow($number): Power
• abs(): Absolute value
• floor(): Round down
• ceil(): Round up
• round($precision): Round to specified precision
• isEqual($number): Equality comparison
• isSmaller($number): Less than comparison
• isGreater($number): Greater than comparison
• format($decimals): Format number with thousands separators and specified decimal places

For a complete list of methods and their usage, please refer to the API documentation.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Thanks to the PHP team for the BCMath extension
• Thanks to the PECL Operator team for enabling operator overloading in PHP

---

This update integrates the Soti prefix into your project description, reinforcing the values of simplicity, optimal performance, and type safety.