aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Int.prev_prime.3
blob: 3391de4e0de8f99544ce2344a0df39d526fe392f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Int.prev_prime 3 2025-09-21 "Tomo man-pages"
.SH NAME
Int.prev_prime \- get the previous prime
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.prev_prime\ :\ func(x:\ Int\ ->\ Int?)
.fi
.SH DESCRIPTION
Finds the previous prime number less than the given integer. If there is no previous prime number (i.e. if a number less than `2` is provided), then the function will create a runtime error.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
x	Int	The integer before which to find the previous prime. 	-
.TE
.SH RETURN
The previous prime number less than `x`, or `none` if `x` is less than 2.

.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
assert (11).prev_prime() == 7
.EE