Updated files via upload

Author: Ezek-iel

GUI/Quadratic-Equation-Solver/README.md

@@ -1,10 +1,49 @@
-## Quadratic Equation Solver
-
-### Solve quadratic equations with this tool and see the quadratic equation in graphs
-> The modules used were ttkbootstrap, tkinter and matplotlib
-
-
-### Problems with the code
-- Closing the window does not close the program
-
-### Enjoy
+# Quadratic equation solver
+
+![image](img.png)
+
+## Requirements
+```powershell
+numpy : 1.24.2
+matplotlib : 3.6.3
+ttkbootstrap : 1.10.1
+tkinter: "inbuilt", 8.6
+```
+
+A simple quadratic equation solver with ttkbootstrap as GUI
+
+- A Quadratic class was created to ease GUI use
+
+## `Class Quadratic`
+A quadratic class recieves 3 arguments (a,b,c) according to 
+ax² + bx + c
+```python
+q1 = Quadratic(a = 2, b = 4, c = 5)
+```
+## Methods
+### The solve quad method solves a quadratic expression assuming the expression is equal to 0  
+ > returns a tuple of two numbers
+ ```python
+ q1 = Quadratic(a = 1, b = 8, c = 16)
+ print(q1.solveQuad())
+
+ # returns 4, 4
+ ```
+ > Where the determinant is less than zero, a complex number solution is returned `python3 supports complex numbers`
+
+### The evaluate method replaces the x in  ax² + bx + c with an integer or float and returns the calculated value
+ ```python
+ q1 = Quadratic(a = 1, b = 8, c = 16)
+ print(q1.evaluate(value = 2))
+
+ # returns 36
+ ```
+### The draw figure method draws a quadratic equation graph using numpy and matplotlib 
+ > `numpy and matplotlib required` see requirements section above
+ ```python
+ q1 = Quadratic(a = 1, b = 8, c = 16)
+ print(q1.drawFigure())
+
+ # returns 4, 4
+ ```
+ > A matplotlib figure is  returned and can be added to a matplotlib graph

GUI/Quadratic-Equation-Solver/img.png

@@ -6,7 +6,7 @@ class Quadratic:
     """Representing a quadratic expression in the form of ax² + bx + c"""
 
     def __init__(self,a : float, b : float, c : float) -> None:
-        # A class is created succesfully if the arguments of the class are either float or int
+        # A class is created succesfully if the arguments of the class are either of float type or int type
         if (type(a) == type(0.1) or type(a) == type(1)) and (type(b) == type(0.1) or type(b) == type(1)) and (type(c) == type(0.1) or type(c) == type(1)):
             self.a = a
             self.b = b
@@ -15,25 +15,28 @@ def __init__(self,a : float, b : float, c : float) -> None:
             raise ValueError("Argument must be of type int or float")
 
     def __repr__(self) -> str:
+        """ Printing a quadratic class """
         return "Quad( {0}x² + {1}x + {2} )".format(self.a,self.b,self.c)
 
     def solveQuad(self) -> tuple[float,float]:
-        """Solving the expression assuming it is equal to 0 returns a tuple of 2 values"""
-        determinant = ((self.b ** 2) - (4 * self.a * self.c)) ** 0.5
+        """Solving the expression assuming it is equal to 0. 
+        returns a tuple of 2 values"""
+
+        determinant = ((self.b ** 2) - (4 * self.a * self.c)) ** 0.5 # The determinant of a quadratic equation is the root of b² - 4ac
         firstSolution = ((-1 * self.b) + determinant) / (2 * self.a)
         secondSolution = ((-1 * self.b) - determinant) / (2 * self.a)
         return (firstSolution,secondSolution)
 
-    def evaluate(self, x):
-        """Substitute x for a value and return a string to be called by the eval function"""
-        solution = ((self.a * (x ** 2)) + (self.b * x) + self.c)
+    def evaluate(self, value):
+        """Evaluate the Quadratic expression. with x in ax² + bx + c as a numeric type"""
+        solution = ((self.a * (value ** 2)) + (self.b * value) + self.c)
         return solution
 
     def drawFigure(self):
-        """Draws the quadratic graph and returns a matplotlib figure"""
+        """Draws a quadratic graph of the quadratic expression and returns a matplotlib figure"""
         x_axis = np.linspace(-10,10,50)
         y_axis = self.evaluate(x_axis)
-
+        
         figure, axes = plt.subplots()
 
         axes.plot(x_axis,y_axis, linewidth = 1)

GUI/Quadratic-Equation-Solver/quad.py

@@ -8,7 +8,6 @@
 
 # Most variables are named a,b,c according to ax² + bx + c in a quadratic equation
 
-
 def plot():
 
     # Collect all inputs
@@ -52,7 +51,7 @@ def plot():
 # Font data
 font = ("Nunito", 12)
 
-# Frame containig the entry for the three arguments
+# Frame containing the entry for the three arguments
 top_frame = tb.Frame(root)
 top_frame.grid(row = 0, column = 0,padx  = 10, pady = 20)