Adds modulus (remainder) method

Author: elliotjreed

src/ElliotJReed/Maths/Number.php

@@ -83,6 +83,13 @@ public function squareRoot(): self
         return $this;
     }
 
+    public function modulus(int | float | string $divisorNumber): self
+    {
+        $this->number = \bcmod($this->number, (string) $divisorNumber, $this->precision);
+
+        return $this;
+    }
+
     public function isLessThan(int | float | string $number): bool
     {
         $result = \bccomp($this->number, (string) $number, $this->precision);

tests/ElliotJReed/Maths/NumberTest.php

@@ -525,6 +525,39 @@ public function testItReturnsTheSquareRootWhenBaseNumberIsAnInteger(): void
         $this->assertSame(5, $number->asInteger(\PHP_ROUND_HALF_DOWN));
     }
 
+    public function testItReturnsModulusWhenBaseNumberIsAnInteger(): void
+    {
+        $number = new Number(5);
+        $number->modulus(3);
+
+        $this->assertSame('2', $number->asString());
+        $this->assertSame(2.0, $number->asFloat());
+        $this->assertSame(2, $number->asInteger());
+        $this->assertSame(2, $number->asInteger(\PHP_ROUND_HALF_DOWN));
+    }
+
+    public function testItReturnsModulusWhenBaseNumberIsAFloat(): void
+    {
+        $number = new Number(5.5);
+        $number->modulus(2.5);
+
+        $this->assertSame('0.5', $number->asString());
+        $this->assertSame(0.5, $number->asFloat());
+        $this->assertSame(1, $number->asInteger());
+        $this->assertSame(0, $number->asInteger(\PHP_ROUND_HALF_DOWN));
+    }
+
+    public function testItReturnsModulusWhenBaseNumberIsAString(): void
+    {
+        $number = new Number('5.5');
+        $number->modulus('2.5');
+
+        $this->assertSame('0.5', $number->asString());
+        $this->assertSame(0.5, $number->asFloat());
+        $this->assertSame(1, $number->asInteger());
+        $this->assertSame(0, $number->asInteger(\PHP_ROUND_HALF_DOWN));
+    }
+
     public function testItReturnsTrueWhenNumberIsLessThanTheBaseNumberWhenCheckingIfNumberIsLessThanBaseNumber(): void
     {
         $number = new Number('100.01');