algorithm: quadratic formula

DIRECTORY.md

@@ -193,6 +193,7 @@
  * [PowLogarithmic](Maths/PowLogarithmic.js)
  * [PrimeCheck](Maths/PrimeCheck.js)
  * [PrimeFactors](Maths/PrimeFactors.js)
+ * [QuadraticFormula](Maths/QuadraticFormula.js)
  * [RadianToDegree](Maths/RadianToDegree.js)
  * [ReverseNumber](Maths/ReverseNumber.js)
  * [ReversePolishNotation](Maths/ReversePolishNotation.js)

Maths/QuadraticFormula.js

@@ -0,0 +1,31 @@
+/**
+ * @function quadraticFormula
+ * @description This script will find the the roots of a quadratic equation.
+ * @param {number} a
+ * @param {number} b
+ * @param {number} c
+ * @return {string}
+ * @see https://en.wikipedia.org/wiki/Quadratic_formula
+ * @example quadraticFormula(1, -3, -4) = 'the roots are X1=4 and X2=-1'
+ * @example quadraticFormula(1, 5, 6) = 'the roots are X1=-2 and X2=-3'
+ * @example quadraticFormula(1, -3, 8) = 'the roots do not exist or the roots are imaginary'
+ */
+
+const quadraticFormula = (a, b, c) => {
+ if (typeof a !== 'number' || typeof b !== 'number' || typeof c !== 'number') {
+ return new TypeError('Some argument is not a number.')
+ }
+ const discriminant = (b ** 2) - (4 * a * c)
+ const denominator = 2 * a
+ let answer = ''
+ if (discriminant >= 0) {
+ const x1 = (-b + Math.sqrt(discriminant)) / denominator
+ const x2 = (-b - Math.sqrt(discriminant)) / denominator
+ answer = `the roots are X1=${x1} and X2=${x2}`
+ } else {
+ answer = 'the roots do not exist or the roots are imaginary'
+ }
+ return answer
+}
+
+export { quadraticFormula }

Maths/test/QuadraticFormula.test.js

@@ -0,0 +1,21 @@
+import { quadraticFormula } from '../QuadraticFormula'
+
+test('Testing on quadraticFormula', () => {
+ const quadraticForm = quadraticFormula(1, -3, -4)
+ expect(quadraticForm).toBe('the roots are X1=4 and X2=-1')
+})
+
+test('Testing on quadraticFormula', () => {
+ const quadraticForm = quadraticFormula(1, 5, 6)
+ expect(quadraticForm).toBe('the roots are X1=-2 and X2=-3')
+})
+
+test('Testing on quadraticFormula', () => {
+ const quadraticForm = quadraticFormula(1, -3, 8)
+ expect(quadraticForm).toBe('the roots do not exist or the roots are imaginary')
+})
+
+test('Testing on quadraticFormula', () => {
+ const quadraticForm = quadraticFormula(1, -2, 9)
+ expect(quadraticForm).toBe('the roots do not exist or the roots are imaginary')
+})