From c2c2230cf02ac8504141e25ff525c0baf6a71bb2 Mon Sep 17 00:00:00 2001
From: Lumi Pakkanen <lumi.pakkanen@gmail.com>
Date: Wed, 22 May 2024 17:53:24 +0300
Subject: [PATCH] Implement ceiling modulo

---
 src/__tests__/fraction.spec.ts | 30 +++++++++++++++++++++++++++++-
 src/fraction.ts                | 16 ++++++++++++++++
 2 files changed, 45 insertions(+), 1 deletion(-)

diff --git a/src/__tests__/fraction.spec.ts b/src/__tests__/fraction.spec.ts
index ee5e0e5..e144b3a 100644
--- a/src/__tests__/fraction.spec.ts
+++ b/src/__tests__/fraction.spec.ts
@@ -1,5 +1,5 @@
 import {describe, it, expect} from 'vitest';
-import {Fraction, gcd, lcm, mmod} from '../fraction';
+import {Fraction, gcd, lcm, mmod, modc} from '../fraction';
 
 describe('gcd', () => {
   it('can find the greatest common divisor of 12 and 15 (number)', () => {
@@ -78,6 +78,34 @@ describe('mmod', () => {
   it('works with negative numbers (bigint)', () => {
     expect(mmod(-5n, 3n)).toBe(1n);
   });
+
+  it('produces NaN for 1 % 0', () => {
+    expect(mmod(1, 0)).toBeNaN();
+  });
+
+  it('throws for 1n % 0n', () => {
+    expect(() => mmod(1n, 0n)).toThrow();
+  });
+});
+
+describe('Ceiling modulo', () => {
+  it('works like clockwork', () => {
+    expect([...Array(13).keys()].map(i => modc(i, 12))).toEqual([
+      12, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12,
+    ]);
+  });
+
+  it('works with negative numbers (bigint)', () => {
+    expect(modc(-5n, 3n)).toBe(1n);
+  });
+
+  it('produces 0 for 1 % 0', () => {
+    expect(modc(1, 0)).toBe(0);
+  });
+
+  it('produces 0n for 1n % 0n', () => {
+    expect(modc(1n, 0n)).toBe(0n);
+  });
 });
 
 describe('Fraction', () => {
diff --git a/src/fraction.ts b/src/fraction.ts
index b0b19b1..45dffdc 100644
--- a/src/fraction.ts
+++ b/src/fraction.ts
@@ -68,6 +68,22 @@ export function mmod(a: number | bigint, b: typeof a): typeof a {
   return ((a % b) + b) % b;
 }
 
+/**
+ * Ceiling modulo.
+ * @param a The dividend.
+ * @param b The divisor.
+ * @returns The remainder of Euclidean division of a by b where b modc b === b.
+ */
+export function modc(a: number, b: number): number;
+export function modc(a: bigint, b: bigint): bigint;
+export function modc(a: number | bigint, b: typeof a): typeof a {
+  if (!b) {
+    return b;
+  }
+  // @ts-ignore
+  return ((a % b) + b) % b || b;
+}
+
 /**
  *
  * This class offers the possibility to calculate fractions.