Skip to main content

FoxMath 🦊

Minimalist CLI & library for number theory and cryptography: BSGS discrete log solver, arithmetic functions (μ, σ, τ), Jacobi symbol & Solovay–Strassen test, Pollard's ρ factorization, totient & Carmichael functions, Tonelli-Shanks roots, interactive REPL, Weierstrass elliptic curves, Chinese Remainder Theorem, and continued fractions.

More about me / other projects: abhrankan.duckdns.org

One binary. Clean output. Zero footguns. Educational by design.

Built with curiosity — for students, tinkerers, and crypto/math enthusiasts.

Features

  • Legendre symbol
  • Jacobi symbol (jacobi)
  • Solovay–Strassen probabilistic primality test (solovay)
  • Modular square root via Tonelli-Shanks (sqrtmod)
  • Deterministic Miller-Rabin primality test (isprime)
  • Prime factorization via Pollard's rho & trial division (factor)
  • Discrete logarithm solver via Baby-step Giant-step (dlog)
  • Euler's totient φ(n) and Carmichael λ(n) (totient)
  • Multiplicative order and primitive roots (order)
  • Classical arithmetic functions: Möbius μ(n), divisor count τ(n), divisor sum σ(n)
  • Extended Euclidean algorithm (egcd) & Bézout coefficients
  • Modular multiplicative inverse (modinv)
  • Euler/Hermann Machin-like π approximation
  • Interactive Python REPL with all functions preloaded (repl)
  • Elliptic curve point addition (over finite fields), including named curves (secp256k1) with on-curve result validation
  • Elliptic curve scalar multiplication k·P (double-and-add), including the point at infinity as a first-class result
  • Chinese Remainder Theorem solver (handles non-coprime moduli)
  • Continued fraction expansion and convergents
  • Challenge/quiz mode — practice problems with scoring, or a worksheet mode for self-study
  • Symlink-friendly (foxmath-legendre, foxmath-jacobi, foxmath-solovay, foxmath-repl, foxmath-sqrtmod, foxmath-isprime, foxmath-factor, foxmath-totient, foxmath-order, foxmath-dlog, foxmath-mobius, foxmath-sigma, foxmath-tau, foxmath-egcd, foxmath-modinv, foxmath-pi, foxmath-ecadd, foxmath-ecmul, foxmath-crt, foxmath-cf, foxmath-challenge)
  • JSON output mode

Installation

pip install foxmath

Or from source:

git clone https://github.com/Abhrankan-Chakrabarti/foxmath.git
cd foxmath
pip install -e .

Check which version you have installed:

foxmath --version
foxmath 0.13.1

Usage Examples

foxmath factor 360
360 = 2^3 * 3^2 * 5
foxmath isprime 104729
104729 is prime
foxmath isprime 561
561 is composite
foxmath pi --terms 200
π ≈ 3.1415926535897932384626433832795028841971693993752  (200 terms)
foxmath legendre 5 17
Legendre (5/17) = -1
foxmath jacobi 10 13
Jacobi (10/13) = 1
foxmath solovay 104729
104729 is probably prime (Solovay-Strassen, 20 rounds)
foxmath sqrtmod 10 13
sqrt(10) = +/-7 (mod 13)

sqrtmod uses the Tonelli-Shanks algorithm to find modular square roots when they exist. It reports an error when the input is a quadratic non-residue modulo the given odd prime.

foxmath egcd 30 50
gcd(30, 50) = 10 = 30*(2) + 50*(-1)
foxmath modinv 3 11
3^-1 ≡ 4 (mod 11)
foxmath totient 360
phi(360) = 96
lambda(360) = 12
foxmath order 3 7
ord_7(3) = 6 (primitive root)
foxmath dlog 3 6 7
3^3 ≡ 6 (mod 7)
foxmath mobius 30
mu(30) = -1
foxmath sigma 12
sigma(12) = 28
foxmath tau 12
tau(12) = 6
# Interactive REPL (all functions preloaded)
foxmath repl
FoxMath 0.13.1 Interactive REPL 🦊
All math functions loaded. Type exit() or Ctrl-Z + Enter to quit.
>>> jacobi_symbol(10, 13)
1
>>> solovay_strassen(104729)
True
>>> dlog(2, 5, 13)
9
# Symlinks (optional)
foxmath-ecadd --x1 1 --y1 2 --x2 3 --y2 4 --p 17
Result point: (14, 2)
# Named curve (secp256k1) — computes 2G by default
foxmath ecadd --curve secp256k1
Result point: (89565891926547004231252920425935692360644145829622209833684329913297188986597, 12158399299693830322967808612713398636155367887041628176798871954788371653930)
  ✓ on curve
