@inglorious/engine 0.1.1 → 0.2.0

package/src/utils/data-structures/heap.js

@@ -1,164 +1,164 @@
-// @see https://stackfull.dev/heaps-in-javascript
-
-/**
- * Default comparator for a max-heap.
- * @param {*} a - First element.
- * @param {*} b - Second element.
- * @returns {number} Positive if `a` should come before `b`, negative otherwise.
- */
-const DEFAULT_COMPARATOR = (a, b) => b - a
-
-// Constants for heap operations
-const ROOT_INDEX = 0 // Index of the root element in the heap.
-const SINGLE_ELEMENT = 1 // Heap size when it contains a single element.
-const LEFT_CHILD_MULTIPLIER = 2 // Multiplier to calculate the left child index.
-const RIGHT_CHILD_MULTIPLIER = 2 // Multiplier to calculate the right child index.
-const PARENT_DIVISOR = 2 // Divisor to calculate the parent index.
-const LEFT_CHILD_OFFSET = 1 // Offset to calculate the left child index.
-const RIGHT_CHILD_OFFSET = 2 // Offset to calculate the right child index.
-const LAST_ELEMENT_OFFSET = 1 // Offset to get the last element in the heap.
-const INDEX_ADJUSTMENT = 1 // Adjustment for zero-based indexing.
-const COMPARATOR_THRESHOLD = 0 // Threshold for comparator results.
-
-/**
- * Checks if a heap contains a specific item.
- * @param {Array} heap - The heap array.
- * @param {*} item - The item to check for.
- * @returns {boolean} True if the item exists in the heap, false otherwise.
- */
-export function contains(heap, item) {
-  return heap.includes(item)
-}
-
-/**
- * Converts an array into a heap.
- * @param {Array} arr - The input array.
- * @param {Function} [comparator=DEFAULT_COMPARATOR] - Comparator function to define heap order.
- * @returns {Array} The heapified array.
- */
-export function heapify(arr, comparator = DEFAULT_COMPARATOR) {
-  let heap = []
-  for (const item of arr) {
-    heap = push(heap, item, comparator)
-  }
-  return heap
-}
-
-/**
- * Adds an item to the heap and maintains the heap property.
- * @param {Array} heap - The heap array.
- * @param {*} item - The item to add.
- * @param {Function} [comparator=DEFAULT_COMPARATOR] - Comparator function to define heap order.
- * @returns {Array} The updated heap array.
- */
-export function push(heap, item, comparator = DEFAULT_COMPARATOR) {
-  const h = [...heap, item]
-
-  if (h.length === SINGLE_ELEMENT) {
-    return h
-  }
-
-  let index = h.length - LAST_ELEMENT_OFFSET
-  let parentIndex = parent(index)
-
-  while (
-    index > ROOT_INDEX &&
-    comparator(h[index], h[parentIndex]) > COMPARATOR_THRESHOLD
-  ) {
-    ;[h[index], h[parentIndex]] = [h[parentIndex], h[index]]
-
-    index = parentIndex
-    parentIndex = parent(index)
-  }
-
-  return h
-}
-
-/**
- * Calculates the index of the left child of a given node.
- * @param {number} index - The index of the parent node.
- * @returns {number} The index of the left child.
- */
-export function left(index) {
-  return LEFT_CHILD_MULTIPLIER * index + LEFT_CHILD_OFFSET
-}
-
-/**
- * Calculates the index of the parent of a given node.
- * @param {number} index - The index of the child node.
- * @returns {number} The index of the parent node.
- */
-export function parent(index) {
-  return Math.floor((index - INDEX_ADJUSTMENT) / PARENT_DIVISOR)
-}
-
-/**
- * Removes and returns the root element of the heap.
- * @param {Array} heap - The heap array.
- * @param {Function} [comparator=DEFAULT_COMPARATOR] - Comparator function to define heap order.
- * @returns {Array} The updated heap array after removing the root.
- */
-export function pop(heap, comparator = DEFAULT_COMPARATOR) {
-  const h = [...heap]
-  ;[h[ROOT_INDEX], h[h.length - LAST_ELEMENT_OFFSET]] = [
-    h[h.length - LAST_ELEMENT_OFFSET],
-    h[ROOT_INDEX],
-  ]
-
-  h.pop()
-
-  let index = ROOT_INDEX
-  let leftIndex = left(index)
-  let rightIndex = right(index)
-  let newMinFound = false
-
-  while (leftIndex < h.length && !newMinFound) {
-    const minIndex =
-      rightIndex < h.length &&
-      comparator(h[rightIndex], h[leftIndex]) > COMPARATOR_THRESHOLD
-        ? rightIndex
-        : leftIndex
-    newMinFound = comparator(h[minIndex], h[index]) > COMPARATOR_THRESHOLD
-
-    if (newMinFound) {
-      ;[h[minIndex], h[index]] = [h[index], h[minIndex]]
-
-      index = minIndex
-      leftIndex = left(index)
-      rightIndex = right(index)
-    }
-  }
-
-  return h
-}
-
-/**
- * Removes the root element and reorders the heap.
- * @param {Array} heap - The heap array.
- * @returns {Array} The updated heap array.
- */
-export function remove(heap) {
-  const [, ...rest] = heap
-  return heapify([
-    ...rest.slice(-LAST_ELEMENT_OFFSET),
-    ...rest.slice(ROOT_INDEX, -LAST_ELEMENT_OFFSET),
-  ])
-}
-
-/**
- * Calculates the index of the right child of a given node.
- * @param {number} index - The index of the parent node.
- * @returns {number} The index of the right child.
- */
-export function right(index) {
-  return RIGHT_CHILD_MULTIPLIER * index + RIGHT_CHILD_OFFSET
-}
-
-/**
- * Retrieves the root element of the heap.
- * @param {Array} heap - The heap array.
- * @returns {*} The root element of the heap.
- */
-export function root(heap) {
-  return heap[ROOT_INDEX]
-}
+// @see https://stackfull.dev/heaps-in-javascript
+
+/**
+ * Default comparator for a max-heap.
+ * @param {*} a - First element.
+ * @param {*} b - Second element.
+ * @returns {number} Positive if `a` should come before `b`, negative otherwise.
+ */
+const DEFAULT_COMPARATOR = (a, b) => b - a
+
+// Constants for heap operations
+const ROOT_INDEX = 0 // Index of the root element in the heap.
+const SINGLE_ELEMENT = 1 // Heap size when it contains a single element.
+const LEFT_CHILD_MULTIPLIER = 2 // Multiplier to calculate the left child index.
+const RIGHT_CHILD_MULTIPLIER = 2 // Multiplier to calculate the right child index.
+const PARENT_DIVISOR = 2 // Divisor to calculate the parent index.
+const LEFT_CHILD_OFFSET = 1 // Offset to calculate the left child index.
+const RIGHT_CHILD_OFFSET = 2 // Offset to calculate the right child index.
+const LAST_ELEMENT_OFFSET = 1 // Offset to get the last element in the heap.
+const INDEX_ADJUSTMENT = 1 // Adjustment for zero-based indexing.
+const COMPARATOR_THRESHOLD = 0 // Threshold for comparator results.
+
+/**
+ * Checks if a heap contains a specific item.
+ * @param {Array} heap - The heap array.
+ * @param {*} item - The item to check for.
+ * @returns {boolean} True if the item exists in the heap, false otherwise.
+ */
+export function contains(heap, item) {
+  return heap.includes(item)
+}
+
+/**
+ * Converts an array into a heap.
+ * @param {Array} arr - The input array.
+ * @param {Function} [comparator=DEFAULT_COMPARATOR] - Comparator function to define heap order.
+ * @returns {Array} The heapified array.
+ */
+export function heapify(arr, comparator = DEFAULT_COMPARATOR) {
+  let heap = []
+  for (const item of arr) {
+    heap = push(heap, item, comparator)
+  }
+  return heap
+}
+
+/**
+ * Adds an item to the heap and maintains the heap property.
+ * @param {Array} heap - The heap array.
+ * @param {*} item - The item to add.
+ * @param {Function} [comparator=DEFAULT_COMPARATOR] - Comparator function to define heap order.
+ * @returns {Array} The updated heap array.
+ */
+export function push(heap, item, comparator = DEFAULT_COMPARATOR) {
+  const h = [...heap, item]
+
+  if (h.length === SINGLE_ELEMENT) {
+    return h
+  }
+
+  let index = h.length - LAST_ELEMENT_OFFSET
+  let parentIndex = parent(index)
+
+  while (
+    index > ROOT_INDEX &&
+    comparator(h[index], h[parentIndex]) > COMPARATOR_THRESHOLD
+  ) {
+    ;[h[index], h[parentIndex]] = [h[parentIndex], h[index]]
+
+    index = parentIndex
+    parentIndex = parent(index)
+  }
+
+  return h
+}
+
+/**
+ * Calculates the index of the left child of a given node.
+ * @param {number} index - The index of the parent node.
+ * @returns {number} The index of the left child.
+ */
+export function left(index) {
+  return LEFT_CHILD_MULTIPLIER * index + LEFT_CHILD_OFFSET
+}
+
+/**
+ * Calculates the index of the parent of a given node.
+ * @param {number} index - The index of the child node.
+ * @returns {number} The index of the parent node.
+ */
+export function parent(index) {
+  return Math.floor((index - INDEX_ADJUSTMENT) / PARENT_DIVISOR)
+}
+
+/**
+ * Removes and returns the root element of the heap.
+ * @param {Array} heap - The heap array.
+ * @param {Function} [comparator=DEFAULT_COMPARATOR] - Comparator function to define heap order.
+ * @returns {Array} The updated heap array after removing the root.
+ */
+export function pop(heap, comparator = DEFAULT_COMPARATOR) {
+  const h = [...heap]
+  ;[h[ROOT_INDEX], h[h.length - LAST_ELEMENT_OFFSET]] = [
+    h[h.length - LAST_ELEMENT_OFFSET],
+    h[ROOT_INDEX],
+  ]
+
+  h.pop()
+
+  let index = ROOT_INDEX
+  let leftIndex = left(index)
+  let rightIndex = right(index)
+  let newMinFound = false
+
+  while (leftIndex < h.length && !newMinFound) {
+    const minIndex =
+      rightIndex < h.length &&
+      comparator(h[rightIndex], h[leftIndex]) > COMPARATOR_THRESHOLD
+        ? rightIndex
+        : leftIndex
+    newMinFound = comparator(h[minIndex], h[index]) > COMPARATOR_THRESHOLD
+
+    if (newMinFound) {
+      ;[h[minIndex], h[index]] = [h[index], h[minIndex]]
+
+      index = minIndex
+      leftIndex = left(index)
+      rightIndex = right(index)
+    }
+  }
+
+  return h
+}
+
+/**
+ * Removes the root element and reorders the heap.
+ * @param {Array} heap - The heap array.
+ * @returns {Array} The updated heap array.
+ */
+export function remove(heap) {
+  const [, ...rest] = heap
+  return heapify([
+    ...rest.slice(-LAST_ELEMENT_OFFSET),
+    ...rest.slice(ROOT_INDEX, -LAST_ELEMENT_OFFSET),
+  ])
+}
+
+/**
+ * Calculates the index of the right child of a given node.
+ * @param {number} index - The index of the parent node.
+ * @returns {number} The index of the right child.
+ */
+export function right(index) {
+  return RIGHT_CHILD_MULTIPLIER * index + RIGHT_CHILD_OFFSET
+}
+
+/**
+ * Retrieves the root element of the heap.
+ * @param {Array} heap - The heap array.
+ * @returns {*} The root element of the heap.
+ */
+export function root(heap) {
+  return heap[ROOT_INDEX]
+}

