aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Int.next_prime.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/man3/tomo-Int.next_prime.3')
-rw-r--r--man/man3/tomo-Int.next_prime.337
1 files changed, 37 insertions, 0 deletions
diff --git a/man/man3/tomo-Int.next_prime.3 b/man/man3/tomo-Int.next_prime.3
new file mode 100644
index 00000000..7890d0bc
--- /dev/null
+++ b/man/man3/tomo-Int.next_prime.3
@@ -0,0 +1,37 @@
+'\" t
+.\" Copyright (c) 2025 Bruce Hill
+.\" All rights reserved.
+.\"
+.TH Int.next_prime 3 2025-04-19T14:30:40.360625 "Tomo man-pages"
+.SH NAME
+Int.next_prime \- Finds the next prime number greater than the given integer.
+
+.SH LIBRARY
+Tomo Standard Library
+.SH SYNOPSIS
+.nf
+.BI "Int.next_prime : func(x: Int -> Int)"
+.fi
+
+.SH DESCRIPTION
+Finds the next prime number greater than the given integer.
+
+
+.TS
+allbox;
+lb lb lbx lb
+l l l l.
+Name Type Description Default
+x Int The integer after which to find the next prime. -
+.TE
+.SH RETURN
+The next prime number greater than `x`.
+
+.SH NOTES
+This function is _probabilistic_, but the chances of getting an incorrect answer are astronomically small (on the order of 10^(-30)). See [the GNU MP docs](https://gmplib.org/manual/Number-Theoretic-Functions#index-mpz_005fprobab_005fprime_005fp) for more details.
+
+.SH EXAMPLES
+.EX
+>> (11).next_prime()
+= 13
+.EE