piggly/php-decimal

PHP的任意精度十进制类类型。

1.0.0 2021-05-25 02:45 UTC

This package is auto-updated.

Last update: 2024-09-25 10:44:25 UTC


README

Latest Version on Packagist Software License

此库类似于 decimal.js,所有业务逻辑的版权和著作权归 Michael Mclaughlin 和您的 贡献者 所有。

piggly/php-decimal 与PHP完全兼容,并且与decimal.js库一样快速。以下是其附加的所有功能。

功能

此库主要由Decimal类组成。一个Decimal由系数、指数和符号组成。它可以处理整数和浮点值,具有任意精度。

这里的精度是以有效数字来指定的,而不是小数位数,所有计算都四舍五入到精度(类似于Python的decimal模块),而不仅仅是涉及除法的计算。

此库还添加了三角函数等,并支持非整数幂,这使得它成为一个功能更强大的库。

  • 整数和浮点数;
  • 简单但功能齐全的API;
  • 复制了许多原生数学方法;
  • 还可以处理十六进制、二进制和八进制值;
  • 比其他PHP库更快、更容易使用;
  • 无依赖项或要求;
  • 全面的文档和测试套件。

用法

Decimal可以处理整数、浮点数、字符串和Decimal对象

$w = new Decimal(123);
$x = new Decimal(123.4567);
$y = new Decimal('123456.7e-3');
$z = new Decimal($x);

如果包含适当的前缀,值也可以是二进制、十六进制或八进制

$w = new Decimal('0xff.f');		// '255.9375'
$x = new Decimal('0b10101100');	// '172'

Decimal是不可变的,在意义上,它的方法不会改变它,总是返回一个新的object

$x = new Decimal(0.3);

$x->minus(0.1);						// $x is still 0.3
$y = $x->minus(0.1)->minus(0.1);	// $x is still 0.3 and $y is 0.1

所有返回Decimal值的函数都可以链式调用。

$x->dividedBy($y)->plus($z)->times(9)->floor();
$x->times('1.23456780123456789e+9')->plus(9876.5432321)->dividedBy('4444562598.111772')->ceil();

许多方法名有简短的别名。

$x->squareRoot()->dividedBy($y)->toPower(3)->equals($x->sqrt()->div($y)->pow(3))	// true
$x->cmp($y->mod($z)->neg()) == 1 && x->comparedTo($y->modulo($z)->negated()) == 1	// true

有许多方法可以将Decimal转换为字符串,

$x = new Decimal(255.5);

$x->toExponential(5)  // '2.55500e+2'
$x->toFixed(5)        // '255.50000'
$x->toPrecision(5)    // '255.50'
$x->valueOf()         // '255.5'

几乎所有方法都可作为static使用。

Decimal::sqrtOf('6.98372465832e+9823')      // '8.3568682281821340204e+4911'
Decimal::powOf(2, 0.0979843)                // '1.0702770511687781839'

Decimal可以处理INFNAN值。

$x = new Decimal(INF);     // INF
$y = new Decimal(NAN);     // NAN

有许多方法可以对Decimal进行检查。

$x->isCountless()    // If it is INF or NAN
$x->isFinite()       // If it is a finite number
$x->isInfinite()     // If it is an infinite number
$x->isInt()          // If it is an integer
$x->isNaN()          // If it is NAN
$x->isNegative()     // If it is negative
$x->isNulled()       // If it is INF, NAN or Zero
$x->isPositive()     // If it is positive
$x->isZero()         // If it is zero

顺便说一下,有一个可选的最大分母参数的toFraction方法。

$z = new Decimal(355);
$pi = $z->dividedBy(113);        // '3->1415929204'
$pi->toFraction();               // [ '7853982301', '2500000000' ]
$pi->toFraction(1000);           // [ '355', '113' ]

所有计算都根据DecimalConfig对象的precisionrounding属性指定的有效数字和舍入模式进行舍入。

每个Decimal类都与一个DecimalConfig相关联。它可以是全局配置,也可以是为特定十进制数创建的自定义配置。

对于高级用法,可以创建多个Decimal,每个都有自己的独立配置,该配置适用于从它创建的所有Decimal数字。

// Set the precision and rounding of the global instance, 
// applies to all Decimal objects without configurations attached to it.
DecimalConfig::instance()->set([ 'precision' => 5, 'rounding' => 4 ]);

$decimal9 = DecimalConfig::clone()->set([ 'precision' => 9, 'rounding' => 1 ]);

$x = new Decimal(5);
$y = new Decimal(5, $decimal9);

$x->div(3);     // '1.6667'
$y->div(3);     // '1.66666666'

// $decimal9 applies to all `Decimal` numbers 
// created from $y in this case
$y->div(3)->times(1.5) // '2.50000000'

Decimal对象的价值以浮点格式存储,其中包含其digitsexponentsign

$x = new Decimal(-12345.67);

$x->getDigits();          // [ 12345, 6700000 ]    digits (base 10000000)
$x->getExponent();        // 4                     exponent (base 10)
$x->getSign();            // -1                    sign

有关更多信息,请参阅docs目录中的API参考,目前您可以前往decimal.js API,因为此库与之完全兼容。

安装

Composer

  1. 在您的控制台,在项目文件夹中,输入composer require piggly/php-decimal
  2. 别忘了在您的代码库中添加Composer的自动加载文件require_once('vendor/autoload.php');

手动安装

  1. 使用git clone https://github.com/piggly-dev/php-decimal.git下载或克隆存储库;
  2. 之后,转到cd /path/to/piggly/php-decimal
  3. 使用composer install安装所有Composer的依赖项。
  4. 在您的代码库中添加项目的自动加载文件 require_once('/path/to/piggly/php-decimal/vendor/autoload.php');

依赖项

该库具有以下外部依赖项

  • PHP 7.3+。

待办事项

在代码中,有一些标注 @todo,表示该库可能需要的一些改进。

变更日志

有关所有代码更改的信息,请参阅 变更日志 文件。

测试代码

该库使用 PHPUnit。我们对本应用的所有主要类进行了测试。

vendor/bin/phpunit

您必须始终使用 PHP 7.3 及以上版本运行测试。对库的任何更改都需要通过所有最旧的和新测试。

!! 一些测试很重,测试时请注意,它们可能需要大量的内存。

贡献

在提交贡献之前,请参阅 贡献 文件中的信息。

鸣谢

decimal.js

支持项目

Piggly Studio 是一家位于巴西里约热内卢的代理机构。如果您喜欢这个库并想支持这项工作,请随意向 BTC 钱包 3DNssbspq7dURaVQH6yBoYwW3PhsNs8dnK 捐款 ❤。

许可证

MIT 许可证(MIT)。请参阅 许可证