Get modulus of an arbitrary precision number (original) (raw)

bcmod

(PHP 4, PHP 5, PHP 7)

bcmod — Get modulus of an arbitrary precision number

Description

bcmod ( string $dividend , string $divisor [, int $scale = 0 ] ) : string

Parameters

dividend

The dividend, as a string.

divisor

The divisor, as a string.

Return Values

Returns the modulus as a string, or NULL if divisor is 0.

Changelog

Version Description
7.2.0 dividend and divisor are no longer truncated to integer, so now the behavior ofbcmod() follows fmod() rather than the % operator.
7.2.0 The scale parameter was added.

Examples

Example #1 bcmod() example

<?php bcscale(0); echo bcmod( '5', '3'); // 2 echo bcmod( '5', '-3'); // 2 echo bcmod('-5', '3'); // -2 echo bcmod('-5', '-3'); // -2 ?>

Example #2 bcmod() with decimals

<?php bcscale(1); echo bcmod('5.7', '1.3'); // 0.5 as of PHP 7.2.0; 0 previously ?>

See Also