data-structure-typed 1.33.6 → 1.33.8

package/src/data-structures/linked-list/skip-linked-list.ts

@@ -1 +1,166 @@
-export class SkipLinkedList {}
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+
+export class SkipListNode<K, V> {
+  key: K;
+  value: V;
+  forward: SkipListNode<K, V>[];
+
+  constructor(key: K, value: V, level: number) {
+    this.key = key;
+    this.value = value;
+    this.forward = new Array(level);
+  }
+}
+
+export class SkipList<K, V> {
+  get probability(): number {
+    return this._probability;
+  }
+
+  set probability(value: number) {
+    this._probability = value;
+  }
+  get maxLevel(): number {
+    return this._maxLevel;
+  }
+
+  set maxLevel(value: number) {
+    this._maxLevel = value;
+  }
+  get level(): number {
+    return this._level;
+  }
+
+  set level(value: number) {
+    this._level = value;
+  }
+  get head(): SkipListNode<K, V> {
+    return this._head;
+  }
+
+  set head(value: SkipListNode<K, V>) {
+    this._head = value;
+  }
+  private _head: SkipListNode<K, V>;
+  private _level: number;
+  private _maxLevel: number;
+  private _probability: number;
+
+  /**
+   * The constructor initializes a SkipList with a specified maximum level and probability.
+   * @param [maxLevel=16] - The `maxLevel` parameter represents the maximum level that a skip list can have. It determines
+   * the maximum number of levels that can be created in the skip list.
+   * @param [probability=0.5] - The probability parameter represents the probability of a node being promoted to a higher
+   * level in the skip list. It is used to determine the height of each node in the skip list.
+   */
+  constructor(maxLevel = 16, probability = 0.5) {
+    this._head = new SkipListNode<K, V>(null as any, null as any, maxLevel);
+    this._level = 0;
+    this._maxLevel = maxLevel;
+    this._probability = probability;
+  }
+
+  /**
+   * The function "randomLevel" generates a random level based on a given probability and maximum level.
+   * @returns the level, which is a number.
+   */
+  private randomLevel(): number {
+    let level = 1;
+    while (Math.random() < this.probability && level < this.maxLevel) {
+      level++;
+    }
+    return level;
+  }
+
+  /**
+   * The add function adds a new node with a given key and value to a Skip List data structure.
+   * @param {K} key - The key parameter represents the key of the node that needs to be added to the skip list.
+   * @param {V} value - The "value" parameter represents the value associated with the key that is being added to the Skip
+   * List.
+   */
+  add(key: K, value: V): void {
+    const newNode = new SkipListNode(key, value, this.randomLevel());
+    const update: SkipListNode<K, V>[] = new Array(this.maxLevel).fill(this.head);
+    let current = this.head;
+
+    for (let i = this.level - 1; i >= 0; i--) {
+      while (current.forward[i] && current.forward[i].key < key) {
+        current = current.forward[i];
+      }
+      update[i] = current;
+    }
+
+    for (let i = 0; i < newNode.forward.length; i++) {
+      newNode.forward[i] = update[i].forward[i];
+      update[i].forward[i] = newNode;
+    }
+
+    if (newNode.forward[0] !== null) {
+      this.level = Math.max(this.level, newNode.forward.length);
+    }
+  }
+
+  /**
+   * The function `get` retrieves the value associated with a given key from a skip list data structure.
+   * @param {K} key - The `key` parameter is the key of the element that we want to retrieve from the data structure.
+   * @returns The method `get(key: K)` returns the value associated with the given key if it exists in the data structure,
+   * otherwise it returns `undefined`.
+   */
+  get(key: K): V | undefined {
+    let current = this.head;
+    for (let i = this.level - 1; i >= 0; i--) {
+      while (current.forward[i] && current.forward[i].key < key) {
+        current = current.forward[i];
+      }
+    }
+
+    current = current.forward[0];
+
+    if (current && current.key === key) {
+      return current.value;
+    }
+
+    return undefined;
+  }
+
+  /**
+   * The `remove` function removes a node with a specific key from a Skip List data structure.
+   * @param {K} key - The key parameter represents the key of the node that needs to be removed from the skip list.
+   * @returns The `remove` method returns a boolean value. It returns `true` if the key was successfully removed from the
+   * skip list, and `false` if the key was not found in the skip list.
+   */
+  remove(key: K): boolean {
+    const update: SkipListNode<K, V>[] = new Array(this.maxLevel).fill(this.head);
+    let current = this.head;
+
+    for (let i = this.level - 1; i >= 0; i--) {
+      while (current.forward[i] && current.forward[i].key < key) {
+        current = current.forward[i];
+      }
+      update[i] = current;
+    }
+
+    current = current.forward[0];
+
+    if (current && current.key === key) {
+      for (let i = 0; i < this.level; i++) {
+        if (update[i].forward[i] !== current) {
+          break;
+        }
+        update[i].forward[i] = current.forward[i];
+      }
+      while (this.level > 0 && this.head.forward[this.level - 1] === null) {
+        this.level--;
+      }
+      return true;
+    }
+
+    return false;
+  }
+}

