Giter Club home page Giter Club logo

qed's Introduction

Qed by Whateverthing

Qed (pronounced "ked") provides method chaining on BCMath operations, allowing you to write smoother and more readable calculation code.

Qed also includes polyfill functions for bcround, bcceil, and bcfloor, which have official implementations coming in a future PHP release.

(Note that Qed's polyfills are not guaranteed to be mathematically sound. Please don't use them for anything even the slightest bit important.)

Example

A set of basic operations:

$num = new Qed('123');
$num = $num->add('27')->mul('4');

echo $num->value; // 600

Setting the scale:

BCMath operations have a concept of a "scale factor". This can become quite important - certain numbers may end up being unintentionally truncated if the scale is not set to a suitable value.

Scale may be a bit different than precision. For more information, see the bcscale() documentation on the PHP website.

$num = new Qed('123', 5);
$divisor = new Qed('456');
$num = $num->div($divisor)->mul('10');

echo $num->value; // 2.69730

Note that the scale follows the left-side of the flow. If a Qed object is passed as the divisor (or any other operand), that object's scale will be ignored.

Rounding:

While bcround() isn't yet available in PHP, Qed provides a polyfill function and a helper method. This polyfill function is primitive and deeply unreliable.

But, if you want to risk it, here's how to use it:

$num = new Qed('123', 10);
$divisor = new Qed('456');
$num = $num->div($divisor)->mul('10')->round(2);

echo $num->value; // 2.70

Note that the precision value is NOT the same as a normal "scale" value, because scale factor cannot be a negative value (but precision can). The returned Qed object will have the same scale value as the originating instance, the precision value is only applied to the internals of bcround.

There is a second parameter, $roundHalf, which can be one of the PHP_ROUND_HALF_* constants. See php.net/round for more information about how they are expected to work.

qed's People

Contributors

beryllium avatar

Watchers

 avatar  avatar

Forkers

711jackkelley

qed's Issues

Add more thorough test cases

Math is serious business, and serious business demands serious tests.

Some test cases that should be added:

  • Big number calculations
  • Specific precision calculations
  • Complex chains of calculations

Add polyfills for bcround, bcfloor, bcceil

An RFC passed that will bring bcround, bcfloor, and bcceil to PHP:

https://wiki.php.net/rfc/adding_bcround_bcfloor_bcceil_to_bcmath

It would be nice if there were some polyfills. Qed could provide that.

Proposal:

  • Polyfill Functions file provided by Qed
  • Loaded by composer
  • Only defines the functions if they don't exist
  • Qed class updated to present the new operations

I probably don't have the skill to write performant versions of these, but I could probably stub in some basic semblance of functionality.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.