# Scalar multiplication — same curves, O(log k) double-and-add
foxmath ecmul --curve toy193 --k 7
Result point: (66, 24)
  ✓ on curve
# toy193: y² = x³ + x + 5 (mod 193), #E = 193 (prime) — small enough to
# hand-verify, structured exactly like secp256k1. G = (1, 59).
# k = 0 or a multiple of the group order lands on the identity:
foxmath ecmul --curve toy193 --k 193
Result: point at infinity (identity)
# Chinese Remainder Theorem
foxmath crt --r 2 3 2 --m 3 5 7
x ≡ 23 (mod 105)
# Continued fraction expansion + convergents
foxmath cf --num 355 --den 113
[3; 7, 16]
  3/1
  22/7
  355/113
# Challenge/quiz mode — worksheet (no prompting)
foxmath challenge --topic legendre --count 2 --seed 1 --reveal
1. Legendre symbol (10/13)
   Answer: 1
2. Legendre symbol (3/7)
   Answer: -1
# Baby-size discrete log: given G and Q = k·G, recover k.
# Easy at this scale — the same problem at secp256k1's ~10^77 is why ECDSA works.
foxmath challenge --topic ecdlp --count 1 --seed 9 --reveal
1. On y² = x³ + 1x + 5 (mod 193) with G = (1, 59): find k (2 ≤ k ≤ 20) such that k·G = (60, 171)
   Answer: 16

Drop --reveal to answer interactively instead, with scoring at the end. --topic accepts legendre, jacobi, crt, ecdlp, sqrtmod, factor, totient, dlog, or mixed (default).

# JSON output
foxmath pi --terms 100 --json
{
  "tool": "foxmath",
  "command": "pi",
  "terms": 100,
  "approx": "3.1415926535897932384626433832795028841971693993752"
}

Why FoxMath?

Because math and cryptography are more fun when you can play with them instantly in the terminal — with the same reliability as FoxPipe and fox-vault.

Simple. Practical. Reliable.

License

MIT © Abhrankan Chakrabarti


Star if you find it useful! Issues and PRs welcome.

Metadata

Release files for foxmath 0.13.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for foxmath 0.13.1
File Size Uploaded
foxmath-0.13.1.tar.gz 31.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for foxmath 0.13.1
File Interpreter ABI Platform
foxmath-0.13.1-py3-none-any.whl Python 3 none any Details

Total release size: 50.5 kB

Release files / foxmath-0.13.1.tar.gz

Download URL foxmath-0.13.1.tar.gz
Size 31.8 kB
Tags Source
SHA-256 checksum
How to use checksums
7fce5fa45e36296db847a1dbeaf931945f22d3f3bee6a34d60df0ec3b2fffbf9
BLAKE2b-256 checksum
How to use checksums
0ddff5f24f3dc3578033ca504c05f491bf80ce72ed374eb92a1cc664a58ea3d5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / foxmath-0.13.1-py3-none-any.whl

Download URL foxmath-0.13.1-py3-none-any.whl
Size 18.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a28a84380122343962159f94b2d71ad4a3628d3fc00bd90f2ce45920c230f82f
BLAKE2b-256 checksum
How to use checksums
34e4f4205c7618e14a17e202ab735a33d698aa6306da695a255b43285cbbea8a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release history Release notifications | RSS feed

0.14.0

2 release files

This release

0.13.1 This release

2 release files

0.13.0

2 release files

0.12.1

2 release files

0.12.0

2 release files

0.11.1

2 release files

0.11.0

2 release files

0.10.1

2 release files

0.10.0

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page