data-structure-typed 1.33.9 → 1.33.10

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

@@ -0,0 +1,13 @@
+import {BSTNode} from '../../data-structures/binary-tree';
+import type {BinaryTreeOptions} from './binary-tree';
+import {BinaryTreeNodeId} from './abstract-binary-tree';
+
+export type BSTComparator = (a: BinaryTreeNodeId, b: BinaryTreeNodeId) => number;
+
+// prettier-ignore
+export type BSTNodeNested<T> = BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, BSTNode<T, any>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+export type BSTOptions = BinaryTreeOptions & {
+  comparator?: BSTComparator,
+}
+
+export enum CP {lt = 'lt', eq = 'eq', gt = 'gt'}

package/src/types/data-structures/directed-graph.ts

@@ -0,0 +1,8 @@
+// 0 means unknown, 1 means visiting, 2 means visited;
+export type TopologicalStatus = 0 | 1 | 2;
+
+export enum TopologicalProperty {
+  VAL = 'VAL',
+  NODE = 'NODE',
+  ID = 'ID'
+}

package/src/types/data-structures/doubly-linked-list.ts

@@ -0,0 +1 @@
+export {};

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

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

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

@@ -0,0 +1,5 @@
+export type HeapOptions<T> = {
+  priorityExtractor?: (element: T) => number;
+  // TODO there is an idea that support chaining which is for conveniently using the data structure
+  // isChaining? : boolean
+};

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

@@ -0,0 +1,16 @@
+export * from './binary-tree';
+export * from './bst';
+export * from './avl-tree';
+export * from './segment-tree';
+export * from './tree-multiset';
+export * from './abstract-graph';
+export * from './map-graph';
+export * from './abstract-binary-tree';
+export * from './rb-tree';
+export * from './directed-graph';
+export * from './priority-queue';
+export * from './heap';
+export * from './singly-linked-list';
+export * from './doubly-linked-list';
+export * from './navigator';
+export * from './hash';

package/src/types/data-structures/map-graph.ts

@@ -0,0 +1 @@
+export type MapGraphCoordinate = [number, number];

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

@@ -0,0 +1,13 @@
+export type Direction = 'up' | 'right' | 'down' | 'left';
+export type Turning = {[key in Direction]: Direction};
+
+export type NavigatorParams<T = any> = {
+  matrix: T[][];
+  turning: Turning;
+  onMove: (cur: [number, number]) => void;
+  init: {
+    cur: [number, number];
+    charDir: Direction;
+    VISITED: T;
+  };
+};

package/src/types/data-structures/priority-queue.ts

@@ -0,0 +1,9 @@
+export type PriorityQueueComparator<T> = (a: T, b: T) => number;
+
+export type PriorityQueueOptions<T> = {
+  nodes?: T[];
+  isFix?: boolean;
+  comparator: PriorityQueueComparator<T>;
+};
+
+export type PriorityQueueDFSOrderPattern = 'pre' | 'in' | 'post';

package/src/types/data-structures/rb-tree.ts

@@ -0,0 +1,8 @@
+import {BinaryTreeOptions} from './binary-tree';
+import {RBTreeNode} from '../../data-structures/binary-tree';
+
+export enum RBColor { RED = 'RED', BLACK = 'BLACK'}
+
+export type RBTreeNodeNested<T> = RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, RBTreeNode<T, any>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+
+export type RBTreeOptions = BinaryTreeOptions & {}

package/src/types/data-structures/segment-tree.ts

@@ -0,0 +1 @@
+export type SegmentTreeNodeVal = number;

package/src/types/data-structures/singly-linked-list.ts

@@ -0,0 +1 @@
+export {};

package/src/types/data-structures/tree-multiset.ts

@@ -0,0 +1,6 @@
+import {TreeMultisetNode} from '../../data-structures/binary-tree';
+import {AVLTreeOptions} from './avl-tree';
+
+export type TreeMultisetNodeNested<T> = TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, TreeMultisetNode<T, any>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+
+export type TreeMultisetOptions = Omit<AVLTreeOptions, 'isMergeDuplicatedNodeById'> & {}

package/src/types/helpers.ts

@@ -0,0 +1 @@
+export {};

package/src/types/index.ts

@@ -0,0 +1,3 @@
+export * from './data-structures';
+export * from './helpers';
+export * from './utils';

package/src/types/utils/index.ts

@@ -0,0 +1,2 @@
+export * from './utils';
+export * from './validate-type';

