Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
kimwalisch committed Feb 11, 2024
1 parent d0fcc8c commit cc657b4
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 30 deletions.
12 changes: 6 additions & 6 deletions include/primesieve/PrimeGenerator.hpp
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
///
/// @file PrimeGenerator.hpp
/// Generates the primes inside [start, stop] and stores them
/// in a vector. After the primes have been stored in the
/// vector primesieve::iterator iterates over the vector and
/// returns the primes. When there are no more primes left in
/// the vector PrimeGenerator generates new primes.
/// @file PrimeGenerator.hpp
/// @brief Generates the primes inside [start, stop] and stores them
/// in a vector. After the primes have been stored in the
/// vector primesieve::iterator iterates over the vector and
/// returns the primes. When there are no more primes left in
/// the vector PrimeGenerator generates new primes.
///
/// Copyright (C) 2023 Kim Walisch, <[email protected]>
///
Expand Down
4 changes: 2 additions & 2 deletions include/primesieve/intrinsics.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
///
/// @file intrinsics.hpp
/// @brief Wrappers for compiler intrinsics.
/// @file intrinsics.hpp
/// @brief Wrappers for compiler intrinsics.
///
/// Copyright (C) 2022 Kim Walisch, <[email protected]>
///
Expand Down
20 changes: 10 additions & 10 deletions src/MemoryPool.cpp
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
///
/// @file MemoryPool.cpp
/// EratMedium and EratBig may use millions of buckets for
/// storing the sieving primes that are required to cross off
/// multiples. As many memory allocations/deallocations are
/// bad for performance the MemoryPool initially allocates a
/// large number of buckets (using a single memory allocation)
/// and puts the buckets into its stock. The MemoryPool can
/// then serve buckets to EratMedium and EratBig without
/// doing any memory allocation as long as the MemoryPool's
/// stock is not empty.
/// @file MemoryPool.cpp
/// @brief EratMedium and EratBig may use millions of buckets for
/// storing the sieving primes that are required to cross off
/// multiples. As many memory allocations/deallocations are
/// bad for performance the MemoryPool initially allocates a
/// large number of buckets (using a single memory allocation)
/// and puts the buckets into its stock. The MemoryPool can
/// then serve buckets to EratMedium and EratBig without
/// doing any memory allocation as long as the MemoryPool's
/// stock is not empty.
///
/// Copyright (C) 2023 Kim Walisch, <[email protected]>
///
Expand Down
24 changes: 12 additions & 12 deletions src/RiemannR.cpp
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
///
/// @file RiemannR.cpp
/// This file contains an implementation of the Riemann R
/// function which is a very accurate approximation of PrimePi(x).
/// The accuracy of this implementation depends on width of the
/// long double type. If the long double type has 80 bits (e.g.
/// Linux) then RiemannR(x) is accurate up to 10^19, if the long
/// double type has 64 bits (e.g. MSVC & macOS) then RiemannR(x)
/// is accurate up to 10^15. This implementation could be made
/// more accurate using the non standard __float128 type, but for
/// primesieve's purpose speed is more important than accuracy.
/// @file RiemannR.cpp
/// @brief This file contains an implementation of the Riemann R
/// function which is a very accurate approximation of PrimePi(x).
/// The accuracy of this implementation depends on width of the
/// long double type. If the long double type has 80 bits (e.g.
/// Linux) then RiemannR(x) is accurate up to 10^19, if the long
/// double type has 64 bits (e.g. MSVC & macOS) then RiemannR(x)
/// is accurate up to 10^15. This implementation could be made
/// more accurate using the non standard __float128 type, but for
/// primesieve's purpose speed is more important than accuracy.
///
/// More details about this Riemann R function implementation:
/// https://github.com/kimwalisch/primesieve/pull/144
/// More details about this Riemann R function implementation:
/// https://github.com/kimwalisch/primesieve/pull/144
///
/// Copyright (C) 2024 Kim Walisch, <[email protected]>
/// Copyright (C) 2024 @nipzu, https://github.com/nipzu
Expand Down

0 comments on commit cc657b4

Please sign in to comment.