Begin moving helper functions into library

LivInTheLookingGlass · Jul 26, 2024 · 7de2b8b · 7de2b8b
1 parent 90fe5bf
commit 7de2b8b
Show file tree

Hide file tree

Showing 57 changed files with 412 additions and 193 deletions.
diff --git a/c/test_euler.py b/c/test_euler.py
@@ -227,7 +227,7 @@ def test_compiler_macros(compiler):
 
 @mark.skipif('NO_OPTIONAL_TESTS or ONLY_SLOW')
 def test_is_prime(benchmark, compiler):
-    from p0007 import is_prime, prime_factors, primes
+    from lib.primes import is_prime, prime_factors, primes
     MAX_PRIME = 1_000_000
     exename = EXE_TEMPLATE.format("test_is_prime", compiler)
     test_path = C_FOLDER.joinpath("tests", "test_is_prime.c")

diff --git a/cplusplus/test_euler.py b/cplusplus/test_euler.py
@@ -213,7 +213,7 @@ def test_compiler_macros(compiler):
 
 # @mark.skipif('NO_OPTIONAL_TESTS or ONLY_SLOW')
 # def test_is_prime(benchmark, compiler):
-#     from p0007 import is_prime, prime_factors, primes
+#     from lib.primes import is_prime, prime_factors, primes
 #     MAX_PRIME = 1_000_000
 #     exename = EXE_TEMPLATE.format("test_is_prime", compiler)
 #     test_path = CPP_FOLDER.joinpath("tests", "test_is_prime.cpp")

diff --git a/docs/python.rst b/docs/python.rst
@@ -5,6 +5,16 @@ Euler Python Implementation
    :start-line: 2
    :end-before: Problems Solved
 
+Library Code
+------------
+
+.. toctree::
+   :glob:
+   :numbered:
+   :maxdepth: 1
+
+   python/primes
+
 Problems Solved
 ---------------
 

diff --git a/docs/python/fibonacci.rst b/docs/python/fibonacci.rst
@@ -0,0 +1,13 @@
+fibonacci.py
+============
+
+View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/lib/fibonacci.py>`_
+
+.. automodule:: python.lib.fibonacci
+   :members:
+   :undoc-members:
+
+.. literalinclude:: ../../python/lib/fibonacci.py
+   :language: python
+   :linenos:
+
diff --git a/docs/python/p0003.rst b/docs/python/p0003.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 3
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0003.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0003
    :members:
    :undoc-members:

diff --git a/docs/python/p0007.rst b/docs/python/p0007.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 7
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0007.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0007
    :members:
    :undoc-members:

diff --git a/docs/python/p0010.rst b/docs/python/p0010.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 10
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0010.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0010
    :members:
    :undoc-members:

diff --git a/docs/python/p0021.rst b/docs/python/p0021.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 21
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0021.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0021
    :members:
    :undoc-members:

diff --git a/docs/python/p0027.rst b/docs/python/p0027.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 27
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0027.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0027
    :members:
    :undoc-members:

diff --git a/docs/python/p0035.rst b/docs/python/p0035.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 35
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0035.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0035
    :members:
    :undoc-members:

diff --git a/docs/python/p0037.rst b/docs/python/p0037.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 37
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0037.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0037
    :members:
    :undoc-members:

diff --git a/docs/python/p0041.rst b/docs/python/p0041.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 41
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0041.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0041
    :members:
    :undoc-members:

diff --git a/docs/python/p0046.rst b/docs/python/p0046.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 46
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0046.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0046
    :members:
    :undoc-members:

diff --git a/docs/python/p0047.rst b/docs/python/p0047.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 47
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0047.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0047
    :members:
    :undoc-members:

diff --git a/docs/python/p0049.rst b/docs/python/p0049.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 49
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0049.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0049
    :members:
    :undoc-members:

diff --git a/docs/python/p0050.rst b/docs/python/p0050.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 50
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0050.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0050
    :members:
    :undoc-members:

diff --git a/docs/python/p0058.rst b/docs/python/p0058.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 58
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0058.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0058
    :members:
    :undoc-members:

diff --git a/docs/python/p0060.rst b/docs/python/p0060.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 60
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0060.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0060
    :members:
    :undoc-members:

diff --git a/docs/python/p0069.rst b/docs/python/p0069.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 69
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0069.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0069
    :members:
    :undoc-members:

diff --git a/docs/python/p0077.rst b/docs/python/p0077.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 77
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0077.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0077
    :members:
    :undoc-members:

diff --git a/docs/python/p0087.rst b/docs/python/p0087.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 87
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0087.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0087
    :members:
    :undoc-members:

diff --git a/docs/python/p0118.rst b/docs/python/p0118.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 118
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0118.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0118
    :members:
    :undoc-members:

diff --git a/docs/python/p0123.rst b/docs/python/p0123.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 123
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0123.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0123
    :members:
    :undoc-members:

diff --git a/docs/python/p0134.rst b/docs/python/p0134.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 134
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0134.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0134
    :members:
    :undoc-members:

diff --git a/docs/python/p0187.rst b/docs/python/p0187.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 187
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0187.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0187
    :members:
    :undoc-members:

diff --git a/docs/python/p0357.rst b/docs/python/p0357.rst
@@ -3,6 +3,14 @@ Python Implementation of Problem 357
 
 View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/p0357.py>`_
 
+Includes
+--------
+
+- `primes <./primes.html>`_
+
+Problem Solution
+----------------
+
 .. automodule:: python.p0357
    :members:
    :undoc-members:

diff --git a/docs/python/primes.rst b/docs/python/primes.rst
@@ -0,0 +1,13 @@
+primes.py
+=========
+
+View source code `here on GitHub! <https://github.com/LivInTheLookingGlass/Euler/blob/master/python/lib/primes.py>`_
+
+.. automodule:: python.lib.primes
+   :members:
+   :undoc-members:
+
+.. literalinclude:: ../../python/lib/primes.py
+   :language: python
+   :linenos:
+