Fix style of the first ten solutions for Project Euler (TheAlgorithms#3242)

* Fix style of the first ten solutions for Project Euler

- Unify the header docstring, and add reference URLs to wikipedia
  or similar
- Fix docstrings to be properly multilined
- Add newlines where appropriate
- Add doctests where they were missing
- Remove doctests that test for the correct solution
- fix obvious spelling or grammar mistakes in comments and
  exception messages
- Fix line endings to be UNIX. This makes two of the files seem
  to have changed completely
- no functional changes in any of the solutions were done
  (except for the spelling fixes mentioned above)

* Fix docstrings and main function as per Style Guide

Author: darkstar

project_euler/problem_001/sol1.py

@@ -1,13 +1,18 @@
 """
-Problem Statement:
+Project Euler Problem 1: https://projecteuler.net/problem=1
+
+Multiples of 3 and 5
+
 If we list all the natural numbers below 10 that are multiples of 3 or 5,
 we get 3, 5, 6 and 9. The sum of these multiples is 23.
-Find the sum of all the multiples of 3 or 5 below N.
+
+Find the sum of all the multiples of 3 or 5 below 1000.
 """
 
 
 def solution(n: int = 1000) -> int:
-    """Returns the sum of all the multiples of 3 or 5 below n.
+    """
+    Returns the sum of all the multiples of 3 or 5 below n.
 
     >>> solution(3)
     0
@@ -25,4 +30,4 @@ def solution(n: int = 1000) -> int:
 
 
 if __name__ == "__main__":
-    print(solution(int(input().strip())))
+    print(f"{solution() = }")

project_euler/problem_001/sol2.py

@@ -1,13 +1,18 @@
 """
-Problem Statement:
+Project Euler Problem 1: https://projecteuler.net/problem=1
+
+Multiples of 3 and 5
+
 If we list all the natural numbers below 10 that are multiples of 3 or 5,
 we get 3, 5, 6 and 9. The sum of these multiples is 23.
-Find the sum of all the multiples of 3 or 5 below N.
+
+Find the sum of all the multiples of 3 or 5 below 1000.
 """
 
 
 def solution(n: int = 1000) -> int:
-    """Returns the sum of all the multiples of 3 or 5 below n.
+    """
+    Returns the sum of all the multiples of 3 or 5 below n.
 
     >>> solution(3)
     0
@@ -30,4 +35,4 @@ def solution(n: int = 1000) -> int:
 
 
 if __name__ == "__main__":
-    print(solution(int(input().strip())))
+    print(f"{solution() = }")

project_euler/problem_001/sol3.py

@@ -1,8 +1,12 @@
 """
-Problem Statement:
+Project Euler Problem 1: https://projecteuler.net/problem=1
+
+Multiples of 3 and 5
+
 If we list all the natural numbers below 10 that are multiples of 3 or 5,
 we get 3, 5, 6 and 9. The sum of these multiples is 23.
-Find the sum of all the multiples of 3 or 5 below N.
+
+Find the sum of all the multiples of 3 or 5 below 1000.
 """
 
 
@@ -57,4 +61,4 @@ def solution(n: int = 1000) -> int:
 
 
 if __name__ == "__main__":
-    print(solution(int(input().strip())))
+    print(f"{solution() = }")

project_euler/problem_001/sol4.py

@@ -1,47 +1,52 @@
-"""
-Problem Statement:
-If we list all the natural numbers below 10 that are multiples of 3 or 5,
-we get 3, 5, 6 and 9. The sum of these multiples is 23.
-Find the sum of all the multiples of 3 or 5 below N.
-"""
-
-
-def solution(n: int = 1000) -> int:
-    """Returns the sum of all the multiples of 3 or 5 below n.
-
-    >>> solution(3)
-    0
-    >>> solution(4)
-    3
-    >>> solution(10)
-    23
-    >>> solution(600)
-    83700
-    """
-
-    xmulti = []
-    zmulti = []
-    z = 3
-    x = 5
-    temp = 1
-    while True:
-        result = z * temp
-        if result < n:
-            zmulti.append(result)
-            temp += 1
-        else:
-            temp = 1
-            break
-    while True:
-        result = x * temp
-        if result < n:
-            xmulti.append(result)
-            temp += 1
-        else:
-            break
-    collection = list(set(xmulti + zmulti))
-    return sum(collection)
-
-
-if __name__ == "__main__":
-    print(solution(int(input().strip())))
+"""
+Project Euler Problem 1: https://projecteuler.net/problem=1
+
+Multiples of 3 and 5
+
+If we list all the natural numbers below 10 that are multiples of 3 or 5,
+we get 3, 5, 6 and 9. The sum of these multiples is 23.
+
+Find the sum of all the multiples of 3 or 5 below 1000.
+"""
+
+
+def solution(n: int = 1000) -> int:
+    """
+    Returns the sum of all the multiples of 3 or 5 below n.
+
+    >>> solution(3)
+    0
+    >>> solution(4)
+    3
+    >>> solution(10)
+    23
+    >>> solution(600)
+    83700
+    """
+
+    xmulti = []
+    zmulti = []
+    z = 3
+    x = 5
+    temp = 1
+    while True:
+        result = z * temp
+        if result < n:
+            zmulti.append(result)
+            temp += 1
+        else:
+            temp = 1
+            break
+    while True:
+        result = x * temp
+        if result < n:
+            xmulti.append(result)
+            temp += 1
+        else:
+            break
+    collection = list(set(xmulti + zmulti))
+    return sum(collection)
+
+
+if __name__ == "__main__":
+    print(f"{solution() = }")

project_euler/problem_001/sol5.py

@@ -1,14 +1,19 @@
 """
-Problem Statement:
+Project Euler Problem 1: https://projecteuler.net/problem=1
+
+Multiples of 3 and 5
+
 If we list all the natural numbers below 10 that are multiples of 3 or 5,
 we get 3, 5, 6 and 9. The sum of these multiples is 23.
-Find the sum of all the multiples of 3 or 5 below N.
+
+Find the sum of all the multiples of 3 or 5 below 1000.
 """
 
 
 def solution(n: int = 1000) -> int:
-    """Returns the sum of all the multiples of 3 or 5 below n.
-       A straightforward pythonic solution using list comprehension.
+    """
+    Returns the sum of all the multiples of 3 or 5 below n.
+    A straightforward pythonic solution using list comprehension.
 
     >>> solution(3)
     0
@@ -24,4 +29,4 @@ def solution(n: int = 1000) -> int:
 
 
 if __name__ == "__main__":
-    print(solution(int(input().strip())))
+    print(f"{solution() = }")

project_euler/problem_001/sol6.py

@@ -1,13 +1,18 @@
 """
-Problem Statement:
+Project Euler Problem 1: https://projecteuler.net/problem=1
+
+Multiples of 3 and 5
+
 If we list all the natural numbers below 10 that are multiples of 3 or 5,
 we get 3, 5, 6 and 9. The sum of these multiples is 23.
-Find the sum of all the multiples of 3 or 5 below N.
+
+Find the sum of all the multiples of 3 or 5 below 1000.
 """
 
 
 def solution(n: int = 1000) -> int:
-    """Returns the sum of all the multiples of 3 or 5 below n.
+    """
+    Returns the sum of all the multiples of 3 or 5 below n.
 
     >>> solution(3)
     0
@@ -31,4 +36,4 @@ def solution(n: int = 1000) -> int:
 
 
 if __name__ == "__main__":
-    print(solution(int(input().strip())))
+    print(f"{solution() = }")

project_euler/problem_001/sol7.py

@@ -1,13 +1,18 @@
 """
-Problem Statement:
+Project Euler Problem 1: https://projecteuler.net/problem=1
+
+Multiples of 3 and 5
+
 If we list all the natural numbers below 10 that are multiples of 3 or 5,
 we get 3, 5, 6 and 9. The sum of these multiples is 23.
-Find the sum of all the multiples of 3 or 5 below N.
+
+Find the sum of all the multiples of 3 or 5 below 1000.
 """
 
 
 def solution(n: int = 1000) -> int:
-    """Returns the sum of all the multiples of 3 or 5 below n.
+    """
+    Returns the sum of all the multiples of 3 or 5 below n.
 
     >>> solution(3)
     0
@@ -29,4 +34,4 @@ def solution(n: int = 1000) -> int:
 
 
 if __name__ == "__main__":
-    print(solution(int(input().strip())))
+    print(f"{solution() = }")

project_euler/problem_002/sol1.py

@@ -1,19 +1,25 @@
 """
-Problem:
-Each new term in the Fibonacci sequence is generated by adding the previous two
-terms. By starting with 1 and 2, the first 10 terms will be:
+Project Euler Problem 2: https://projecteuler.net/problem=2
 
-    1,2,3,5,8,13,21,34,55,89,..
+Even Fibonacci Numbers
+
+Each new term in the Fibonacci sequence is generated by adding the previous
+two terms. By starting with 1 and 2, the first 10 terms will be:
+
+1, 2, 3, 5, 8, 13, 21, 34, 55, 89, ...
 
 By considering the terms in the Fibonacci sequence whose values do not exceed
-n, find the sum of the even-valued terms. e.g. for n=10, we have {2,8}, sum is
-10.
+four million, find the sum of the even-valued terms.
+
+References:
+    - https://en.wikipedia.org/wiki/Fibonacci_number
 """
 
 
 def solution(n: int = 4000000) -> int:
-    """Returns the sum of all fibonacci sequence even elements that are lower
-    or equals to n.
+    """
+    Returns the sum of all even fibonacci sequence elements that are lower
+    or equal to n.
 
     >>> solution(10)
     10
@@ -26,6 +32,7 @@ def solution(n: int = 4000000) -> int:
     >>> solution(34)
     44
     """
+
     i = 1
     j = 2
     total = 0
@@ -38,4 +45,4 @@ def solution(n: int = 4000000) -> int:
 
 
 if __name__ == "__main__":
-    print(solution(int(input().strip())))
+    print(f"{solution() = }")

project_euler/problem_002/sol2.py

@@ -1,39 +1,46 @@
-"""
-Problem:
-Each new term in the Fibonacci sequence is generated by adding the previous two
-terms. By starting with 1 and 2, the first 10 terms will be:
-
-    1,2,3,5,8,13,21,34,55,89,..
-
-By considering the terms in the Fibonacci sequence whose values do not exceed
-n, find the sum of the even-valued terms. e.g. for n=10, we have {2,8}, sum is
-10.
-"""
-
-
-def solution(n: int = 4000000) -> int:
-    """Returns the sum of all fibonacci sequence even elements that are lower
-    or equals to n.
-
-    >>> solution(10)
-    10
-    >>> solution(15)
-    10
-    >>> solution(2)
-    2
-    >>> solution(1)
-    0
-    >>> solution(34)
-    44
-    """
-    even_fibs = []
-    a, b = 0, 1
-    while b <= n:
-        if b % 2 == 0:
-            even_fibs.append(b)
-        a, b = b, a + b
-    return sum(even_fibs)
-
-
-if __name__ == "__main__":
-    print(solution(int(input().strip())))
+"""
+Project Euler Problem 2: https://projecteuler.net/problem=2
+
+Even Fibonacci Numbers
+
+Each new term in the Fibonacci sequence is generated by adding the previous
+two terms. By starting with 1 and 2, the first 10 terms will be:
+
+1, 2, 3, 5, 8, 13, 21, 34, 55, 89, ...
+
+By considering the terms in the Fibonacci sequence whose values do not exceed
+four million, find the sum of the even-valued terms.
+
+References:
+    - https://en.wikipedia.org/wiki/Fibonacci_number
+"""
+
+
+def solution(n: int = 4000000) -> int:
+    """
+    Returns the sum of all even fibonacci sequence elements that are lower
+    or equal to n.
+
+    >>> solution(10)
+    10
+    >>> solution(15)
+    10
+    >>> solution(2)
+    2
+    >>> solution(1)
+    0
+    >>> solution(34)
+    44
+    """
+
+    even_fibs = []
+    a, b = 0, 1
+    while b <= n:
+        if b % 2 == 0:
+            even_fibs.append(b)
+        a, b = b, a + b
+    return sum(even_fibs)
+
+
+if __name__ == "__main__":
+    print(f"{solution() = }")