package/src/utils/data-structures/heap.test.js

@@ -1,103 +1,103 @@
-import { expect, test } from "vitest"
-
-import { contains, heapify, pop, push, remove, root } from "./heap.js"
-
-test("it should check if a heap contains a value", () => {
-  const heap = [3, 2, 6, 1, 7, 4, 5]
-  const item = 1
-  const expectedResult = true
-
-  expect(contains(heap, item)).toBe(expectedResult)
-})
-
-test("it should check if a heap contains an object", () => {
-  const heap = [
-    { value: 3 },
-    { value: 2 },
-    { value: 6 },
-    { value: 1 },
-    { value: 7 },
-    { value: 4 },
-    { value: 5 },
-  ]
-  const item = heap[3]
-  const expectedResult = true
-
-  expect(contains(heap, item)).toBe(expectedResult)
-})
-
-test("it should not convert an array in existing heap form into a heap", () => {
-  const arr = [1, 2, 3, 4, 5, 6, 7]
-  const expectedResult = [1, 2, 3, 4, 5, 6, 7]
-
-  expect(heapify(arr)).toStrictEqual(expectedResult)
-})
-
-test("it should convert an array into a heap", () => {
-  const arr = [7, 6, 5, 4, 3, 2, 1]
-  const expectedResult = [1, 4, 2, 7, 5, 6, 3]
-
-  expect(heapify(arr)).toStrictEqual(expectedResult)
-})
-
-test("it should convert an array into a maxheap", () => {
-  const arr = [1, 2, 3, 4, 5, 6, 7]
-  const comparator = (a, b) => a - b
-  const expectedResult = [7, 4, 6, 1, 3, 2, 5]
-
-  expect(heapify(arr, comparator)).toStrictEqual(expectedResult)
-})
-
-test("it should find the minimum value in a min heap", () => {
-  const heap = [1, 4, 2, 7, 5, 6, 3]
-  const expectedResult = 1
-
-  expect(root(heap)).toBe(expectedResult)
-})
-
-test("it should push the first element of the heap", () => {
-  const heap = []
-  const value = 7
-  const expectedResult = [7]
-
-  expect(push(heap, value)).toStrictEqual(expectedResult)
-})
-
-test("it should push the biggest value at the end of the heap", () => {
-  const heap = [3, 13, 19, 33, 42, 23, 21]
-  const value = 50
-  const expectedResult = [3, 13, 19, 33, 42, 23, 21, 50]
-
-  expect(push(heap, value)).toStrictEqual(expectedResult)
-})
-
-test("it should push a value in the right spot of a heap", () => {
-  const heap = [3, 13, 19, 33, 42, 23, 21]
-  const value = 7
-  const expectedResult = [3, 7, 19, 13, 42, 23, 21, 33]
-
-  expect(push(heap, value)).toStrictEqual(expectedResult)
-})
-
-test("it should pop the lowest value from the end of the heap", () => {
-  const heap = [3, 13, 19, 33, 42, 23, 21]
-  const expectedResult = [13, 21, 19, 33, 42, 23]
-
-  expect(pop(heap)).toStrictEqual(expectedResult)
-})
-
-test("it should push the biggest value at the beginning of a maxheap", () => {
-  const heap = [3, 13, 19, 33, 42, 23, 21]
-  const comparator = (a, b) => a - b
-  const value = 50
-  const expectedResult = [50, 3, 19, 13, 42, 23, 21, 33]
-
-  expect(push(heap, value, comparator)).toStrictEqual(expectedResult)
-})
-
-test("it should remove the heap's root element", () => {
-  const heap = [3, 13, 19, 33, 42, 23, 21]
-  const expectedResult = [13, 21, 19, 33, 42, 23]
-
-  expect(remove(heap)).toStrictEqual(expectedResult)
-})
+import { expect, test } from "vitest"
+
+import { contains, heapify, pop, push, remove, root } from "./heap.js"
+
+test("it should check if a heap contains a value", () => {
+  const heap = [3, 2, 6, 1, 7, 4, 5]
+  const item = 1
+  const expectedResult = true
+
+  expect(contains(heap, item)).toBe(expectedResult)
+})
+
+test("it should check if a heap contains an object", () => {
+  const heap = [
+    { value: 3 },
+    { value: 2 },
+    { value: 6 },
+    { value: 1 },
+    { value: 7 },
+    { value: 4 },
+    { value: 5 },
+  ]
+  const item = heap[3]
+  const expectedResult = true
+
+  expect(contains(heap, item)).toBe(expectedResult)
+})
+
+test("it should not convert an array in existing heap form into a heap", () => {
+  const arr = [1, 2, 3, 4, 5, 6, 7]
+  const expectedResult = [1, 2, 3, 4, 5, 6, 7]
+
+  expect(heapify(arr)).toStrictEqual(expectedResult)
+})
+
+test("it should convert an array into a heap", () => {
+  const arr = [7, 6, 5, 4, 3, 2, 1]
+  const expectedResult = [1, 4, 2, 7, 5, 6, 3]
+
+  expect(heapify(arr)).toStrictEqual(expectedResult)
+})
+
+test("it should convert an array into a maxheap", () => {
+  const arr = [1, 2, 3, 4, 5, 6, 7]
+  const comparator = (a, b) => a - b
+  const expectedResult = [7, 4, 6, 1, 3, 2, 5]
+
+  expect(heapify(arr, comparator)).toStrictEqual(expectedResult)
+})
+
+test("it should find the minimum value in a min heap", () => {
+  const heap = [1, 4, 2, 7, 5, 6, 3]
+  const expectedResult = 1
+
+  expect(root(heap)).toBe(expectedResult)
+})
+
+test("it should push the first element of the heap", () => {
+  const heap = []
+  const value = 7
+  const expectedResult = [7]
+
+  expect(push(heap, value)).toStrictEqual(expectedResult)
+})
+
+test("it should push the biggest value at the end of the heap", () => {
+  const heap = [3, 13, 19, 33, 42, 23, 21]
+  const value = 50
+  const expectedResult = [3, 13, 19, 33, 42, 23, 21, 50]
+
+  expect(push(heap, value)).toStrictEqual(expectedResult)
+})
+
+test("it should push a value in the right spot of a heap", () => {
+  const heap = [3, 13, 19, 33, 42, 23, 21]
+  const value = 7
+  const expectedResult = [3, 7, 19, 13, 42, 23, 21, 33]
+
+  expect(push(heap, value)).toStrictEqual(expectedResult)
+})
+
+test("it should pop the lowest value from the end of the heap", () => {
+  const heap = [3, 13, 19, 33, 42, 23, 21]
+  const expectedResult = [13, 21, 19, 33, 42, 23]
+
+  expect(pop(heap)).toStrictEqual(expectedResult)
+})
+
+test("it should push the biggest value at the beginning of a maxheap", () => {
+  const heap = [3, 13, 19, 33, 42, 23, 21]
+  const comparator = (a, b) => a - b
+  const value = 50
+  const expectedResult = [50, 3, 19, 13, 42, 23, 21, 33]
+
+  expect(push(heap, value, comparator)).toStrictEqual(expectedResult)
+})
+
+test("it should remove the heap's root element", () => {
+  const heap = [3, 13, 19, 33, 42, 23, 21]
+  const expectedResult = [13, 21, 19, 33, 42, 23]
+
+  expect(remove(heap)).toStrictEqual(expectedResult)
+})