added type hints and doctests to arithmetic_analysis/newton_method.py

arithmetic_analysis/newton_method.py

@@ -1,23 +1,50 @@
 """Newton's Method."""
 
 # Newton's Method - https://en.wikipedia.org/wiki/Newton%27s_method
-
-
-# function is the f(x) and function1 is the f'(x)
-def newton(function, function1, startingInt):
-    x_n = startingInt
+from typing import Callable
+
+RealFunc = Callable[[float], float]  # type alias for a real -> real function
+
+
+# function is the f(x) and derivative is the f'(x)
+def newton(function: RealFunc, derivative: RealFunc, starting_int: int,) -> float:
+    """
+    >>> newton(lambda x: x ** 3 - 2 * x - 5, lambda x: 3 * x ** 2 - 2, 3)
+    2.0945514815423474
+    >>> newton(lambda x: x ** 3 - 1, lambda x: 3 * x ** 2, -2)
+    1.0
+    >>> newton(lambda x: x ** 3 - 1, lambda x: 3 * x ** 2, -4)
+    1.0000000000000102
+    >>> import math
+    >>> newton(math.sin, math.cos, 1)
+    0.0
+    >>> newton(math.sin, math.cos, 2)
+    3.141592653589793
+    >>> newton(math.cos, lambda x: -math.sin(x), 2)
+    1.5707963267948966
+    >>> newton(math.cos, lambda x: -math.sin(x), 0)
+    Traceback (most recent call last):
+    ...
+    ZeroDivisionError: Could not find root
+    """
+    prev_guess: float = starting_int
     while True:
-        x_n1 = x_n - function(x_n) / function1(x_n)
-        if abs(x_n - x_n1) < 10 ** -5:
-            return x_n1
-        x_n = x_n1
-
-
-def f(x):
+        try:
+            next_guess: float = prev_guess - function(prev_guess) / derivative(
+                prev_guess
+            )
+            if abs(prev_guess - next_guess) < 10 ** -5:
+                return next_guess
+            prev_guess = next_guess
+        except ZeroDivisionError:
+            raise ZeroDivisionError("Could not find root")
+
+
+def f(x: float) -> float:
     return (x ** 3) - (2 * x) - 5
 
 
-def f1(x):
+def f1(x: float) -> float:
     return 3 * (x ** 2) - 2