Giter VIP home page Giter VIP logo

decimal-object's Introduction

Decimal Object

Build Status codecov Latest Stable Version Minimum PHP Version PHPStan License

Decimal value object for PHP.

Background

When working with monetary values, normal data types like int or float are not suitable for exact arithmetic. Try out the following in PHP:

var_dump(0.1 + 0.2);        // float(0.3)
var_dump(0.1 + 0.2 - 0.3);  // float(5.5511151231258E-17)

Handling them as string is a workaround, but as value object you can more easily encapsulate some of the logic.

Alternatives

Solutions like https://php-decimal.io require a PHP extension (would make it faster, but also more difficult for some servers to be available). For details see the wiki.

Features

  • Super strict on precision/scale. Does not lose significant digits on its own. You need to trim() for this manually.
  • Speaking API (no le, gt methods).
  • Basic math operations and checks supported.
  • Immutability.
  • Handle very large and very small numbers.

Installation

Requirements

  • bcmath PHP extension enabled

Composer (preferred)

composer require spryker/decimal-object

Usage

See Documentation for more details.

Implementations

The following libraries are using the Decimal value object:

decimal-object's People

Contributors

a-sabaa avatar asmarovydlo avatar dereuromark avatar m7moud avatar olhalivitchuk avatar peter279k avatar spryker-bot avatar tamasnyulas avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

decimal-object's Issues

API todos

TODO/Questions

  • Internal state: normalized form as digits + exponent?
  • Rounding + ceil()/floor()
  • Assert/check edge case values (very small values)
  • sum(), average(), max(), min() as static methods ?
  • modulo()/power()?
  • shift()/toMagnitude($exponent) ?
  • API naming add() => plus(), subtract() => minus(), multiply() => multipliedBy/times(), divide() => devidedBy() ?

Rounding Example:

(string)$decimal->round(1); // '123.4'
(string)$decimal->round(2); // '123.45'
(string)$decimal->round(3); // '123.456'
(string)$decimal->round(4); // '123.4560' (trailing zeroes are added)
(string)$decimal->round(5); // '123.45600' (trailing zeroes are added)

php-decimal.io looks fishy

Hey, I just wanted to watch your documentary and accidentally clicked on https://php-decimal.io. The site looks pretty fishy and seems to contain some AI generated content. I think you can throw out the link :)

btw, thanks for providing this great project!

ceil() doesn't appear work for very small numbers

Using ceil() on a number such as "0.09" returns zero, but should return 1. PHP's ceil() function returns 1 for a float value of 0.09.

eg.

$num = Decimal::create(0.09000,5)->ceil();  //$num = 0 (should be 1)
$num = Decimal::create(0.00001,5)->ceil();  //$num = 0 (should be 1)
$num = Decimal::create(1.00001,5)->ceil();  //$num = 1 (should be 2)
$num = ceil(0.09);  //$num = 1 (correct)
$num = ceil(0.00001);  //$num = 1 (correct)
$num = ceil(1.00001);  //$num = 2 (correct)

Is this a bug or am I doing something wrong?

greatherThanOrEquals() Typo?

Hi. Thank you for the great package.

I noticed that there is an extra "h" in the greatherThanOrEquals() function. By right it should be greaterThanOrEquals().

It's not a big issue. Just thought I'd let you know anyway. :)

Thanks again.

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.