algorithm: find min (#61)

Co-authored-by: patrickwestervelt <pwestervelt3@gatech.edu>

Author: Psytew

Maths/FindMin.ts

@@ -0,0 +1,25 @@
+/**
+ * @function FindMin
+ * @description Find the minimum in an array of numbers.
+ * @param {Number[]} nums - An array of numbers.
+ * @return {Number} - The minimum.
+ * @see https://infinitbility.com/how-to-find-minimum-value-in-array-in-typescript/
+ * @example FindMin([1,2,3,4,5]) = 1
+ * @example FindMin([87,6,13,999]) = 6
+ * @example FindMin([0.8,0.2,0.3,0.5]) = 0.2
+ * @example FindMin([1,0.1,-1]) = -1
+ */
+ export const FindMin = (nums: number[]): number => {
+    if (nums.length === 0) {
+      throw new Error("array must have length of 1 or greater");
+    }
+  
+    let minimumSeen: number = nums[0];
+    for (const num of nums) {
+      if (num < minimumSeen) {
+        minimumSeen = num;
+      }
+    }
+  
+    return minimumSeen;
+  };

Maths/test/FindMin.test.ts

@@ -0,0 +1,16 @@
+import { FindMin } from "../FindMin";
+
+describe("FindMin", () => {
+  test.each([[[1,2,3,4,5,6], 1], [[87,6,13,999], 6], [[0.8,0.2,0.3,0.5], 0.2], [[1,0.1,-1], -1]])(
+    "of this array should be %i",
+    (nums, expected) => {
+      expect(FindMin(nums)).toBe(expected);
+    },
+  );
+
+  test("of arrays with length 0 should error", () => {
+    expect(() => FindMin([])).toThrowError(
+      "array must have length of 1 or greater",
+    );
+  });
+});