data-structure-typed 1.54.3 → 2.0.1

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

@@ -11,21 +11,21 @@ describe('Queue', () => {
   });
 
   it('new Queue() should create an empty queue', () => {
-    expect(queue.size).toBe(0);
+    expect(queue.length).toBe(0);
     expect(queue.isEmpty()).toBeTruthy();
   });
 
   it('push should add elements to the queue', () => {
     queue.push(1);
     queue.push(2);
-    expect(queue.size).toBe(2);
+    expect(queue.length).toBe(2);
   });
 
   it('shift should remove the first element', () => {
     queue.push(1);
     queue.push(2);
     expect(queue.shift()).toBe(1);
-    expect(queue.size).toBe(1);
+    expect(queue.length).toBe(1);
   });
 
   it('shift should return undefined if queue is empty', () => {
@@ -36,17 +36,17 @@ describe('Queue', () => {
     queue.push(1);
     queue.push(2);
     expect(queue.first).toBe(1);
-    expect(queue.size).toBe(2);
+    expect(queue.length).toBe(2);
   });
 
   it('first should return undefined if queue is empty', () => {
     expect(queue.first).toBeUndefined();
   });
 
-  it('size should return the number of elements', () => {
+  it('length should return the number of elements', () => {
     queue.push(1);
     queue.push(2);
-    expect(queue.size).toBe(2);
+    expect(queue.length).toBe(2);
   });
 
   it('isEmpty should return true if the queue is empty', () => {
@@ -68,7 +68,7 @@ describe('Queue', () => {
     queue.push(1);
     queue.push(2);
     queue.clear();
-    expect(queue.size).toBe(0);
+    expect(queue.length).toBe(0);
   });
 
   it('forEach should iterate over all elements', () => {
@@ -90,6 +90,16 @@ describe('Queue', () => {
     expect(queue.isEmpty()).toBeTruthy();
   });
 
+  it('push with maxLen', () => {
+    const queue = new Queue<number>([], { maxLen: 10 });
+    for (let i = 0; i < 1000; i++) {
+      queue.push(i);
+    }
+    expect(queue.maxLen).toBe(10);
+    expect(queue.length).toBe(10);
+    expect(queue.first).toBe(990);
+  });
+
   it('compact method should work well', () => {
     for (let i = 0; i < 1000; i++) queue.push(i);
 
@@ -119,9 +129,9 @@ describe('Queue', () => {
       toElementFn: rawElement => rawElement.id
     });
 
-    expect(queue.size).toBe(5);
+    expect(queue.length).toBe(5);
     queue.shift();
-    expect(queue.size).toBe(4);
+    expect(queue.length).toBe(4);
     expect(queue.at(1)).toBe('3');
   });
 
@@ -193,11 +203,11 @@ describe('Queue', () => {
     queue.push(9);
     queue.push(10);
     expect(queue.elements.length).toBe(10);
-    while (queue.size > 7) queue.shift();
-    expect(queue.size).toBe(7);
+    while (queue.length > 7) queue.shift();
+    expect(queue.length).toBe(7);
     expect(queue.elements.length).toBe(10);
     queue.shift();
-    expect(queue.size).toBe(6);
+    expect(queue.length).toBe(6);
     expect(queue.elements.length).toBe(6);
   });
 });
@@ -260,7 +270,7 @@ describe('Queue - Additional Methods', () => {
     queue.push(1);
     queue.push(2);
     expect(queue.last).toBe(2);
-    expect(queue.size).toBe(2);
+    expect(queue.length).toBe(2);
   });
 
   it('peekLast should return undefined if queue is empty', () => {
@@ -288,12 +298,101 @@ describe('Queue - Additional Methods', () => {
   });
 });
 
+describe('Queue Additional Methods', () => {
+  // Slice method implementation and test
+  test('slice should return a new list with specified range', () => {
+    const list = new Queue([1, 2, 3, 4, 5]);
+    const slicedList = list.slice(1, 4);
+
+    expect(slicedList.toArray()).toEqual([2, 3, 4]);
+    expect(list.length).toBe(5); // Original list unchanged
+  });
+
+  // Splice method implementation
+  test('splice should modify list and return removed elements', () => {
+    const list = new Queue([1, 2, 3, 4, 5]);
+    const removedList = list.splice(2, 2, 6, 7);
+
+    expect(list.toArray()).toEqual([1, 2, 6, 7, 5]);
+    expect(removedList.toArray()).toEqual([3, 4]);
+  });
+
+  // Concat method test
+  test('concat should combine multiple lists', () => {
+    const list1 = new Queue([1, 2]);
+    const list2 = new Queue([3, 4]);
+    const list3 = new Queue([5, 6]);
+
+    const concatenatedList = list1.concat(list2, list3);
+    expect(concatenatedList.toArray()).toEqual([1, 2, 3, 4, 5, 6]);
+  });
+
+  // Sort method test
+  test('sort should order elements in ascending order', () => {
+    const list = new Queue([5, 2, 8, 1, 9]);
+    list.sort((a, b) => a - b);
+
+    expect(list.toArray()).toEqual([1, 2, 5, 8, 9]);
+  });
+
+  // Reverse method test
+  test('reverse should invert the list order', () => {
+    const list = new Queue([1, 2, 3, 4, 5]);
+    list.reverse();
+
+    expect(list.toArray()).toEqual([5, 4, 3, 2, 1]);
+  });
+
+  // Join method test
+  test('join should convert list to string with separator', () => {
+    const list = new Queue(['a', 'b', 'c']);
+
+    expect(list.join('-')).toBe('a-b-c');
+    expect(list.join()).toBe('a,b,c');
+  });
+
+  // IndexOf method test
+  test('indexOf should return first occurrence index', () => {
+    const list = new Queue([1, 2, 3, 2, 1]);
+
+    expect(list.indexOf(2)).toBe(1);
+    expect(list.indexOf(4)).toBe(-1);
+  });
+
+  // LastIndexOf method test
+  test('lastIndexOf should return last occurrence index', () => {
+    const list = new Queue([1, 2, 3, 2, 1]);
+
+    expect(list.lastIndexOf(2)).toBe(3);
+    expect(list.lastIndexOf(4)).toBe(-1);
+  });
+
+  // findIndex method test
+  test('findIndex should return first occurrence index', () => {
+    const list = new Queue([1, 2, 3, 2, 1]);
+    expect(list.findIndex(item => item === 2)).toBe(1);
+    expect(list.findIndex(item => item === 4)).toBe(-1);
+  });
+
+  // fill method test
+  test('fill should return fill all the list', () => {
+    let list = new Queue([1, 2, 3, 2, 1]);
+    expect([...list.fill(9)]).toEqual([9, 9, 9, 9, 9]);
+    list = new Queue([1, 2, 3, 2, 1]);
+    expect([...list.fill(9, 2, 3)]).toEqual([1, 2, 9, 2, 1]);
+    list = new Queue([1, 2, 3, 2, 1]);
+    expect([...list.fill(9, -3, -2)]).toEqual([1, 2, 9, 2, 1]);
+    list = new Queue([1, 2, 3, 2, 1]);
+    expect([...list.fill(9, -2, -3)]).toEqual([1, 2, 3, 2, 1]);
+  });
+});
+
 describe('Queue - Static and Clone Methods', () => {
   it('fromArray should create a new queue from an array', () => {
     const array = [1, 2, 3];
     const queue = Queue.fromArray(array);
     expect(queue.toArray()).toEqual(array);
-    expect(queue.size).toBe(array.length);
+    expect(queue.length).toBe(array.length);
   });
 
   it('fromArray should create an empty queue from an empty array', () => {
@@ -308,7 +407,7 @@ describe('Queue - Static and Clone Methods', () => {
 
     const clonedQueue = originalQueue.clone();
     expect(clonedQueue.toArray()).toEqual(originalQueue.toArray());
-    expect(clonedQueue.size).toBe(originalQueue.size);
+    expect(clonedQueue.length).toBe(originalQueue.length);
   });
 
   it('clone should not affect the original queue when mutated', () => {
@@ -319,7 +418,7 @@ describe('Queue - Static and Clone Methods', () => {
     const clonedQueue = originalQueue.clone();
     clonedQueue.push(3);
 
-    expect(clonedQueue.size).not.toBe(originalQueue.size);
+    expect(clonedQueue.length).not.toBe(originalQueue.length);
     expect(originalQueue.toArray()).not.toContain(3);
   });
 });
@@ -335,14 +434,14 @@ describe('LinkedListQueue', () => {
 
   it('should push elements to the end of the queue', () => {
     expect(queue.first).toBe('A');
-    expect(queue.size).toBe(2);
+    expect(queue.length).toBe(2);
   });
 
   it('should shift elements from the front of the queue', () => {
     const dequeued = queue.shift();
     expect(dequeued).toBe('A');
     expect(queue.first).toBe('B');
-    expect(queue.size).toBe(1);
+    expect(queue.length).toBe(1);
   });
 
   it('should peek at the front of the queue', () => {
@@ -352,6 +451,220 @@ describe('LinkedListQueue', () => {
   it('should clone method work correctly', () => {
     const cloned = queue.clone();
     expect(cloned instanceof LinkedListQueue).toBe(true);
-    expect(cloned.size).toBe(2);
+    expect(cloned.length).toBe(2);
+  });
+});
+
+describe('Queue', () => {
+  // Test queue initialization
+  it('should initialize correctly with no elements', () => {
+    const queue = new Queue();
+    expect(queue.isEmpty()).toBe(true);
+    expect(queue.length).toBe(0);
+    expect(queue.first).toBeUndefined();
+    expect(queue.last).toBeUndefined();
+  });
+
+  it('should initialize correctly with given elements', () => {
+    const queue = new Queue([1, 2, 3]);
+    expect(queue.length).toBe(3);
+    expect(queue.first).toBe(1);
+    expect(queue.last).toBe(3);
+  });
+
+  // Test push and pushMany
+  it('should add elements to the queue', () => {
+    const queue = new Queue<number>();
+    queue.push(1);
+    queue.push(2);
+    expect(queue.length).toBe(2);
+    expect(queue.first).toBe(1);
+    expect(queue.last).toBe(2);
+  });
+
+  it('should add multiple elements using pushMany', () => {
+    const queue = new Queue<number>();
+    queue.pushMany([1, 2, 3]);
+    expect(queue.length).toBe(3);
+    expect(queue.elements).toEqual([1, 2, 3]);
+  });
+
+  // Test shift
+  it('should remove the first element from the queue', () => {
+    const queue = new Queue([1, 2, 3]);
+    const shifted = queue.shift();
+    expect(shifted).toBe(1);
+    expect(queue.length).toBe(2);
+    expect(queue.first).toBe(2);
+  });
+
+  // Test delete and deleteAt
+  it('should delete an element from the queue', () => {
+    const queue = new Queue([1, 2, 3]);
+    const result = queue.delete(2);
+    expect(result).toBe(true);
+    expect(queue.elements).toEqual([1, 3]);
+  });
+
+  it('should delete an element at a specific index', () => {
+    const queue = new Queue([1, 2, 3]);
+    const deleted = queue.deleteAt(1);
+    expect(deleted).toBe(2);
+    expect(queue.elements).toEqual([1, 3]);
+  });
+
+  // Test at
+  it('should retrieve an element by index', () => {
+    const queue = new Queue([1, 2, 3]);
+    expect(queue.at(0)).toBe(1);
+    expect(queue.at(2)).toBe(3);
+  });
+
+  // Test reverse
+  it('should reverse the queue', () => {
+    const queue = new Queue([1, 2, 3]);
+    queue.reverse();
+    expect(queue.elements).toEqual([3, 2, 1]);
+    expect(queue.first).toBe(3);
+    expect(queue.last).toBe(1);
+  });
+
+  // Test addAt
+  it('should add an element at a specific index', () => {
+    const queue = new Queue([1, 3]);
+    const result = queue.addAt(1, 2);
+    expect(result).toBe(true);
+    expect(queue.elements).toEqual([1, 2, 3]);
+  });
+
+  // Test setAt
+  it('should set an element at a specific index', () => {
+    const queue = new Queue([1, 2, 3]);
+    const result = queue.setAt(1, 10);
+    expect(result).toBe(true);
+    expect(queue.elements).toEqual([1, 10, 3]);
+  });
+
+  // Test clear
+  it('should clear the queue', () => {
+    const queue = new Queue([1, 2, 3]);
+    queue.clear();
+    expect(queue.isEmpty()).toBe(true);
+    expect(queue.length).toBe(0);
+  });
+
+  // Test compact
+  it('should compact the queue', () => {
+    const queue = new Queue([1, 2, 3]);
+    queue.shift();
+    queue.shift();
+    queue.compact();
+    expect(queue.elements).toEqual([3]);
+  });
+
+  // Test splice
+  it('should splice elements from the queue', () => {
+    const queue = new Queue([1, 2, 3, 4]);
+    const removed = queue.splice(1, 2);
+    expect(removed.elements).toEqual([2, 3]);
+    expect(queue.elements).toEqual([1, 4]);
+  });
+
+  // Test clone
+  it('should create a clone of the queue', () => {
+    const queue = new Queue([1, 2, 3]);
+    const clone = queue.clone();
+    expect(clone.elements).toEqual(queue.elements);
+    clone.push(4);
+    expect(queue.elements).not.toContain(4);
+  });
+
+  // Test filter
+  it('should filter elements based on a predicate', () => {
+    const queue = new Queue([1, 2, 3, 4]);
+    const filtered = queue.filter(el => el % 2 === 0);
+    expect(filtered.elements).toEqual([2, 4]);
+  });
+
+  // Test map
+  it('should map elements to a new queue', () => {
+    const queue = new Queue([1, 2, 3]);
+    const mapped = queue.map(el => el * 2);
+    expect(mapped.elements).toEqual([2, 4, 6]);
+  });
+});
+
+describe('classic uses', () => {
+  it('@example Sliding Window using Queue', () => {
+    const nums = [2, 3, 4, 1, 5];
+    const k = 2;
+    const queue = new Queue<number>();
+
+    let maxSum = 0;
+    let currentSum = 0;
+
+    nums.forEach((num, i) => {
+      queue.push(num);
+      currentSum += num;
+
+      if (queue.length > k) {
+        currentSum -= queue.shift()!;
+      }
+
+      if (queue.length === k) {
+        maxSum = Math.max(maxSum, currentSum);
+      }
+    });
+
+    expect(maxSum).toBe(7); // Maximum sum is from subarray [3, 4].
+  });
+
+  it('@example Breadth-First Search (BFS) using Queue', () => {
+    const graph: { [key in number]: number[] } = {
+      1: [2, 3],
+      2: [4, 5],
+      3: [],
+      4: [],
+      5: []
+    };
+
+    const queue = new Queue<number>();
+    const visited: number[] = [];
+
+    queue.push(1);
+
+    while (!queue.isEmpty()) {
+      const node = queue.shift()!;
+      if (!visited.includes(node)) {
+        visited.push(node);
+        graph[node].forEach(neighbor => queue.push(neighbor));
+      }
+    }
+
+    expect(visited).toEqual([1, 2, 3, 4, 5]); // Expected BFS traversal order.
+  });
+
+  it('Task Scheduling using Queue', () => {
+    const tasks = ['A', 'A', 'A', 'B', 'B', 'B'];
+    const cooldown = 2;
+
+    const taskQueue = new Queue<string>();
+    const cooldownQueue = new Queue<string>();
+
+    for (const task of tasks) {
+      while (!cooldownQueue.isEmpty() && cooldownQueue.first === task) {
+        cooldownQueue.shift();
+        taskQueue.push('idle');
+      }
+
+      taskQueue.push(task);
+      cooldownQueue.push(task);
+      if (cooldownQueue.length > cooldown) {
+        cooldownQueue.shift();
+      }
+    }
+
+    const scheduled = taskQueue.elements;
+    expect(scheduled).toEqual(['A', 'idle', 'A', 'idle', 'A', 'B', 'B', 'idle', 'idle', 'B']);
   });
 });

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/unrestricted-interconversion.test.ts

@@ -263,7 +263,7 @@ describe('conversions', () => {
       'triangle'
     ]);
     const dq = new Deque<string>(heap);
-    expect(dq.size).toBe(10);
+    expect(dq.length).toBe(10);
     if (isDebug) dq.print();
     expect([...dq]).toEqual([
       'transmit',