antonienko/positive-modulus

Modulus returning always positive numbers

Positive Modulus

, _(*1)

Php modulus operator %, when working with negative numbers will return negative results., _(*2)

People with a mathematical background sometimes would expect that modulus is always positive., _(*3)

That's the case when you are trying to iterate on a set of elements by decrementing the iterator, when you reach -1, you want the modulus operation to give you the highest number again to continue the iteration on the last element., _(*4)

After some research, I found that both behaviours could be mathematically correct, so this library is for those who need a modulus that always returns a positive result., _(*5)

Installation

Composer

This library is available in packagist.org, you can add it to your project via Composer., _(*6)

In the "require" section of your composer.json file:, _(*7)

Always up to date (bleeding edge, API not guaranteed stable), _(*8)

"antonienko/positive-modulus": "dev-master"

Specific minor version, API stability, _(*9)

"antonienko/positive-modulus": "0.2.*"

If you have any problems with the minimum-stability setting try appending @dev to the version, _(*10)

"antonienko/positive-modulus": "0.2.*@dev"

Sample Usage

PositiveModulus::calc($a, $b);

License Information

Lincensed under The MIT License (MIT). See the LICENSE file for more details., _(*11)