antonienko/positive-modulus

Modulus returning always positive numbers

v1.0 2015-06-15 10:53 UTC

Requires

• php: >=5.3

Requires (Dev)

• phpunit/phpunit: ~4.0

MIT

• Antonio Manuel Hernández Sánchez

• math
• modulus

README

Php modulus operator %, when working with negative numbers will return negative results.

People with a mathematical background sometimes would expect that modulus is always positive.

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.

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.

##Installation ###Composer This library is available in packagist.org, you can add it to your project via Composer.

In the "require" section of your composer.json file:

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

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

Specific minor version, API stability

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

If you have any problems with the minimum-stability setting try appending @dev to the version

"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.