prime_number_utils/lib.rs
1//! # prime-number-utils
2//! 'prime-number-utils' is a collection of utilities to generate prime numbers and to determine
3//! whether a number is prime efficiently.
4//!
5//! # Examples
6//! ```
7//! use prime_number_utils::{GenPrime, SieveOfEratosthenes, baillie_psw};
8//! # fn main() {
9//! let mut sieve_of_eratosthenes = SieveOfEratosthenes::new();
10//!
11//! let mut primes = sieve_of_eratosthenes.gen_range(0..20);
12//!
13//! assert_eq!(&primes, &vec![2, 3, 5, 7, 11, 13, 17, 19]);
14//!
15//! assert!(primes.iter().all(|&n| baillie_psw(n)));
16//! # }
17//! ```
18mod baillie_psw;
19#[cfg(feature = "num-bigint")]
20pub mod bigint;
21mod bitwise_sieve;
22mod gen_prime;
23mod linear_sieve;
24mod segmented_sieve;
25mod sieve_of_atkin;
26mod sieve_of_eratosthenes;
27mod sieve_of_sundaram;
28mod test;
29
30pub use crate::{
31 baillie_psw::*, bigint::*, bitwise_sieve::*, gen_prime::GenPrime, linear_sieve::*,
32 segmented_sieve::*, sieve_of_atkin::*, sieve_of_eratosthenes::*, sieve_of_sundaram::*,
33};