package/src/types/data-structures/hash.ts

@@ -0,0 +1 @@
+export type HashFunction<K> = (key: K) => number;

package/src/types/data-structures/index.ts

@@ -13,3 +13,4 @@ export * from './heap';
 export * from './singly-linked-list';
 export * from './doubly-linked-list';
 export * from './navigator';
+export * from './hash';

package/test/integration/index.html

@@ -13,30 +13,38 @@
 </div>
 <script defer>
   const $modules = document.querySelector('.modules');
-  const $avlTree = document.createElement('li');
-  const $avlTreeSpan = document.createElement('span');
-  $avlTreeSpan.innerText = 'AVLTree';
-  $avlTree.append($avlTreeSpan);
-  const {AVLTree, Queue} = dataStructureTyped;
-  const avlTree = new AVLTree();
 
-  avlTree.add(1, 1);
-  console.log(avlTree.BFS());
-  $modules.append($avlTree);
 
+  try {
+    const {AVLTree, Queue} = window.dataStructureTyped;
+    const avlTree = new AVLTree();
+    const $avlTree = document.createElement('li');
+    const $avlTreeSpan = document.createElement('span');
+    $avlTreeSpan.innerText = 'AVLTree';
+    $avlTree.append($avlTreeSpan);
+    avlTree.add(1, 1);
+    console.log(avlTree.BFS());
+    $modules.append($avlTree);
 
-  const queue = new Queue();
-  for (let i = 0; i < 1000000; i++) {
-    queue.enqueue(i);
-  }
-  let last = 0;
-  const startTime = performance.now();
 
-  for (let i = 0; i < 1000000; i++) {
-    last = queue.dequeue();
+    const queue = new Queue();
+    for (let i = 0; i < 1000000; i++) {
+      queue.enqueue(i);
+    }
+    let last = 0;
+    const startTime = performance.now();
+
+    for (let i = 0; i < 1000000; i++) {
+      last = queue.dequeue();
+    }
+
+    console.log(performance.now() - startTime);
+
+  }
+  catch (e) {
+    console.error(e);
   }
 
-  console.log(performance.now() - startTime);
 </script>
 
 </body>

package/test/unit/data-structures/binary-tree/segment-tree.test.ts

@@ -0,0 +1,50 @@
+import {SegmentTree} from '../../../../src';
+
+describe('SegmentTree', () => {
+  let segmentTree: SegmentTree;
+
+  beforeEach(() => {
+    // Create an example SegmentTree for testing
+    const values = [1, 2, 3, 4, 5];
+    segmentTree = new SegmentTree(values);
+  });
+
+  it('should build a valid segment tree', () => {
+    // Check if the root node's sum is correct
+    expect(segmentTree.root?.sum).toBe(15);
+  });
+
+  it('should update a node in the segment tree', () => {
+    // Update a node value
+    segmentTree.updateNode(2, 10);
+
+    // Check if the sum of the root node is correct after the update
+    expect(segmentTree.root?.sum).toBe(22);
+  });
+
+  it('should query sum by range correctly', () => {
+    // Check if the sum within a specific range is correct
+    expect(segmentTree.querySumByRange(1, 3)).toBe(9); // 2 + 3 + 4 = 9
+  });
+
+  it('should handle edge cases for querySumByRange', () => {
+    // Check behavior when the range goes beyond boundaries
+    expect(segmentTree.querySumByRange(0, 4)).toBe(15); // Valid range, should return sum of the specified range
+    expect(segmentTree.querySumByRange(3, 2)).toBe(NaN); // End index is less than start index, should return NaN
+    expect(segmentTree.querySumByRange(0, 10)).toBe(NaN); // Beyond upper bound, should return NaN
+  });
+
+  it('should handle an empty input array', () => {
+    // Check behavior when dealing with an empty input array
+    const emptySegmentTree = new SegmentTree([]);
+    expect(emptySegmentTree.root).toBe(null);
+    expect(emptySegmentTree.querySumByRange(0, 2)).toBe(0); // Sum of an empty array should be 0
+  });
+
+  it('should handle a single-element input array', () => {
+    // Check behavior when the input array contains a single element
+    const singleElementSegmentTree = new SegmentTree([42]);
+    expect(singleElementSegmentTree.root?.sum).toBe(42);
+    expect(singleElementSegmentTree.querySumByRange(0, 0)).toBe(42); // Range covering the only element should return that element's value
+  });
+});

package/test/unit/data-structures/hash/hash-map.test.ts

@@ -0,0 +1,104 @@
+import {HashMap} from '../../../../src';
+
+describe('HashMap', () => {
+  let hashMap: HashMap<string, number>;
+
+  beforeEach(() => {
+    hashMap = new HashMap<string, number>();
+  });
+
+  it('should initialize correctly', () => {
+    expect(hashMap.size).toBe(0);
+    expect(hashMap.table.length).toBe(16);
+    expect(hashMap.loadFactor).toBe(0.75);
+    expect(hashMap.capacityMultiplier).toBe(2);
+    expect(hashMap.initialCapacity).toBe(16);
+    expect(hashMap.isEmpty()).toBe(true);
+  });
+
+  it('should put and get values', () => {
+    hashMap.set('one', 1);
+    hashMap.set('two', 2);
+    hashMap.set('three', 3);
+
+    expect(hashMap.get('one')).toBe(1);
+    expect(hashMap.get('two')).toBe(2);
+    expect(hashMap.get('three')).toBe(3);
+  });
+
+  it('should handle key collisions', () => {
+    // Force a collision by setting two different keys to the same bucket
+    hashMap.hashFn = () => 0; // Override hash function to return the same index
+    hashMap.set('key1', 1);
+    hashMap.set('key2', 2);
+
+    expect(hashMap.get('key1')).toBe(1);
+    expect(hashMap.get('key2')).toBe(2);
+  });
+
+  it('should remove values', () => {
+    hashMap.set('one', 1);
+    hashMap.set('two', 2);
+
+    hashMap.remove('one');
+    expect(hashMap.get('one')).toBeUndefined();
+    expect(hashMap.size).toBe(1);
+  });
+
+  it('should clear the HashMap', () => {
+    hashMap.set('one', 1);
+    hashMap.set('two', 2);
+
+    hashMap.clear();
+    expect(hashMap.size).toBe(0);
+    expect(hashMap.isEmpty()).toBe(true);
+  });
+
+  it('should iterate over entries', () => {
+    hashMap.set('one', 1);
+    hashMap.set('two', 2);
+    hashMap.set('three', 3);
+
+    const entries = Array.from(hashMap.entries());
+    expect(entries).toEqual(
+      expect.arrayContaining([
+        ['one', 1],
+        ['two', 2],
+        ['three', 3]
+      ])
+    );
+  });
+
+  it('should resize the table when load factor is exceeded', () => {
+    // Set a small initial capacity for testing resizing
+    hashMap = new HashMap<string, number>(4, 0.5);
+
+    hashMap.set('one', 1);
+    hashMap.set('two', 2);
+    hashMap.set('three', 3);
+    hashMap.set('four', 4); // This should trigger a resize
+
+    expect(hashMap.table.length).toBe(8);
+    expect(hashMap.get('one')).toBe(1);
+    expect(hashMap.get('two')).toBe(2);
+    expect(hashMap.get('three')).toBe(3);
+    expect(hashMap.get('four')).toBe(4);
+  });
+
+  it('should allow using a custom hash function', () => {
+    const customHashFn = () => {
+      // A simple custom hash function that always returns 0
+      return 0;
+    };
+    hashMap = new HashMap<string, number>(16, 0.75, customHashFn);
+
+    hashMap.set('one', 1);
+    hashMap.set('two', 2);
+
+    expect(hashMap.get('one')).toBe(1);
+    expect(hashMap.get('two')).toBe(2);
+    // Since the custom hash function always returns 0, these keys will collide.
+    // Make sure they are stored separately.
+    expect(hashMap.table[0].length).toBe(2);
+  });
+});

package/test/unit/data-structures/hash/hash-table.test.ts

@@ -1,10 +1,10 @@
-import {HashNode, HashTable} from '../../../../src';
+import {HashTableNode, HashTable} from '../../../../src';
 
 describe('HashNode', () => {
   it('should create a HashNode with key and value', () => {
     const key = 'testKey';
     const value = 'testValue';
-    const hashNode = new HashNode(key, value);
+    const hashNode = new HashTableNode(key, value);
 
     expect(hashNode.key).toBe(key);
     expect(hashNode.val).toBe(value);
@@ -16,9 +16,9 @@ describe('HashTable', () => {
   it('should initialize with default capacity', () => {
     const hashTable = new HashTable<string, string>();
 
-    expect(hashTable.capacity).toBe(1000);
+    expect(hashTable.capacity).toBe(16);
     expect(hashTable.size).toBe(0);
-    expect(hashTable.buckets.length).toBe(1000);
+    expect(hashTable.buckets.length).toBe(16);
   });
 
   it('should initialize with custom capacity', () => {
@@ -35,7 +35,7 @@ describe('HashTable', () => {
     const key = 'testKey';
     const value = 'testValue';
 
-    hashTable.put(key, value);
+    hashTable.set(key, value);
     const retrievedValue = hashTable.get(key);
 
     expect(retrievedValue).toBe(value);
@@ -48,8 +48,8 @@ describe('HashTable', () => {
     const key2 = 'testKey2';
     const value2 = 'testValue2';
 
-    hashTable.put(key1, value1);
-    hashTable.put(key2, value2);
+    hashTable.set(key1, value1);
+    hashTable.set(key2, value2);
 
     const retrievedValue1 = hashTable.get(key1);
     const retrievedValue2 = hashTable.get(key2);
@@ -64,8 +64,8 @@ describe('HashTable', () => {
     const initialValue = 'testValue1';
     const updatedValue = 'testValue2';
 
-    hashTable.put(key, initialValue);
-    hashTable.put(key, updatedValue);
+    hashTable.set(key, initialValue);
+    hashTable.set(key, updatedValue);
 
     const retrievedValue = hashTable.get(key);
 
@@ -86,7 +86,7 @@ describe('HashTable', () => {
     const key = 'testKey';
     const value = 'testValue';
 
-    hashTable.put(key, value);
+    hashTable.set(key, value);
     hashTable.remove(key);
 
     const retrievedValue = hashTable.get(key);
@@ -95,3 +95,90 @@ describe('HashTable', () => {
     expect(hashTable.size).toBe(0);
   });
 });
+
+describe('HashTable', () => {
+  let hashTable: HashTable<string, number>;
+
+  beforeEach(() => {
+    hashTable = new HashTable<string, number>();
+  });
+
+  it('should insert and retrieve values correctly', () => {
+    hashTable.set('one', 1);
+    hashTable.set('two', 2);
+
+    expect(hashTable.get('one')).toBe(1);
+    expect(hashTable.get('two')).toBe(2);
+  });
+
+  it('should update values correctly', () => {
+    hashTable.set('one', 1);
+    expect(hashTable.get('one')).toBe(1);
+
+    hashTable.set('one', 100); // Update the value
+    expect(hashTable.get('one')).toBe(100);
+  });
+
+  it('should handle collisions correctly', () => {
+    hashTable = new HashTable<string, number>(1); // Set a small capacity to force collisions
+    hashTable.set('one', 1);
+    hashTable.set('two', 2);
+
+    expect(hashTable.get('one')).toBe(1);
+    expect(hashTable.get('two')).toBe(2);
+  });
+
+  it('should remove values correctly', () => {
+    hashTable.set('one', 1);
+    hashTable.set('two', 2);
+    hashTable.remove('one');
+
+    expect(hashTable.get('one')).toBeUndefined();
+    expect(hashTable.get('two')).toBe(2);
+  });
+
+  it('should handle non-existent keys correctly', () => {
+    expect(hashTable.get('non-existent')).toBeUndefined();
+    hashTable.remove('non-existent'); // Removing a non-existent key should not cause errors
+  });
+
+  it('should handle custom hash function correctly', () => {
+    // const customHashFn = () => {
+    //   // Custom hash function that returns a fixed value for all keys
+    //   return 42;
+    // };
+
+    hashTable = new HashTable<string, number>(16);
+    hashTable.set('one', 1);
+    expect(hashTable.get('one')).toBe(1);
+    expect(hashTable.get('two')).toBeUndefined();
+  });
+
+  it('should expand when load factor exceeds threshold', () => {
+    hashTable = new HashTable<string, number>(2); // Set a small capacity to trigger expansion
+    hashTable.set('one', 1);
+    hashTable.set('two', 2);
+    hashTable.set('three', 3); // This should trigger an expansion
+
+    expect(hashTable.capacity).toBe(16);
+    expect(hashTable.get('one')).toBe(1);
+    expect(hashTable.get('two')).toBe(2);
+    expect(hashTable.get('three')).toBe(3);
+  });
+});
+
+describe('HashTable performance', function () {
+  it('Items set performance', function () {
+    const mag = 100000;
+    const ht = new HashTable();
+    // const s = performance.now();
+    for (let i = 0; i < mag; i++) {
+      ht.set(i, i);
+    }
+    // const s1 = performance.now();
+    const map = new Map();
+    for (let i = 0; i < mag; i++) {
+      map.set(i, i);
+    }
+  });
+});

package/test/unit/data-structures/linked-list/skip-list.test.ts

@@ -0,0 +1,55 @@
+import {SkipList} from '../../../../src';
+
+describe('SkipList', () => {
+  let skipList: SkipList<number, string>;
+
+  beforeEach(() => {
+    skipList = new SkipList<number, string>();
+  });
+
+  it('should insert and retrieve elements correctly', () => {
+    skipList.add(1, 'One');
+    skipList.add(2, 'Two');
+    skipList.add(3, 'Three');
+
+    expect(skipList.get(1)).toBe('One');
+    expect(skipList.get(2)).toBe('Two');
+    expect(skipList.get(3)).toBe('Three');
+  });
+
+  it('should return undefined for non-existent keys', () => {
+    skipList.add(1, 'One');
+    skipList.add(2, 'Two');
+
+    expect(skipList.get(3)).toBeUndefined();
+    expect(skipList.get(0)).toBeUndefined();
+  });
+
+  it('should remove elements correctly', () => {
+    skipList.add(1, 'One');
+    skipList.add(2, 'Two');
+    skipList.add(3, 'Three');
+
+    skipList.remove(2);
+
+    expect(skipList.get(2)).toBeUndefined(); // 修改这里的断言
+  });
+
+  it('should handle random data correctly', () => {
+    const randomData: Array<[number, string]> = [
+      [5, 'Five'],
+      [1, 'One'],
+      [3, 'Three'],
+      [2, 'Two'],
+      [4, 'Four']
+    ];
+
+    for (const [key, value] of randomData) {
+      skipList.add(key, value);
+    }
+
+    expect(skipList.get(3)).toBe('Three');
+    expect(skipList.get(5)).toBe('Five');
+    expect(skipList.get(4)).toBe('Four');
+  });
+});