mirror of
https://github.com/TheAlgorithms/Python.git
synced 2025-01-19 00:37:02 +00:00
Merge maths/fibonacci.py and maths/fibonacci_sequence_recursion.py (#5738)
* Rewrite parts of Vector and Matrix methods * Refactor determinant method and add unit tests Refactor determinant method to create separate minor and cofactor methods. Add respective unit tests for new methods. Rename methods using snake case to follow Python naming conventions. * Reorganize Vector and Matrix methods * Update linear_algebra/README.md Co-authored-by: John Law <johnlaw.po@gmail.com> * Fix punctuation and wording * Apply suggestions from code review Co-authored-by: John Law <johnlaw.po@gmail.com> * Deduplicate euclidean length method for Vector * Add more unit tests for Euclidean length method * Fix bug in unit test for euclidean_length * Remove old comments for magnitude method * Rewrite maths/fibonacci.py * Rewrite timer and add unit tests * Fix typos in fib_binet unit tests * Fix typos in fib_binet unit tests * Clean main method * Merge fibonacci.py and fibonacci_sequence_recursion.py * Fix fib_binet unit test Co-authored-by: John Law <johnlaw.po@gmail.com>
This commit is contained in:
parent
99cf2cc1c5
commit
06ab650e08
|
@ -1,130 +1,130 @@
|
||||||
# fibonacci.py
|
# fibonacci.py
|
||||||
"""
|
"""
|
||||||
1. Calculates the iterative fibonacci sequence
|
Calculates the Fibonacci sequence using iteration, recursion, and a simplified
|
||||||
|
form of Binet's formula
|
||||||
|
|
||||||
2. Calculates the fibonacci sequence with a formula
|
NOTE 1: the iterative and recursive functions are more accurate than the Binet's
|
||||||
an = [ Phin - (phi)n ]/Sqrt[5]
|
formula function because the iterative function doesn't use floats
|
||||||
reference-->Su, Francis E., et al. "Fibonacci Number Formula." Math Fun Facts.
|
|
||||||
<http://www.math.hmc.edu/funfacts>
|
NOTE 2: the Binet's formula function is much more limited in the size of inputs
|
||||||
|
that it can handle due to the size limitations of Python floats
|
||||||
"""
|
"""
|
||||||
import functools
|
|
||||||
import math
|
|
||||||
import time
|
|
||||||
from decimal import Decimal, getcontext
|
|
||||||
|
|
||||||
getcontext().prec = 100
|
from math import sqrt
|
||||||
|
from time import time
|
||||||
|
|
||||||
|
|
||||||
def timer_decorator(func):
|
def time_func(func, *args, **kwargs):
|
||||||
@functools.wraps(func)
|
"""
|
||||||
def timer_wrapper(*args, **kwargs):
|
Times the execution of a function with parameters
|
||||||
start = time.time()
|
"""
|
||||||
func(*args, **kwargs)
|
start = time()
|
||||||
end = time.time()
|
output = func(*args, **kwargs)
|
||||||
|
end = time()
|
||||||
if int(end - start) > 0:
|
if int(end - start) > 0:
|
||||||
print(f"Run time for {func.__name__}: {(end - start):0.2f}s")
|
print(f"{func.__name__} runtime: {(end - start):0.4f} s")
|
||||||
else:
|
else:
|
||||||
print(f"Run time for {func.__name__}: {(end - start)*1000:0.2f}ms")
|
print(f"{func.__name__} runtime: {(end - start) * 1000:0.4f} ms")
|
||||||
return func(*args, **kwargs)
|
return output
|
||||||
|
|
||||||
return timer_wrapper
|
|
||||||
|
|
||||||
|
|
||||||
# define Python user-defined exceptions
|
def fib_iterative(n: int) -> list[int]:
|
||||||
class Error(Exception):
|
|
||||||
"""Base class for other exceptions"""
|
|
||||||
|
|
||||||
|
|
||||||
class ValueTooLargeError(Error):
|
|
||||||
"""Raised when the input value is too large"""
|
|
||||||
|
|
||||||
|
|
||||||
class ValueTooSmallError(Error):
|
|
||||||
"""Raised when the input value is not greater than one"""
|
|
||||||
|
|
||||||
|
|
||||||
class ValueLessThanZero(Error):
|
|
||||||
"""Raised when the input value is less than zero"""
|
|
||||||
|
|
||||||
|
|
||||||
def _check_number_input(n, min_thresh, max_thresh=None):
|
|
||||||
"""
|
"""
|
||||||
:param n: single integer
|
Calculates the first n (0-indexed) Fibonacci numbers using iteration
|
||||||
:type n: int
|
>>> fib_iterative(0)
|
||||||
:param min_thresh: min threshold, single integer
|
[0]
|
||||||
:type min_thresh: int
|
>>> fib_iterative(1)
|
||||||
:param max_thresh: max threshold, single integer
|
[0, 1]
|
||||||
:type max_thresh: int
|
>>> fib_iterative(5)
|
||||||
:return: boolean
|
[0, 1, 1, 2, 3, 5]
|
||||||
|
>>> fib_iterative(10)
|
||||||
|
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55]
|
||||||
|
>>> fib_iterative(-1)
|
||||||
|
Traceback (most recent call last):
|
||||||
|
...
|
||||||
|
Exception: n is negative
|
||||||
"""
|
"""
|
||||||
try:
|
if n < 0:
|
||||||
if n >= min_thresh and max_thresh is None:
|
raise Exception("n is negative")
|
||||||
return True
|
if n == 0:
|
||||||
elif min_thresh <= n <= max_thresh:
|
return [0]
|
||||||
return True
|
fib = [0, 1]
|
||||||
elif n < 0:
|
for _ in range(n - 1):
|
||||||
raise ValueLessThanZero
|
fib.append(fib[-1] + fib[-2])
|
||||||
elif n < min_thresh:
|
return fib
|
||||||
raise ValueTooSmallError
|
|
||||||
elif n > max_thresh:
|
|
||||||
raise ValueTooLargeError
|
|
||||||
except ValueLessThanZero:
|
|
||||||
print("Incorrect Input: number must not be less than 0")
|
|
||||||
except ValueTooSmallError:
|
|
||||||
print(
|
|
||||||
f"Incorrect Input: input number must be > {min_thresh} for the recursive "
|
|
||||||
"calculation"
|
|
||||||
)
|
|
||||||
except ValueTooLargeError:
|
|
||||||
print(
|
|
||||||
f"Incorrect Input: input number must be < {max_thresh} for the recursive "
|
|
||||||
"calculation"
|
|
||||||
)
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
@timer_decorator
|
def fib_recursive(n: int) -> list[int]:
|
||||||
def fib_iterative(n):
|
|
||||||
"""
|
"""
|
||||||
:param n: calculate Fibonacci to the nth integer
|
Calculates the first n (0-indexed) Fibonacci numbers using recursion
|
||||||
:type n:int
|
>>> fib_iterative(0)
|
||||||
:return: Fibonacci sequence as a list
|
[0]
|
||||||
|
>>> fib_iterative(1)
|
||||||
|
[0, 1]
|
||||||
|
>>> fib_iterative(5)
|
||||||
|
[0, 1, 1, 2, 3, 5]
|
||||||
|
>>> fib_iterative(10)
|
||||||
|
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55]
|
||||||
|
>>> fib_iterative(-1)
|
||||||
|
Traceback (most recent call last):
|
||||||
|
...
|
||||||
|
Exception: n is negative
|
||||||
"""
|
"""
|
||||||
n = int(n)
|
|
||||||
if _check_number_input(n, 2):
|
def fib_recursive_term(i: int) -> int:
|
||||||
seq_out = [0, 1]
|
"""
|
||||||
a, b = 0, 1
|
Calculates the i-th (0-indexed) Fibonacci number using recursion
|
||||||
for _ in range(n - len(seq_out)):
|
"""
|
||||||
a, b = b, a + b
|
if i < 0:
|
||||||
seq_out.append(b)
|
raise Exception("n is negative")
|
||||||
return seq_out
|
if i < 2:
|
||||||
|
return i
|
||||||
|
return fib_recursive_term(i - 1) + fib_recursive_term(i - 2)
|
||||||
|
|
||||||
|
if n < 0:
|
||||||
|
raise Exception("n is negative")
|
||||||
|
return [fib_recursive_term(i) for i in range(n + 1)]
|
||||||
|
|
||||||
|
|
||||||
@timer_decorator
|
def fib_binet(n: int) -> list[int]:
|
||||||
def fib_formula(n):
|
|
||||||
"""
|
"""
|
||||||
:param n: calculate Fibonacci to the nth integer
|
Calculates the first n (0-indexed) Fibonacci numbers using a simplified form
|
||||||
:type n:int
|
of Binet's formula:
|
||||||
:return: Fibonacci sequence as a list
|
https://en.m.wikipedia.org/wiki/Fibonacci_number#Computation_by_rounding
|
||||||
|
|
||||||
|
NOTE 1: this function diverges from fib_iterative at around n = 71, likely
|
||||||
|
due to compounding floating-point arithmetic errors
|
||||||
|
|
||||||
|
NOTE 2: this function overflows on n >= 1475 because of the size limitations
|
||||||
|
of Python floats
|
||||||
|
>>> fib_binet(0)
|
||||||
|
[0]
|
||||||
|
>>> fib_binet(1)
|
||||||
|
[0, 1]
|
||||||
|
>>> fib_binet(5)
|
||||||
|
[0, 1, 1, 2, 3, 5]
|
||||||
|
>>> fib_binet(10)
|
||||||
|
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55]
|
||||||
|
>>> fib_binet(-1)
|
||||||
|
Traceback (most recent call last):
|
||||||
|
...
|
||||||
|
Exception: n is negative
|
||||||
|
>>> fib_binet(1475)
|
||||||
|
Traceback (most recent call last):
|
||||||
|
...
|
||||||
|
Exception: n is too large
|
||||||
"""
|
"""
|
||||||
seq_out = [0, 1]
|
if n < 0:
|
||||||
n = int(n)
|
raise Exception("n is negative")
|
||||||
if _check_number_input(n, 2, 1000000):
|
if n >= 1475:
|
||||||
sqrt = Decimal(math.sqrt(5))
|
raise Exception("n is too large")
|
||||||
phi_1 = Decimal(1 + sqrt) / Decimal(2)
|
sqrt_5 = sqrt(5)
|
||||||
phi_2 = Decimal(1 - sqrt) / Decimal(2)
|
phi = (1 + sqrt_5) / 2
|
||||||
for i in range(2, n):
|
return [round(phi ** i / sqrt_5) for i in range(n + 1)]
|
||||||
temp_out = ((phi_1 ** Decimal(i)) - (phi_2 ** Decimal(i))) * (
|
|
||||||
Decimal(sqrt) ** Decimal(-1)
|
|
||||||
)
|
|
||||||
seq_out.append(int(temp_out))
|
|
||||||
return seq_out
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
num = 20
|
num = 20
|
||||||
# print(f'{fib_recursive(num)}\n')
|
time_func(fib_iterative, num)
|
||||||
# print(f'{fib_iterative(num)}\n')
|
time_func(fib_recursive, num)
|
||||||
# print(f'{fib_formula(num)}\n')
|
time_func(fib_binet, num)
|
||||||
fib_iterative(num)
|
|
||||||
fib_formula(num)
|
|
||||||
|
|
|
@ -1,22 +0,0 @@
|
||||||
# Fibonacci Sequence Using Recursion
|
|
||||||
|
|
||||||
|
|
||||||
def recur_fibo(n: int) -> int:
|
|
||||||
"""
|
|
||||||
>>> [recur_fibo(i) for i in range(12)]
|
|
||||||
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]
|
|
||||||
"""
|
|
||||||
return n if n <= 1 else recur_fibo(n - 1) + recur_fibo(n - 2)
|
|
||||||
|
|
||||||
|
|
||||||
def main() -> None:
|
|
||||||
limit = int(input("How many terms to include in fibonacci series: "))
|
|
||||||
if limit > 0:
|
|
||||||
print(f"The first {limit} terms of the fibonacci series are as follows:")
|
|
||||||
print([recur_fibo(n) for n in range(limit)])
|
|
||||||
else:
|
|
||||||
print("Please enter a positive integer: ")
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
Loading…
Reference in New Issue
Block a user