data-structure-typed 2.0.0 → 2.0.2

package/test/unit/data-structures/stack/stack.test.ts

@@ -162,3 +162,168 @@ describe('Stack iterative methods', () => {
     }).toThrow('toElementFn must be a function type');
   });
 });
+
+describe('classic uses', () => {
+  it('@example Balanced Parentheses or Brackets', () => {
+    type ValidCharacters = ')' | '(' | ']' | '[' | '}' | '{';
+
+    const stack = new Stack<string>();
+    const input: ValidCharacters[] = '[({})]'.split('') as ValidCharacters[];
+    const matches: { [key in ValidCharacters]?: ValidCharacters } = { ')': '(', ']': '[', '}': '{' };
+    for (const char of input) {
+      if ('([{'.includes(char)) {
+        stack.push(char);
+      } else if (')]}'.includes(char)) {
+        if (stack.pop() !== matches[char]) {
+          fail('Parentheses are not balanced');
+        }
+      }
+    }
+    expect(stack.isEmpty()).toBe(true);
+  });
+
+  it('@example Expression Evaluation and Conversion', () => {
+    const stack = new Stack<number>();
+    const expression = [5, 3, '+']; // Equivalent to 5 + 3
+    expression.forEach(token => {
+      if (typeof token === 'number') {
+        stack.push(token);
+      } else {
+        const b = stack.pop()!;
+        const a = stack.pop()!;
+        stack.push(token === '+' ? a + b : 0); // Only handling '+' here
+      }
+    });
+    expect(stack.pop()).toBe(8);
+  });
+
+  it('@example Depth-First Search (DFS)', () => {
+    const stack = new Stack<number>();
+    const graph: { [key in number]: number[] } = { 1: [2, 3], 2: [4], 3: [5], 4: [], 5: [] };
+    const visited: number[] = [];
+    stack.push(1);
+    while (!stack.isEmpty()) {
+      const node = stack.pop()!;
+      if (!visited.includes(node)) {
+        visited.push(node);
+        graph[node].forEach(neighbor => stack.push(neighbor));
+      }
+    }
+    expect(visited).toEqual([1, 3, 5, 2, 4]); // Example DFS order
+  });
+
+  it('@example Backtracking Algorithms', () => {
+    const stack = new Stack<[number, number]>();
+    const maze = [
+      ['S', ' ', 'X'],
+      ['X', ' ', 'X'],
+      [' ', ' ', 'E']
+    ];
+    const start: [number, number] = [0, 0];
+    const end = [2, 2];
+    const directions = [
+      [0, 1], // To the right
+      [1, 0], // down
+      [0, -1], // left
+      [-1, 0] // up
+    ];
+
+    const visited = new Set<string>(); // Used to record visited nodes
+    stack.push(start);
+    const path: number[][] = [];
+
+    while (!stack.isEmpty()) {
+      const [x, y] = stack.pop()!;
+      if (visited.has(`${x},${y}`)) continue; // Skip already visited nodes
+      visited.add(`${x},${y}`);
+
+      path.push([x, y]);
+
+      if (x === end[0] && y === end[1]) {
+        break; // Find the end point and exit
+      }
+
+      for (const [dx, dy] of directions) {
+        const nx = x + dx;
+        const ny = y + dy;
+        if (
+          maze[nx]?.[ny] === ' ' || // feasible path
+          maze[nx]?.[ny] === 'E' // destination
+        ) {
+          stack.push([nx, ny]);
+        }
+      }
+    }
+
+    expect(path).toContainEqual(end);
+  });
+
+  it('@example Function Call Stack', () => {
+    const functionStack = new Stack<string>();
+    functionStack.push('main');
+    functionStack.push('foo');
+    functionStack.push('bar');
+    expect(functionStack.pop()).toBe('bar');
+    expect(functionStack.pop()).toBe('foo');
+    expect(functionStack.pop()).toBe('main');
+  });
+
+  it('@example Simplify File Paths', () => {
+    const stack = new Stack<string>();
+    const path = '/a/./b/../../c';
+    path.split('/').forEach(segment => {
+      if (segment === '..') stack.pop();
+      else if (segment && segment !== '.') stack.push(segment);
+    });
+    expect(stack.elements.join('/')).toBe('c');
+  });
+
+  it('@example Stock Span Problem', () => {
+    const stack = new Stack<number>();
+    const prices = [100, 80, 60, 70, 60, 75, 85];
+    const spans: number[] = [];
+    prices.forEach((price, i) => {
+      while (!stack.isEmpty() && prices[stack.peek()!] <= price) {
+        stack.pop();
+      }
+      spans.push(stack.isEmpty() ? i + 1 : i - stack.peek()!);
+      stack.push(i);
+    });
+    expect(spans).toEqual([1, 1, 1, 2, 1, 4, 6]);
+  });
+
+  it('Browser Navigation', () => {
+    const backStack = new Stack<string>();
+    const forwardStack = new Stack<string>();
+    backStack.push('Page 1');
+    backStack.push('Page 2');
+    forwardStack.push(backStack.pop()!);
+    expect(backStack.size).toBe(1);
+    expect(forwardStack.size).toBe(1);
+  });
+
+  it('String Reversal', () => {
+    const stack = new Stack<string>();
+    const input = 'hello';
+    const reversed = [];
+    input.split('').forEach(char => stack.push(char));
+    while (!stack.isEmpty()) {
+      reversed.push(stack.pop());
+    }
+    expect(reversed.join('')).toBe('olleh');
+  });
+
+  it('Next Greater Element', () => {
+    const stack = new Stack<number>();
+    const array = [4, 5, 2, 25];
+    const nextGreater = new Array(array.length).fill(-1);
+    array.forEach((_, i) => {
+      while (!stack.isEmpty() && array[stack.peek()!] < array[i]) {
+        const idx = stack.pop()!;
+        nextGreater[idx] = array[i];
+      }
+      stack.push(i);
+    });
+    expect(nextGreater).toEqual([5, 25, 25, -1]);
+  });
+});

package/test/unit/utils/utils.test.ts

@@ -1,11 +1,11 @@
+import { isComparable, trampoline } from '../../../src';
+
 describe('isNaN', () => {
   it('should isNaN', function () {
     expect(isNaN('string' as unknown as number)).toBe(true);
   });
 });
 
-import { isComparable } from '../../../src';
-
 describe('isComparable', () => {
   describe('primitive types', () => {
     it('numbers should be comparable', () => {
@@ -172,3 +172,36 @@ describe('isComparable', () => {
     });
   });
 });
+
+describe('Factorial Performance Tests', () => {
+  const depth = 5000;
+  let arr: number[];
+
+  const recurseTrampoline = (n: number, arr: number[], acc = 1): (() => any) | number => {
+    if (n === 0) return acc;
+    arr.unshift(1);
+    return () => recurseTrampoline(n - 1, arr, acc);
+  };
+
+  const recurse = (n: number, arr: number[], acc = 1): number => {
+    if (n === 0) return acc;
+    arr.unshift(1);
+    return recurse(n - 1, arr, acc);
+  };
+
+  beforeEach(() => {
+    arr = new Array(depth).fill(0);
+  });
+
+  it('should calculate recursive function using trampoline without stack overflow', () => {
+    const result = trampoline(() => recurseTrampoline(depth, arr));
+    expect(result).toBe(1);
+    expect(arr.length).toBe(depth + depth);
+  });
+
+  it('should calculate recursive directly and possibly stack overflow', () => {
+    const result = recurse(depth, arr);
+    expect(result).toBe(1);
+    expect(arr.length).toBe(depth + depth);
+  });
+});