aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Int.is_prime.3
blob: cbf01be138ef948d5fb9090defdcd1237fcab657 (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
37
38
39
40
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Int.is_prime 3 2025-04-21T14:54:02.044313 "Tomo man-pages"
.SH NAME
Int.is_prime \- check if an integer is prime
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.is_prime\ :\ func(x:\ Int,\ reps:\ Int\ =\ 50\ ->\ Bool)
.fi
.SH DESCRIPTION
Determines if an integer is a prime number.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
x	Int	The integer to be checked. 	-
reps	Int	The number of repetitions for primality tests. 	50
.TE
.SH RETURN
`yes` if `x` is a prime number, `no` otherwise.

.SH NOTES
This function is _probabilistic_. With the default arguments, 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
>> (7).is_prime()
= yes
>> (6).is_prime()
= no
.EE