Merge pull request #358 from Ezek-iel/eze-kiel

Added Quadratic-Equation-Solver to main repo

Author: larymak

GUI/Quadratic-Equation-Solver/README.md

@@ -0,0 +1,49 @@
+# 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

@@ -0,0 +1,47 @@
+import matplotlib.pyplot as plt
+import numpy as np
+
+
+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 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
+            self.c = c
+        else:
+            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 # 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, 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 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)
+        axes.grid(visible = True)
+        axes.set_title(self)
+        axes.xaxis.set_minor_formatter(str(x_axis))
+        return figure
+

GUI/Quadratic-Equation-Solver/quad.py

@@ -0,0 +1,95 @@
+import ttkbootstrap as tb
+from ttkbootstrap.constants import *
+from tkinter import *
+from ttkbootstrap.scrolled import ScrolledFrame
+from quad import Quadratic
+from matplotlib.backends.backend_tkagg import FigureCanvasTkAgg, NavigationToolbar2Tk
+from ttkbootstrap.dialogs import Messagebox
+
+# Most variables are named a,b,c according to ax² + bx + c in a quadratic equation
+
+def plot():
+
+    # Collect all inputs
+    a_entryInput  = a_entry.get()
+    b_entryInput = b_entry.get()
+    c_entryInput = c_entry.get()
+    
+    try:
+        a = float(a_entryInput)
+        b = float(b_entryInput)
+        c = float(c_entryInput)
+        eqn = Quadratic(a,b,c)
+
+        #--------------------------------------------------------------------------
+        # Background Graph Frame
+        graph_frame = ScrolledFrame(root, width = 800, height = 500)
+        graph_frame.grid(row = 1, column  = 0,pady = 10)
+
+        fig = eqn.drawFigure()
+
+        canvas = FigureCanvasTkAgg(figure = fig, master = graph_frame)
+        canvas.draw()
+        canvas.get_tk_widget().pack()
+
+        toolbar = NavigationToolbar2Tk(canvas, graph_frame)
+        toolbar.update()
+
+        canvas.get_tk_widget().pack()
+        solution_label.config(text = "Solution : x₁ = {0}, x₂ = {1}".format(eqn.solveQuad()[0], eqn.solveQuad()[1]))
+        
+    except:
+        Messagebox.show_error(title = "Error", message = "User entered wrong value")
+ 
+
+
+# Base window widget
+root = tb.Window(themename="vapor")
+root.geometry("720x720")
+root.title("Quadratic Equation Solver")
+
+# Font data
+font = ("Nunito", 12)
+
+# Frame containing the entry for the three arguments
+top_frame = tb.Frame(root)
+top_frame.grid(row = 0, column = 0,padx  = 10, pady = 20)
+
+# Entry for the three arguments
+a_frame = tb.Frame(top_frame)
+a_frame.grid(row = 0, column = 0, padx=5)
+
+a_label = tb.Label(a_frame, text= "a =", font = font)
+a_label.grid(row = 0, column = 0)
+
+a_entry = tb.Entry(a_frame, width = 30, font = font)
+a_entry.grid(row = 0, column = 1)
+
+b_frame = tb.Frame(top_frame)
+b_frame.grid(row = 0, column = 1, padx=5)
+
+b_label = tb.Label(b_frame, text = "b =", font = font)
+b_label.grid(row = 0, column = 0)
+
+b_entry = tb.Entry(b_frame, width = 30, font = font)
+b_entry.grid(row = 0, column = 1)
+
+c_frame = tb.Frame(top_frame)
+c_frame.grid(row = 0, column = 2, padx=5)
+
+c_label = tb.Label(c_frame, text = "c =", font = font)
+c_label.grid(row = 0, column = 0)
+
+c_entry = tb.Entry(c_frame, width = 30, font = font)
+c_entry.grid(row = 0, column = 1)
+
+
+# Button to plot the matplotlib graph
+plot_button = tb.Button(top_frame, width = 70, text = "Plot", command = plot)
+plot_button.grid(row = 1, column = 1, pady = 15)
+
+# Label containing the solution to the equation
+solution_label = tb.Label(root,font = (font[0], 15), text = "")
+solution_label.grid(row = 2, column = 0, pady = 10)
+
+root.mainloop()

GUI/Quadratic-Equation-Solver/ui.py

@@ -121,3 +121,4 @@ guide [HERE](https://github.com/larymak/Python-project-Scripts/blob/main/CONTRIB
 | 72    | [Star pattern](https://github.com/larymak/Python-project-Scripts/tree/main/OTHERS/Star%20pattern)                                                                | [LpCodes](https://github.com/LpCodes)     |
 | 73    | [Logging Helper](https://github.com/larymak/Python-project-Scripts/tree/main/OTHERS/add-multiprocessing-logger)                                                                | [Jerry W.](https://github.com/Jerry0420)     |
 | 74    | [Notepad](https://github.com/larymak/Python-project-Scripts/tree/main/PYTHON%20APPS/Notepad)                                                                | [Annarhysa Albert](https://github.com/Annarhysa)     |
+| 75   | [Quadratic Equation Solver](https://github.com/larymak/Python-project-Scripts/tree/main/GUI/Quadratic-Equation-Solver)                                                                | [Akinfenwa Ezekiel](https://github.com/Ezek-iel)     |