package/src/types/utils/utils.ts

@@ -0,0 +1,6 @@
+export type ToThunkFn = () => ReturnType<TrlFn>;
+export type Thunk = () => ReturnType<ToThunkFn> & {__THUNK__: symbol};
+export type TrlFn = (...args: any[]) => any;
+export type TrlAsyncFn = (...args: any[]) => any;
+
+export type SpecifyOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

package/src/types/utils/validate-type.ts

@@ -0,0 +1,35 @@
+export type KeyValueObject = {[key: string]: any};
+
+export type KeyValueObjectWithId = {[key: string]: any; id: string | number | symbol};
+
+export type NonNumberNonObjectButDefined = string | boolean | symbol | null;
+
+export type ObjectWithoutId = Omit<KeyValueObject, 'id'>;
+
+export type ObjectWithNonNumberId = {
+  [key: string]: any;
+  id: string | boolean | symbol | null | object | undefined;
+};
+
+export type ObjectWithNumberId = {
+  [key: string]: any;
+  id: number;
+};
+
+export type RestrictValById =
+  | NonNumberNonObjectButDefined
+  | ObjectWithoutId
+  | ObjectWithNonNumberId
+  | ObjectWithNumberId;
+
+export type DummyAny =
+  | string
+  | number
+  | boolean
+  | null
+  | undefined
+  | object
+  | symbol
+  | void
+  | ((...args: []) => any)
+  | never;

package/src/utils/index.ts

@@ -0,0 +1 @@
+export * from './utils';

package/src/utils/utils.ts

@@ -0,0 +1,79 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import type {Thunk, ToThunkFn, TrlAsyncFn, TrlFn} from '../types';
+
+export const uuidV4 = function () {
+  return 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'.replace(/[x]/g, function (c) {
+    const r = (Math.random() * 16) | 0,
+      v = c == 'x' ? r : (r & 0x3) | 0x8;
+    return v.toString(16);
+  });
+};
+
+export const arrayRemove = function <T>(array: T[], predicate: (item: T, index: number, array: T[]) => boolean): T[] {
+  let i = -1,
+    len = array ? array.length : 0;
+  const result = [];
+
+  while (++i < len) {
+    const value = array[i];
+    if (predicate(value, i, array)) {
+      result.push(value);
+      Array.prototype.splice.call(array, i--, 1);
+      len--;
+    }
+  }
+
+  return result;
+};
+
+export const THUNK_SYMBOL = Symbol('thunk');
+
+export const isThunk = (fnOrValue: any) => {
+  return typeof fnOrValue === 'function' && fnOrValue.__THUNK__ === THUNK_SYMBOL;
+};
+
+export const toThunk = (fn: ToThunkFn): Thunk => {
+  const thunk = () => fn();
+  thunk.__THUNK__ = THUNK_SYMBOL;
+  return thunk;
+};
+
+export const trampoline = (fn: TrlFn) => {
+  const cont = (...args: [...Parameters<TrlFn>]) => toThunk(() => fn(...args));
+
+  return Object.assign(
+    (...args: [...Parameters<TrlFn>]) => {
+      let result = fn(...args);
+
+      while (isThunk(result) && typeof result === 'function') {
+        result = result();
+      }
+
+      return result;
+    },
+    {cont}
+  );
+};
+
+export const trampolineAsync = (fn: TrlAsyncFn) => {
+  const cont = (...args: [...Parameters<TrlAsyncFn>]) => toThunk(() => fn(...args));
+
+  return Object.assign(
+    async (...args: [...Parameters<TrlAsyncFn>]) => {
+      let result = await fn(...args);
+
+      while (isThunk(result) && typeof result === 'function') {
+        result = await result();
+      }
+
+      return result;
+    },
+    {cont}
+  );
+};

package/test/integration/avl-tree.test.ts

