Skip to content

Commit

Permalink
Try to clarify big range function example
Browse files Browse the repository at this point in the history
  • Loading branch information
JSorngard committed Sep 5, 2024
1 parent 67f723e commit de4abf4
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ assert!(CHECK);
## Example: generate the three primes after 5000000031

The crate also provides prime generation and sieving functions that can be used
to work with ranges that don't start at zero, e.g. `primes_geq` and `sieve_lt`.
These functions can use large sieves to compute large primes, but don't need to
return the entire sieve, just the requested numbers.
to work with ranges of large numbers that don't start at zero, e.g.
`primes_geq` and `sieve_lt`. These functions can use large sieves to compute
large primes, but don't need to return the entire sieve, just the requested numbers.
They are most conveniently used through the macros `primes_segment!` and
`sieve_segment!` that automatically compute the size of the sieve that's needed
for a certain computation.
Expand Down
9 changes: 6 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,12 @@
//!
//! # Example: generate the three primes after 5000000031
//!
//! The crate also provides prime generation and sieving functions that can be used to work with ranges that don't start at zero, e.g. [`primes_geq`] and [`sieve_lt`].
//! These functions can use large sieves to compute large primes, but don't need to return the entire sieve, just the requested numbers.
//! They are most conveniently used through the macros [`primes_segment!`] and [`sieve_segment!`] that automatically compute the size of the sieve that's needed for a certain computation.
//! The crate also provides prime generation and sieving functions that can be used to work
//! with ranges of large numbers that don't start at zero, e.g. `primes_geq` and `sieve_lt`.
//! These functions can use large sieves to compute large primes,
//! but don't need to return the entire sieve, just the requested numbers.
//! They are most conveniently used through the macros `primes_segment!` and `sieve_segment!`
//! that automatically compute the size of the sieve that's needed for a certain computation.
//!
//! Compute 3 primes greater than or equal to 5000000031:
//!
Expand Down

0 comments on commit de4abf4

Please sign in to comment.