@@ -0,0 +1,108 @@
+import {AVLTree} from 'avl-tree-typed';
+
+describe('AVL Tree Test', () => {
+  it('should perform various operations on a AVL Tree', () => {
+    const arr = [11, 3, 15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5];
+    const tree = new AVLTree();
+
+    for (const i of arr) tree.add(i, i);
+
+    const node6 = tree.get(6);
+
+    expect(node6 && tree.getHeight(node6)).toBe(3);
+    expect(node6 && tree.getDepth(node6)).toBe(1);
+
+    const getNodeById = tree.get(10, 'id');
+    expect(getNodeById?.id).toBe(10);
+
+    const getMinNodeByRoot = tree.getLeftMost();
+    expect(getMinNodeByRoot?.id).toBe(1);
+
+    const node15 = tree.get(15);
+    const getMinNodeBySpecificNode = node15 && tree.getLeftMost(node15);
+    expect(getMinNodeBySpecificNode?.id).toBe(12);
+
+    const subTreeSum = node15 && tree.subTreeSum(node15);
+    expect(subTreeSum).toBe(70);
+
+    const lesserSum = tree.lesserSum(10);
+    expect(lesserSum).toBe(45);
+
+    // node15 has type problem. After the uniform design, the generics of containers (DirectedGraph, BST) are based on the type of value. However, this design has a drawback: when I attempt to inherit from the Vertex or BSTNode classes, the types of the results obtained by all methods are those of the parent class.
+    expect(node15?.val).toBe(15);
+
+    const dfs = tree.DFS('in', 'node');
+    expect(dfs[0].id).toBe(1);
+    expect(dfs[dfs.length - 1].id).toBe(16);
+
+    tree.perfectlyBalance();
+    const bfs = tree.BFS('node');
+    expect(tree.isPerfectlyBalanced()).toBe(true);
+    expect(bfs[0].id).toBe(8);
+    expect(bfs[bfs.length - 1].id).toBe(16);
+
+    expect(tree.remove(11)[0].deleted?.id).toBe(11);
+    expect(tree.isAVLBalanced()).toBe(true);
+    expect(node15 && tree.getHeight(node15)).toBe(2);
+
+    expect(tree.remove(1)[0].deleted?.id).toBe(1);
+    expect(tree.isAVLBalanced()).toBe(true);
+    expect(tree.getHeight()).toBe(4);
+
+    expect(tree.remove(4)[0].deleted?.id).toBe(4);
+    expect(tree.isAVLBalanced()).toBe(true);
+    expect(tree.getHeight()).toBe(4);
+
+    expect(tree.remove(10)[0].deleted?.id).toBe(10);
+    expect(tree.isAVLBalanced()).toBe(true);
+    expect(tree.getHeight()).toBe(3);
+
+    expect(tree.remove(15)[0].deleted?.id).toBe(15);
+    expect(tree.isAVLBalanced()).toBe(true);
+
+    expect(tree.getHeight()).toBe(3);
+
+    expect(tree.remove(5)[0].deleted?.id).toBe(5);
+    expect(tree.isAVLBalanced()).toBe(true);
+    expect(tree.getHeight()).toBe(3);
+
+    expect(tree.remove(13)[0].deleted?.id).toBe(13);
+    expect(tree.isAVLBalanced()).toBe(true);
+    expect(tree.getHeight()).toBe(3);
+
+    expect(tree.remove(3)[0].deleted?.id).toBe(3);
+    expect(tree.isAVLBalanced()).toBe(true);
+    expect(tree.getHeight()).toBe(3);
+
+    expect(tree.remove(8)[0].deleted?.id).toBe(8);
+    expect(tree.isAVLBalanced()).toBe(true);
+    expect(tree.getHeight()).toBe(3);
+
+    expect(tree.remove(6)[0].deleted?.id).toBe(6);
+    expect(tree.remove(6).length).toBe(0);
+    expect(tree.isAVLBalanced()).toBe(true);
+    expect(tree.getHeight()).toBe(2);
+
+    expect(tree.remove(7)[0].deleted?.id).toBe(7);
+    expect(tree.isAVLBalanced()).toBe(true);
+    expect(tree.getHeight()).toBe(2);
+
+    expect(tree.remove(9)[0].deleted?.id).toBe(9);
+    expect(tree.isAVLBalanced()).toBe(true);
+    expect(tree.getHeight()).toBe(2);
+    expect(tree.remove(14)[0].deleted?.id).toBe(14);
+    expect(tree.isAVLBalanced()).toBe(true);
+    expect(tree.getHeight()).toBe(1);
+
+    expect(tree.isAVLBalanced()).toBe(true);
+    const lastBFSIds = tree.BFS();
+    expect(lastBFSIds[0]).toBe(12);
+    expect(lastBFSIds[1]).toBe(2);
+    expect(lastBFSIds[2]).toBe(16);
+
+    const lastBFSNodes = tree.BFS('node');
+    expect(lastBFSNodes[0].id).toBe(12);
+    expect(lastBFSNodes[1].id).toBe(2);
+    expect(lastBFSNodes[2].id).toBe(16);
+  });
+});