From 849e3c6bcac2f459ae8405bcec81d15e52b6238f Mon Sep 17 00:00:00 2001 From: Revone Date: Wed, 23 Aug 2023 11:39:01 +0800 Subject: [PATCH] Test and debug the bug related to BinaryTreeNode's handling of object types.Revise the design of the constructor to incorporate abstract methods for enforcing the requirement that subclasses must implement the _createVertex and _createEdge methods. --- .../binary-tree/abstract-binary-tree.ts | 1499 +++++++++++++++++ src/data-structures/binary-tree/avl-tree.ts | 5 +- .../binary-tree/binary-tree.ts | 70 +- src/data-structures/binary-tree/bst.ts | 10 +- src/data-structures/binary-tree/index.ts | 1 + src/data-structures/binary-tree/rb-tree.ts | 3 +- src/data-structures/graph/directed-graph.ts | 13 +- src/data-structures/graph/undirected-graph.ts | 33 +- src/data-structures/interfaces/binary-tree.ts | 3 +- .../types/abstract-binary-tree.ts | 14 + src/data-structures/types/avl-tree.ts | 2 + src/data-structures/types/binary-tree.ts | 6 + src/data-structures/types/bst.ts | 7 +- src/data-structures/types/helpers.ts | 2 + src/data-structures/types/index.ts | 4 +- .../data-structures/binary-tree/bst.test.ts | 203 ++- .../graph/directed-graph.test.ts | 16 +- .../graph/undirected-graph.test.ts | 63 +- 18 files changed, 1872 insertions(+), 82 deletions(-) create mode 100644 src/data-structures/binary-tree/abstract-binary-tree.ts create mode 100644 src/data-structures/types/abstract-binary-tree.ts create mode 100644 src/data-structures/types/helpers.ts diff --git a/src/data-structures/binary-tree/abstract-binary-tree.ts b/src/data-structures/binary-tree/abstract-binary-tree.ts new file mode 100644 index 0000000..52a627e --- /dev/null +++ b/src/data-structures/binary-tree/abstract-binary-tree.ts @@ -0,0 +1,1499 @@ +/** + * data-structure-typed + * + * @author Tyler Zeng + * @copyright Copyright (c) 2022 Tyler Zeng + * @license MIT License + */ + +import {trampoline} from '../../utils'; +import type { + BinaryTreeDeleted, + BinaryTreeNodeId, + BinaryTreeNodePropertyName, + DFSOrderPattern, + KeyValObject, + NodeOrPropertyName, + ResultByProperty, + ResultsByProperty +} from '../types'; +import {BinaryTreeOptions, FamilyPosition, LoopType, RecursiveAbstractBinaryTreeNode} from '../types'; +import {IBinaryTree, IBinaryTreeNode} from '../interfaces'; + + +export abstract class AbstractBinaryTreeNode = RecursiveAbstractBinaryTreeNode> implements IBinaryTreeNode { + + protected constructor(id: BinaryTreeNodeId, val: T, count?: number) { + this._id = id; + this._val = val; + this._count = count ?? 1; + } + + private _id: BinaryTreeNodeId; + + get id(): BinaryTreeNodeId { + return this._id; + } + + set id(v: BinaryTreeNodeId) { + this._id = v; + } + + private _val: T; + + get val(): T { + return this._val; + } + + set val(v: T) { + this._val = v; + } + + private _left?: FAMILY | null; + + get left(): FAMILY | null | undefined { + return this._left; + } + + set left(v: FAMILY | null | undefined) { + if (v) { + v.parent = this as unknown as FAMILY; + v.familyPosition = FamilyPosition.left; + } + this._left = v; + } + + private _right?: FAMILY | null; + + get right(): FAMILY | null | undefined { + return this._right; + } + + set right(v: FAMILY | null | undefined) { + if (v) { + v.parent = this as unknown as FAMILY; + v.familyPosition = FamilyPosition.right; + } + this._right = v; + } + + private _parent: FAMILY | null | undefined; + + get parent(): FAMILY | null | undefined { + return this._parent; + } + + set parent(v: FAMILY | null | undefined) { + this._parent = v; + } + + private _familyPosition: FamilyPosition = FamilyPosition.root; + + get familyPosition(): FamilyPosition { + return this._familyPosition; + } + + set familyPosition(v: FamilyPosition) { + this._familyPosition = v; + } + + private _count = 1; + + get count(): number { + return this._count; + } + + set count(v: number) { + this._count = v; + } + + private _height = 0; + + get height(): number { + return this._height; + } + + set height(v: number) { + this._height = v; + } + + abstract _createNode(id: BinaryTreeNodeId, val: T | null, count?: number): FAMILY | null + + swapLocation(swapNode: FAMILY): FAMILY { + const {val, count, height} = swapNode; + const tempNode = this._createNode(swapNode.id, val); + if (tempNode instanceof AbstractBinaryTreeNode) { + tempNode.val = val; + tempNode.count = count; + tempNode.height = height; + + swapNode.id = this.id; + swapNode.val = this.val; + swapNode.count = this.count; + swapNode.height = this.height; + + this.id = tempNode.id; + this.val = tempNode.val; + this.count = tempNode.count; + this.height = tempNode.height; + } + return swapNode; + } + + clone(): FAMILY | null { + return this._createNode(this.id, this.val, this.count); + } +} + +export abstract class AbstractBinaryTree = AbstractBinaryTreeNode> implements IBinaryTree { + + /** + * The constructor function accepts an optional options object and sets the values of loopType, autoIncrementId, and + * isDuplicatedVal based on the provided options. + * @param [options] - An optional object that can contain the following properties: + */ + protected constructor(options?: BinaryTreeOptions) { + if (options !== undefined) { + const { + loopType = LoopType.iterative, + autoIncrementId = false, + isDuplicatedVal = false + } = options; + this._isDuplicatedVal = isDuplicatedVal; + this._autoIncrementId = autoIncrementId; + this._loopType = loopType; + } + } + + private _loopType: LoopType = LoopType.iterative; + + get loopType(): LoopType { + return this._loopType; + } + + private _visitedId: BinaryTreeNodeId[] = []; + get visitedId(): BinaryTreeNodeId[] { + return this._visitedId; + } + + private _visitedVal: Array = []; + + get visitedVal(): Array { + return this._visitedVal; + } + + private _visitedNode: N[] = []; + + get visitedNode(): N[] { + return this._visitedNode; + } + + private _visitedCount: number[] = []; + + get visitedCount(): number[] { + return this._visitedCount; + } + + private _visitedLeftSum: number[] = []; + + get visitedLeftSum(): number[] { + return this._visitedLeftSum; + } + + private _autoIncrementId: boolean = false; + + get autoIncrementId(): boolean { + return this._autoIncrementId; + } + + private _maxId: number = -1; + + get maxId(): number { + return this._maxId; + } + + private _isDuplicatedVal: boolean = false; + + get isDuplicatedVal(): boolean { + return this._isDuplicatedVal; + } + + private _root: N | null = null; + + get root(): N | null { + return this._root; + } + + private _size = 0; + + get size(): number { + return this._size; + } + + private _count = 0; + + get count(): number { + return this._count; + } + + /** + * The function creates a new binary tree node with the given id, value, and count if the value is not null, otherwise + * it returns null. + * @param {BinaryTreeNodeId} id - The `id` parameter is the identifier for the binary tree node. It is of type + * `BinaryTreeNodeId`. + * @param {N | null} val - The `val` parameter represents the value of the node. It can be of type `N` (generic type) + * or `null`. + * @param {number} [count] - The `count` parameter is an optional parameter of type `number`. It represents the number + * of occurrences of the value in the binary tree node. If not provided, the default value is `undefined`. + * @returns a BinaryTreeNode object if the value is not null, otherwise it returns null. + */ + abstract _createNode(id: BinaryTreeNodeId, val: N['val'] | null, count?: number): N | null ; + + /** + * The clear function resets the state of an object by setting its properties to their initial values. + */ + clear() { + this._setRoot(null); + this._setSize(0); + this._setCount(0); + this._setMaxId(-1); + } + + /** + * The function checks if the size of an object is equal to zero and returns a boolean value. + * @returns A boolean value indicating whether the size of the object is 0 or not. + */ + isEmpty(): boolean { + return this.size === 0; + } + + /** + * The `add` function inserts a new node with a given ID and value into a binary tree, updating the count if the node + * already exists. + * @param {BinaryTreeNodeId} id - The id parameter is the identifier of the binary tree node. It is used to uniquely + * identify each node in the binary tree. + * @param {N} val - The value to be inserted into the binary tree. + * @param {number} [count] - The `count` parameter is an optional parameter that specifies the number of times the + * value should be inserted into the binary tree. If not provided, it defaults to 1. + * @returns The function `add` returns a `N` object if a new node is inserted, or `null` if no new node + * is inserted, or `undefined` if the insertion fails. + */ + add(id: BinaryTreeNodeId, val?: N['val'], count?: number): N | null | undefined { + count = count ?? 1; + + const _bfs = (root: N, newNode: N | null): N | undefined | null => { + const queue: Array = [root]; + while (queue.length > 0) { + const cur = queue.shift(); + if (cur) { + const inserted = this.addTo(newNode, cur); + if (inserted !== undefined) return inserted; + if (cur.left) queue.push(cur.left); + if (cur.right) queue.push(cur.right); + } else return; + } + return; + }; + + let inserted: N | null | undefined; + const needInsert = val !== null ? this._createNode(id, val ?? id, count) : null; + const existNode = val !== null ? this.get(id, 'id') : null; + if (this.root) { + if (existNode) { + existNode.count += count; + existNode.val = val ?? id; + if (needInsert !== null) { + this._setCount(this.count + count); + inserted = existNode; + } + } else { + inserted = _bfs(this.root, needInsert); + } + } else { + this._setRoot(val !== null ? this._createNode(id, val ?? id, count) : null); + if (needInsert !== null) { + this._setSize(1); + this._setCount(count); + } + inserted = this.root; + } + return inserted; + } + + /** + * The function inserts a new node into a binary tree as the left or right child of a given parent node. + * @param {N | null} newNode - The `newNode` parameter is an instance of the `BinaryTreeNode` class or + * `null`. It represents the node that needs to be inserted into the binary tree. + * @param parent - The `parent` parameter is a BinaryTreeNode object representing the parent node to which the new node + * will be inserted as a child. + * @returns The method returns the newly inserted node, either as the left child or the right child of the parent node. + */ + addTo(newNode: N | null, parent: N) { + if (parent) { + if (parent.left === undefined) { + if (newNode) { + newNode.parent = parent; + newNode.familyPosition = FamilyPosition.left; + } + parent.left = newNode; + if (newNode !== null) { + this._setSize(this.size + 1); + this._setCount(this.count + newNode.count ?? 0) + } + + return parent.left; + } else if (parent.right === undefined) { + if (newNode) { + newNode.parent = parent; + newNode.familyPosition = FamilyPosition.right; + } + parent.right = newNode; + if (newNode !== null) { + this._setSize(this.size + 1); + this._setCount(this.count + newNode.count ?? 0); + } + return parent.right; + } else { + return; + } + } else { + return; + } + } + + /** + * The `addMany` function inserts multiple items into a binary tree and returns an array of the inserted nodes or + * null/undefined values. + * @param {N[] | N[]} data - The `data` parameter can be either an array of elements of type `N` or an + * array of `N` objects. + * @returns The function `addMany` returns an array of `N`, `null`, or `undefined` values. + */ + addMany(data: N[] | Array): (N | null | undefined)[] { + const inserted: (N | null | undefined)[] = []; + const map: Map = new Map(); + + if (!this._isDuplicatedVal) { + for (const i of data) map.set(i, (map.get(i) ?? 0) + 1); + } + + for (const item of data) { + // TODO will this cause an issue? + const count = this._isDuplicatedVal ? 1 : map.get(item); + + if (item instanceof AbstractBinaryTreeNode) { + inserted.push(this.add(item.id, item.val, item.count)); + } else if (typeof item === 'number') { + if (!this._autoIncrementId) { + if (!this._isDuplicatedVal) { + if (map.get(item) !== undefined) { + inserted.push(this.add(item, item, count)); + map.delete(item); + } + } else { + inserted.push(this.add(item, item, 1)); + } + } + + } else if (item instanceof Object) { + if (!this._isDuplicatedVal) { + if (map.has(item)) { + let newId: number; + if (!this._autoIncrementId) { + if ((item as KeyValObject).hasOwnProperty('id')) { + newId = (item as KeyValObject).id; + } else { + console.warn('Object value must has an id property when the autoIncrementId is false'); + break; + } + } else { + newId = this.maxId + 1; + this._setMaxId(newId); + } + inserted.push(this.add(newId, item, count)); + map.delete(item); + } + } else { + inserted.push(this.add(++this._maxId, item, 1)); + } + } else if (item === null) { + inserted.push(this.add(Number.MAX_SAFE_INTEGER, item, 0)); + } + } + return inserted; + } + + /** + * The `fill` function clears the current data and inserts new data, returning a boolean indicating if the insertion + * was successful. + * @param {N[] | N[]} data - The `data` parameter can be either an array of elements of type `N` or an + * array of `N` objects. + * @returns The method is returning a boolean value. + */ + fill(data: N[] | Array): boolean { + this.clear(); + return data.length === this.addMany(data).length; + } + + /** + * The function removes a node from a binary tree and returns information about the deleted node. + * @param {BinaryTreeNodeId} id - The `id` parameter is the identifier of the binary tree node that you want to remove. + * It is of type `BinaryTreeNodeId`. + * @param {boolean} [ignoreCount] - The `ignoreCount` parameter is an optional boolean parameter that determines + * whether to ignore the count of the node being removed. If `ignoreCount` is set to `true`, the count of the node will + * not be decremented and the overall count of the binary tree will not be updated. If ` + * @returns An array of objects is being returned. Each object in the array has two properties: "deleted" and + * "needBalanced". The "deleted" property contains the deleted node or undefined if no node was deleted. The + * "needBalanced" property is always null. + */ + remove(id: BinaryTreeNodeId, ignoreCount?: boolean): BinaryTreeDeleted[] { + const nodes = this.getNodes(id, 'id', true); + let node: N | null | undefined = nodes[0]; + + if (!node) node = undefined; + else if (node.count > 1 && !ignoreCount) { + node.count--; + this._setCount(this.count - 1); + } else if (node instanceof AbstractBinaryTreeNode) { + const [subSize, subCount] = this.getSubTreeSizeAndCount(node); + + switch (node.familyPosition) { + case 0: + this._setSize(this.size - subSize); + this._setCount(this.count - subCount); + node = undefined; + break; + case 1: + if (node.parent) { + this._setSize(this.size - subSize); + this._setCount(this.count - subCount); + node.parent.left = null; + } + break; + case 2: + if (node.parent) { + this._setSize(this.size - subSize); + this._setCount(this.count - subCount); + node.parent.right = null; + } + break; + } + } + return [{deleted: node, needBalanced: null}]; + } + + /** + * The function calculates the depth of a binary tree node by traversing its parent nodes. + * @param node - N - This is the node for which we want to calculate the depth. It is a generic type, + * meaning it can represent any type of data that we want to store in the node. + * @returns The depth of the given binary tree node. + */ + getDepth(node: N): number { + let depth = 0; + while (node.parent) { + depth++; + node = node.parent; + } + return depth; + } + + /** + * The `getHeight` function calculates the maximum height of a binary tree using either a recursive or iterative + * approach. + * @param {N | null} [beginRoot] - The `beginRoot` parameter is an optional parameter of type + * `N | null`. It represents the starting node from which to calculate the height of the binary tree. + * If no value is provided for `beginRoot`, the function will use the `root` property of the class instance as + * @returns the height of the binary tree. + */ + getHeight(beginRoot?: N | null): number { + beginRoot = beginRoot ?? this.root; + if (!beginRoot) return -1; + + if (this._loopType === LoopType.recursive) { + const _getMaxHeight = (cur: N | null | undefined): number => { + if (!cur) return -1; + const leftHeight = _getMaxHeight(cur.left); + const rightHeight = _getMaxHeight(cur.right); + return Math.max(leftHeight, rightHeight) + 1; + }; + + return _getMaxHeight(beginRoot); + } else { + const stack: N[] = []; + let node: N | null | undefined = beginRoot, last: N | null = null; + const depths: Map = new Map(); + + while (stack.length > 0 || node) { + if (node) { + stack.push(node); + node = node.left; + } else { + node = stack[stack.length - 1] + if (!node.right || last === node.right) { + node = stack.pop(); + if (node) { + const leftHeight = node.left ? depths.get(node.left) ?? -1 : -1; + const rightHeight = node.right ? depths.get(node.right) ?? -1 : -1; + depths.set(node, 1 + Math.max(leftHeight, rightHeight)); + last = node; + node = null; + } + } else node = node.right + } + } + + return depths.get(beginRoot) ?? -1; + } + } + + /** + * The `getMinHeight` function calculates the minimum height of a binary tree using either a recursive or iterative + * approach. + * @param {N | null} [beginRoot] - The `beginRoot` parameter is an optional parameter of type + * `N | null`. It represents the starting node from which to calculate the minimum height of the binary + * tree. If no value is provided for `beginRoot`, the function will use the root node of the binary tree. + * @returns The function `getMinHeight` returns the minimum height of the binary tree. + */ + getMinHeight(beginRoot?: N | null): number { + beginRoot = beginRoot || this.root; + if (!beginRoot) return -1; + + if (this._loopType === LoopType.recursive) { + const _getMinHeight = (cur: N | null | undefined): number => { + if (!cur) return 0; + if (!cur.left && !cur.right) return 0; + const leftMinHeight = _getMinHeight(cur.left); + const rightMinHeight = _getMinHeight(cur.right); + return Math.min(leftMinHeight, rightMinHeight) + 1; + }; + + return _getMinHeight(beginRoot); + } else { + const stack: N[] = []; + let node: N | null | undefined = beginRoot, last: N | null = null; + const depths: Map = new Map(); + + while (stack.length > 0 || node) { + if (node) { + stack.push(node); + node = node.left; + } else { + node = stack[stack.length - 1] + if (!node.right || last === node.right) { + node = stack.pop(); + if (node) { + const leftMinHeight = node.left ? depths.get(node.left) ?? -1 : -1; + const rightMinHeight = node.right ? depths.get(node.right) ?? -1 : -1; + depths.set(node, 1 + Math.min(leftMinHeight, rightMinHeight)); + last = node; + node = null; + } + } else node = node.right + } + } + + return depths.get(beginRoot) ?? -1; + } + } + + /** + * The function checks if a binary tree is balanced by comparing the minimum height and the maximum height of the tree. + * @param {N | null} [beginRoot] - The `beginRoot` parameter is the root node of a binary tree. It is + * of type `N | null`, which means it can either be a `BinaryTreeNode` object or `null`. + * @returns The method is returning a boolean value. + */ + isBalanced(beginRoot?: N | null): boolean { + return (this.getMinHeight(beginRoot) + 1 >= this.getHeight(beginRoot)); + } + + /** + * The function `getNodes` returns an array of binary tree nodes that match a given property value, with options for + * searching recursively or iteratively. + * @param {BinaryTreeNodeId | N} nodeProperty - The `nodeProperty` parameter can be either a `BinaryTreeNodeId` or a + * generic type `N`. It represents the property of the binary tree node that you want to search for. + * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that + * specifies the property name to use when searching for nodes. If not provided, it defaults to 'id'. + * @param {boolean} [onlyOne] - The `onlyOne` parameter is an optional boolean parameter that determines whether to + * return only one node that matches the `nodeProperty` or `propertyName` criteria. If `onlyOne` is set to `true`, the + * function will stop traversing the tree and return the first matching node. If ` + * @returns The function `getNodes` returns an array of `N | null | undefined` objects. + */ + getNodes(nodeProperty: BinaryTreeNodeId | N, propertyName ?: BinaryTreeNodePropertyName, onlyOne ?: boolean) { + if (!this.root) return [] as null[]; + propertyName = propertyName ?? 'id'; + + const result: (N | null | undefined)[] = []; + + if (this._loopType === LoopType.recursive) { + const _traverse = (cur: N) => { + if (this._pushByPropertyNameStopOrNot(cur, result, nodeProperty, propertyName, onlyOne)) return; + if (!cur.left && !cur.right) return; + cur.left && _traverse(cur.left); + cur.right && _traverse(cur.right); + } + + _traverse(this.root); + } else { + const queue: N[] = [this.root]; + while (queue.length > 0) { + const cur = queue.shift(); + if (cur) { + if (this._pushByPropertyNameStopOrNot(cur, result, nodeProperty, propertyName, onlyOne)) return result; + cur.left && queue.push(cur.left); + cur.right && queue.push(cur.right); + } + } + } + + return result; + } + + /** + * The function checks if a binary tree node has a specific property or if any node in the tree has a specific + * property. + * @param {BinaryTreeNodeId | N} nodeProperty - The `nodeProperty` parameter can be either a `BinaryTreeNodeId` or a + * generic type `N`. It represents the property of a binary tree node that you want to check. + * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that + * specifies the name of the property to check for in the nodes. + * @returns a boolean value. + */ + has(nodeProperty: BinaryTreeNodeId | N, propertyName ?: BinaryTreeNodePropertyName): boolean { + return this.getNodes(nodeProperty, propertyName).length > 0; + } + + /** + * The function returns the first binary tree node that matches the given property name and value, or null if no match + * is found. + * @param {BinaryTreeNodeId | N} nodeProperty - The `nodeProperty` parameter can be either a `BinaryTreeNodeId` or a + * generic type `N`. It represents the property of the binary tree node that you want to search for. + * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that + * specifies the property of the binary tree node to search for. If not provided, it defaults to `'id'`. + * @returns a BinaryTreeNode object or null. + */ + get(nodeProperty: BinaryTreeNodeId | N, propertyName ?: BinaryTreeNodePropertyName): N | null { + propertyName = propertyName ?? 'id'; + return this.getNodes(nodeProperty, propertyName, true)[0] ?? null; + } + + /** + * The function getPathToRoot returns an array of BinaryTreeNode objects representing the path from a given node to the + * root of a binary tree. + * @param node - The `node` parameter is a BinaryTreeNode object. + * @returns The function `getPathToRoot` returns an array of `N` objects, representing the path from + * the given `node` to the root of the binary tree. + */ + getPathToRoot(node: N): N[] { + const result: N[] = []; + while (node.parent) { + result.unshift(node); + node = node.parent; + } + result.unshift(node); + return result; + } + + getLeftMost(): N | null; + + getLeftMost(node: N): N; + + /** + * The `getLeftMost` function returns the leftmost node in a binary tree, either recursively or iteratively using tail + * recursion optimization. + * @param {N | null} [node] - The `node` parameter is an optional parameter of type `N + * | null`. It represents the starting node from which to find the leftmost node in a binary tree. If no node is + * provided, the function will use the root node of the binary tree. + * @returns The `getLeftMost` function returns the leftmost node in a binary tree. + */ + getLeftMost(node?: N | null): N | null { + node = node ?? this.root; + if (!node) return node; + + if (this._loopType === LoopType.recursive) { + + const _traverse = (cur: N): N => { + if (!cur.left) return cur; + return _traverse(cur.left); + } + + return _traverse(node); + } else { + // Indirect implementation of iteration using tail recursion optimization + const _traverse = trampoline((cur: N) => { + if (!cur.left) return cur; + return _traverse.cont(cur.left); + }); + + return _traverse(node); + } + } + + getRightMost(): N | null; + + getRightMost(node: N): N; + + /** + * The `getRightMost` function returns the rightmost node in a binary tree, either recursively or iteratively using + * tail recursion optimization. + * @param {N | null} [node] - The `node` parameter is an optional parameter of type `N + * | null`. It represents the starting node from which to find the rightmost node in a binary tree. If no node is + * provided, the function will use the root node of the binary tree. + * @returns The `getRightMost` function returns the rightmost node in a binary tree. + */ + getRightMost(node?: N | null): N | null { + node = node ?? this.root; + if (!node) return node; + + if (this._loopType === LoopType.recursive) { + const _traverse = (cur: N): N => { + if (!cur.right) return cur; + return _traverse(cur.right); + } + + return _traverse(node); + } else { + // Indirect implementation of iteration using tail recursion optimization + const _traverse = trampoline((cur: N) => { + if (!cur.right) return cur; + return _traverse.cont(cur.right); + }); + + return _traverse(node); + } + } + + /** + * The `isBST` function checks if a binary tree is a binary search tree. + * @param {N | null} [node] - The `node` parameter is an optional parameter of type `N + * | null`. It represents the root node of the binary search tree (BST) that we want to check for validity. If no node + * is provided, the function will default to using the root node of the BST instance that + * @returns The `isBST` function returns a boolean value. It returns `true` if the binary tree is a valid binary search + * tree, and `false` otherwise. + */ + isBST(node?: N | null): boolean { + node = node ?? this.root; + if (!node) return true; + + if (this._loopType === LoopType.recursive) { + const dfs = (cur: N | null | undefined, min: BinaryTreeNodeId, max: BinaryTreeNodeId): boolean => { + if (!cur) return true; + if (cur.id <= min || cur.id >= max) return false; + return dfs(cur.left, min, cur.id) && dfs(cur.right, cur.id, max); + } + + return dfs(node, Number.MIN_SAFE_INTEGER, Number.MAX_SAFE_INTEGER); + } else { + const stack = []; + let prev = Number.MIN_SAFE_INTEGER, curr: N | null | undefined = node; + while (curr || stack.length > 0) { + while (curr) { + stack.push(curr); + curr = curr.left; + } + curr = stack.pop()!; + if (!(curr) || prev >= curr.id) return false; + prev = curr.id; + curr = curr.right; + } + return true; + } + } + + /** + * The function calculates the size and count of a subtree in a binary tree using either recursive or iterative + * traversal. + * @param {N | null | undefined} subTreeRoot - The `subTreeRoot` parameter is the root node of a binary + * tree. + * @returns The function `getSubTreeSizeAndCount` returns an array `[number, number]`. The first element of the array + * represents the size of the subtree, and the second element represents the count of the nodes in the subtree. + */ + getSubTreeSizeAndCount(subTreeRoot: N | null | undefined) { + const res: [number, number] = [0, 0]; + if (!subTreeRoot) return res; + + if (this._loopType === LoopType.recursive) { + const _traverse = (cur: N) => { + res[0]++; + res[1] += cur.count; + cur.left && _traverse(cur.left); + cur.right && _traverse(cur.right); + } + + _traverse(subTreeRoot); + return res; + } else { + const stack: N[] = [subTreeRoot]; + + while (stack.length > 0) { + const cur = stack.pop()!; + res[0]++; + res[1] += cur.count; + cur.right && stack.push(cur.right); + cur.left && stack.push(cur.left); + } + + return res; + } + } + + // --- start additional methods --- + + /** + * The function `subTreeSum` calculates the sum of a specified property in a binary tree, either recursively or + * iteratively. + * @param subTreeRoot - The subTreeRoot parameter is the root node of the subtree for which you want to calculate the + * sum. + * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that + * specifies the property of the `BinaryTreeNode` object to use for calculating the sum. If `propertyName` is not + * provided, it defaults to `'val'`. + * @returns a number, which is the sum of the values of the nodes in the subtree rooted at `subTreeRoot`. + */ + subTreeSum(subTreeRoot: N, propertyName ?: BinaryTreeNodePropertyName): number { + propertyName = propertyName ?? 'id'; + if (!subTreeRoot) return 0; + + let sum = 0; + + const _sumByProperty = (cur: N) => { + let needSum: number; + switch (propertyName) { + case 'id': + needSum = cur.id; + break; + case 'count': + needSum = cur.count; + break; + case 'val': + needSum = typeof cur.val === 'number' ? cur.val : 0; + break; + default: + needSum = cur.id; + break; + } + return needSum; + } + + if (this._loopType === LoopType.recursive) { + const _traverse = (cur: N): void => { + sum += _sumByProperty(cur); + cur.left && _traverse(cur.left); + cur.right && _traverse(cur.right); + } + + _traverse(subTreeRoot); + } else { + const stack: N[] = [subTreeRoot]; + + while (stack.length > 0) { + const cur = stack.pop()!; + sum += _sumByProperty(cur); + cur.right && stack.push(cur.right); + cur.left && stack.push(cur.left); + } + } + + return sum; + } + + /** + * The function `subTreeAdd` adds a specified delta value to a property of each node in a binary tree. + * @param subTreeRoot - The `subTreeRoot` parameter is the root node of the subtree where the values will be modified. + * @param {number} delta - The `delta` parameter is a number that represents the amount by which the property value of + * each node in the subtree should be increased or decreased. + * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that + * specifies the property of the `BinaryTreeNode` that should be modified. It defaults to `'id'` if not provided. + * @returns a boolean value, which is `true`. + */ + subTreeAdd(subTreeRoot: N, delta: number, propertyName ?: BinaryTreeNodePropertyName): boolean { + propertyName = propertyName ?? 'id'; + if (!subTreeRoot) return false; + + const _addByProperty = (cur: N) => { + switch (propertyName) { + case 'id': + cur.id += delta; + break; + case 'count': + cur.count += delta; + this._setCount(this.count + delta); + break; + default: + cur.id += delta; + break; + } + } + + if (this._loopType === LoopType.recursive) { + const _traverse = (cur: N) => { + _addByProperty(cur); + cur.left && _traverse(cur.left); + cur.right && _traverse(cur.right); + }; + + _traverse(subTreeRoot); + } else { + const stack: N[] = [subTreeRoot]; + + while (stack.length > 0) { + const cur = stack.pop()!; + + _addByProperty(cur); + cur.right && stack.push(cur.right); + cur.left && stack.push(cur.left); + } + } + return true; + } + + BFS(): BinaryTreeNodeId[]; + + BFS(nodeOrPropertyName: 'id'): BinaryTreeNodeId[]; + + BFS(nodeOrPropertyName: 'val'): N['val'][]; + + BFS(nodeOrPropertyName: 'node'): N[]; + + BFS(nodeOrPropertyName: 'count'): number[]; + + /** + * The BFS function performs a breadth-first search on a binary tree and returns the results based on a specified node + * or property name. + * @param {NodeOrPropertyName} [nodeOrPropertyName] - The parameter `nodeOrPropertyName` is an optional parameter that + * represents either a node or a property name. If a node is provided, the breadth-first search algorithm will be + * performed starting from that node. If a property name is provided, the breadth-first search algorithm will be + * performed starting from the root node + * @returns an object of type `ResultsByProperty`. + */ + BFS(nodeOrPropertyName ?: NodeOrPropertyName): ResultsByProperty { + nodeOrPropertyName = nodeOrPropertyName ?? 'id'; + this._resetResults(); + const queue: Array = [this.root]; + + while (queue.length !== 0) { + const cur = queue.shift(); + if (cur) { + this._accumulatedByPropertyName(cur, nodeOrPropertyName); + if (cur?.left !== null) queue.push(cur.left); + if (cur?.right !== null) queue.push(cur.right); + } + } + + return this._getResultByPropertyName(nodeOrPropertyName); + } + + DFS(): BinaryTreeNodeId[]; + + DFS(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'id'): BinaryTreeNodeId[]; + + DFS(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'val'): N[]; + + DFS(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'node'): N[]; + + DFS(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'count'): number[]; + + /** + * The DFS function performs a depth-first search traversal on a binary tree and returns the results based on the + * specified pattern and node or property name. + * @param {'in' | 'pre' | 'post'} [pattern] - The "pattern" parameter is used to specify the order in which the nodes + * of a binary tree are traversed during the Depth-First Search (DFS) algorithm. It can take one of three values: 'in', + * 'pre', or 'post'. + * @param {NodeOrPropertyName} [nodeOrPropertyName] - The `nodeOrPropertyName` parameter is a string that represents + * either the name of a property in the `BinaryTreeNode` object or the value of the `id` property in the + * `BinaryTreeNode` object. This parameter is used to accumulate the results based on the specified property name. If + * no value + * @returns an object of type `ResultsByProperty`. + */ + DFS(pattern ?: 'in' | 'pre' | 'post', nodeOrPropertyName ?: NodeOrPropertyName): ResultsByProperty { + pattern = pattern ?? 'in'; + nodeOrPropertyName = nodeOrPropertyName ?? 'id'; + this._resetResults(); + const _traverse = (node: N) => { + switch (pattern) { + case 'in': + if (node.left) _traverse(node.left); + this._accumulatedByPropertyName(node, nodeOrPropertyName); + if (node.right) _traverse(node.right); + break; + case 'pre': + this._accumulatedByPropertyName(node, nodeOrPropertyName); + if (node.left) _traverse(node.left); + if (node.right) _traverse(node.right); + break; + case 'post': + if (node.left) _traverse(node.left); + if (node.right) _traverse(node.right); + this._accumulatedByPropertyName(node, nodeOrPropertyName); + break; + } + }; + + this.root && _traverse(this.root); + return this._getResultByPropertyName(nodeOrPropertyName); + } + + DFSIterative(): BinaryTreeNodeId[]; + + DFSIterative(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'id'): BinaryTreeNodeId[]; + + DFSIterative(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'val'): N[]; + + DFSIterative(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'node'): N[]; + + DFSIterative(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'count'): number[]; + + /** + * Time complexity is O(n) + * Space complexity of Iterative DFS equals to recursive DFS which is O(n) because of the stack + * @param pattern + * @param nodeOrPropertyName + * @constructor + */ + DFSIterative(pattern ?: 'in' | 'pre' | 'post', nodeOrPropertyName ?: NodeOrPropertyName): ResultsByProperty { + pattern = pattern || 'in'; + nodeOrPropertyName = nodeOrPropertyName || 'id'; + this._resetResults(); + if (!this.root) return this._getResultByPropertyName(nodeOrPropertyName); + // 0: visit, 1: print + const stack: { opt: 0 | 1, node: N | null | undefined }[] = [{opt: 0, node: this.root}]; + + while (stack.length > 0) { + const cur = stack.pop(); + if (!cur || !cur.node) continue; + if (cur.opt === 1) { + this._accumulatedByPropertyName(cur.node, nodeOrPropertyName); + } else { + switch (pattern) { + case 'in': + stack.push({opt: 0, node: cur.node.right}); + stack.push({opt: 1, node: cur.node}); + stack.push({opt: 0, node: cur.node.left}); + break; + case 'pre': + stack.push({opt: 0, node: cur.node.right}); + stack.push({opt: 0, node: cur.node.left}); + stack.push({opt: 1, node: cur.node}); + break; + case 'post': + stack.push({opt: 1, node: cur.node}); + stack.push({opt: 0, node: cur.node.right}); + stack.push({opt: 0, node: cur.node.left}); + break; + default: + stack.push({opt: 0, node: cur.node.right}); + stack.push({opt: 1, node: cur.node}); + stack.push({opt: 0, node: cur.node.left}); + break; + } + } + } + + return this._getResultByPropertyName(nodeOrPropertyName); + } + + levelIterative(node: N | null): BinaryTreeNodeId[]; + + levelIterative(node: N | null, nodeOrPropertyName?: 'id'): BinaryTreeNodeId[]; + + levelIterative(node: N | null, nodeOrPropertyName?: 'val'): N['val'][]; + + levelIterative(node: N | null, nodeOrPropertyName?: 'node'): N[]; + + levelIterative(node: N | null, nodeOrPropertyName?: 'count'): number[]; + + /** + * The `levelIterative` function performs a level-order traversal on a binary tree and returns the values of the nodes + * in an array, based on a specified property name. + * @param {N | null} node - The `node` parameter is a BinaryTreeNode object representing the starting + * node for the level order traversal. It can be null if no specific node is provided, in which case the root node of + * the tree is used as the starting node. + * @param {NodeOrPropertyName} [nodeOrPropertyName] - The `nodeOrPropertyName` parameter is an optional parameter that + * can be either a `BinaryTreeNode` property name or the string `'id'`. If a property name is provided, the function + * will accumulate results based on that property. If no property name is provided, the function will default to + * accumulating results + * @returns The function `levelIterative` returns an object of type `ResultsByProperty`. + */ + levelIterative(node: N | null, nodeOrPropertyName ?: NodeOrPropertyName): ResultsByProperty { + nodeOrPropertyName = nodeOrPropertyName || 'id'; + node = node || this.root; + if (!node) return []; + + this._resetResults(); + const queue: N[] = [node]; + + while (queue.length > 0) { + const cur = queue.shift(); + if (cur) { + this._accumulatedByPropertyName(cur, nodeOrPropertyName); + if (cur.left) { + queue.push(cur.left); + } + if (cur.right) { + queue.push(cur.right); + } + } + } + + return this._getResultByPropertyName(nodeOrPropertyName); + } + + listLevels(node: N | null): BinaryTreeNodeId[][]; + + listLevels(node: N | null, nodeOrPropertyName?: 'id'): BinaryTreeNodeId[][]; + + listLevels(node: N | null, nodeOrPropertyName?: 'val'): N['val'][][]; + + listLevels(node: N | null, nodeOrPropertyName?: 'node'): N[][]; + + listLevels(node: N | null, nodeOrPropertyName?: 'count'): number[][]; + + /** + * The `listLevels` function collects nodes from a binary tree by a specified property and organizes them into levels. + * @param {N | null} node - The `node` parameter is a BinaryTreeNode object or null. It represents the + * root node of a binary tree. If it is null, the function will use the root node of the current binary tree instance. + * @param {NodeOrPropertyName} [nodeOrPropertyName] - The `nodeOrPropertyName` parameter is an optional parameter that + * specifies the property of the `BinaryTreeNode` object to collect at each level. It can be one of the following + * values: + * @returns The function `listLevels` returns a 2D array of `ResultByProperty` objects. + */ + listLevels(node: N | null, nodeOrPropertyName?: NodeOrPropertyName): ResultByProperty[][] { + nodeOrPropertyName = nodeOrPropertyName || 'id'; + node = node || this.root; + if (!node) return []; + + const levelsNodes: ResultByProperty[][] = []; + + const collectByProperty = (node: N, level: number) => { + switch (nodeOrPropertyName) { + case 'id': + levelsNodes[level].push(node.id); + break; + case 'val': + levelsNodes[level].push(node.val); + break; + case 'node': + levelsNodes[level].push(node); + break; + case 'count': + levelsNodes[level].push(node.count); + break; + default: + levelsNodes[level].push(node.id); + break; + } + } + + if (this._loopType === LoopType.recursive) { + const _recursive = (node: N, level: number) => { + if (!levelsNodes[level]) levelsNodes[level] = []; + collectByProperty(node, level); + if (node.left) _recursive(node.left, level + 1); + if (node.right) _recursive(node.right, level + 1); + }; + + _recursive(node, 0); + } else { + const stack: [N, number][] = [[node, 0]]; + + while (stack.length > 0) { + const head = stack.pop()!; + const [node, level] = head; + + if (!levelsNodes[level]) levelsNodes[level] = []; + collectByProperty(node, level); + if (node.right) stack.push([node.right, level + 1]); + if (node.left) stack.push([node.left, level + 1]); + } + } + + return levelsNodes; + } + + /** + * The function returns the predecessor of a given node in a binary tree. + * @param node - The parameter `node` is a BinaryTreeNode object, representing a node in a binary tree. + * @returns the predecessor of the given node in a binary tree. + */ + getPredecessor(node: N): N { + if (node.left) { + let predecessor: N | null | undefined = node.left; + while (!(predecessor) || predecessor.right && predecessor.right !== node) { + if (predecessor) { + predecessor = predecessor.right; + } + } + return predecessor; + } else { + return node; + } + } + + morris(): BinaryTreeNodeId[]; + + morris(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'id'): BinaryTreeNodeId[]; + + morris(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'val'): N[]; + + morris(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'node'): N[]; + + morris(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'count'): number[]; + + /** + * The `morris` function performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris + * traversal algorithm and returns the results based on the specified property name. + * The time complexity of Morris traversal is O(n), it's may slower than others + * The space complexity Morris traversal is O(1) because no using stack + * @param {'in' | 'pre' | 'post'} [pattern] - The `pattern` parameter is an optional parameter that determines the + * traversal pattern of the binary tree. It can have one of three values: + * @param {NodeOrPropertyName} [nodeOrPropertyName] - The `nodeOrPropertyName` parameter is used to specify the + * property of the nodes that you want to retrieve in the results. It can be either the node itself or the name of the + * property. If not provided, it defaults to `'id'`. + * @returns The function `morris` returns an object of type `ResultsByProperty`. + */ + morris(pattern?: 'in' | 'pre' | 'post', nodeOrPropertyName?: NodeOrPropertyName): ResultsByProperty { + if (this.root === null) return []; + + pattern = pattern || 'in'; + nodeOrPropertyName = nodeOrPropertyName || 'id'; + + this._resetResults(); + + let cur: N | null | undefined = this.root; + const _reverseEdge = (node: N | null | undefined) => { + let pre: N | null | undefined = null; + let next: N | null | undefined = null; + while (node) { + next = node.right; + node.right = pre; + pre = node; + node = next; + } + return pre; + }; + const _printEdge = (node: N | null) => { + const tail: N | null | undefined = _reverseEdge(node); + let cur: N | null | undefined = tail; + while (cur) { + this._accumulatedByPropertyName(cur, nodeOrPropertyName); + cur = cur.right; + } + _reverseEdge(tail); + }; + switch (pattern) { + case 'in': + while (cur) { + if (cur.left) { + const predecessor = this.getPredecessor(cur); + if (!predecessor.right) { + predecessor.right = cur; + cur = cur.left; + continue; + } else { + predecessor.right = null; + } + } + this._accumulatedByPropertyName(cur, nodeOrPropertyName); + cur = cur.right; + } + break; + case 'pre': + while (cur) { + if (cur.left) { + const predecessor = this.getPredecessor(cur); + if (!predecessor.right) { + predecessor.right = cur; + this._accumulatedByPropertyName(cur, nodeOrPropertyName); + cur = cur.left; + continue; + } else { + predecessor.right = null; + } + } else { + this._accumulatedByPropertyName(cur, nodeOrPropertyName); + } + cur = cur.right; + } + break; + case 'post': + while (cur) { + if (cur.left) { + const predecessor = this.getPredecessor(cur); + if (predecessor.right === null) { + predecessor.right = cur; + cur = cur.left; + continue; + } else { + predecessor.right = null; + _printEdge(cur.left); + } + } + cur = cur.right; + } + _printEdge(this.root); + break; + } + + return this._getResultByPropertyName(nodeOrPropertyName); + } + + protected _setLoopType(value: LoopType) { + this._loopType = value; + } + + protected _setVisitedId(value: BinaryTreeNodeId[]) { + this._visitedId = value; + } + + protected _setVisitedVal(value: Array) { + this._visitedVal = value; + } + + protected _setVisitedNode(value: N[]) { + this._visitedNode = value; + } + + protected setVisitedCount(value: number[]) { + this._visitedCount = value; + } + + protected _setVisitedLeftSum(value: number[]) { + this._visitedLeftSum = value; + } + + protected _setAutoIncrementId(value: boolean) { + this._autoIncrementId = value; + } + + protected _setMaxId(value: number) { + this._maxId = value; + } + + protected _setIsDuplicatedVal(value: boolean) { + this._isDuplicatedVal = value; + } + + protected _setRoot(v: N | null) { + if (v) { + v.parent = null; + v.familyPosition = FamilyPosition.root; + } + this._root = v; + } + + protected _setSize(v: number) { + this._size = v; + } + + protected _setCount(v: number) { + this._count = v; + } + + /** + * The function resets the values of several arrays used for tracking visited nodes and their properties. + */ + protected _resetResults() { + this._visitedId = []; + this._visitedVal = []; + this._visitedNode = []; + this._visitedCount = []; + this._visitedLeftSum = []; + } + + /** + * The function checks if a given property of a binary tree node matches a specified value, and if so, adds the node to + * a result array. + * @param cur - The current binary tree node that is being checked. + * @param {(N | null | undefined)[]} result - An array that stores the matching nodes found during the + * traversal. + * @param {BinaryTreeNodeId | N} nodeProperty - The `nodeProperty` parameter is the value that we are searching for in + * the binary tree nodes. It can be either the `id`, `count`, or `val` property of the node. + * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that + * specifies the property of the `BinaryTreeNode` object that you want to compare with the `nodeProperty` value. It can + * be one of the following values: 'id', 'count', or 'val'. If no `propertyName` is provided, + * @param {boolean} [onlyOne] - The `onlyOne` parameter is an optional boolean parameter that determines whether to + * stop after finding the first matching node or continue searching for all matching nodes. If `onlyOne` is set to + * `true`, the function will stop after finding the first matching node and return `true`. If `onlyOne + * @returns a boolean value indicating whether or not a node was pushed into the result array. + */ + protected _pushByPropertyNameStopOrNot(cur: N, result: (N | null | undefined)[], nodeProperty: BinaryTreeNodeId | N, propertyName ?: BinaryTreeNodePropertyName, onlyOne ?: boolean) { + switch (propertyName) { + case 'id': + if (cur.id === nodeProperty) { + result.push(cur); + return !!onlyOne; + } + break; + case 'count': + if (cur.count === nodeProperty) { + result.push(cur); + return !!onlyOne; + } + break; + case 'val': + if (cur.val === nodeProperty) { + result.push(cur); + return !!onlyOne; + } + break; + default: + if (cur.id === nodeProperty) { + result.push(cur); + return !!onlyOne; + } + break; + } + } + + /** + * The function `_accumulatedByPropertyName` pushes a property value of a binary tree node into an array based on the + * provided property name or a default property name. + * @param node - The `node` parameter is of type `N`, which represents a node in a binary tree. + * @param {NodeOrPropertyName} [nodeOrPropertyName] - The parameter `nodeOrPropertyName` is an optional parameter that + * can be either a string representing a property name or a reference to a node object. If it is a string, it specifies + * the property name of the node that should be accumulated. If it is a node object, it specifies the node itself + */ + protected _accumulatedByPropertyName(node: N, nodeOrPropertyName ?: NodeOrPropertyName) { + nodeOrPropertyName = nodeOrPropertyName ?? 'id'; + + switch (nodeOrPropertyName) { + case 'id': + this._visitedId.push(node.id); + break; + case 'val': + this._visitedVal.push(node.val); + break; + case 'node': + this._visitedNode.push(node); + break; + case 'count': + this._visitedCount.push(node.count); + break; + default: + this._visitedId.push(node.id); + break; + } + } + + /** + * The function `_getResultByPropertyName` returns different results based on the provided property name or defaulting + * to 'id'. + * @param {NodeOrPropertyName} [nodeOrPropertyName] - The parameter `nodeOrPropertyName` is an optional parameter that + * can accept a value of type `NodeOrPropertyName`. + * @returns The method returns an object of type `ResultsByProperty`. + */ + protected _getResultByPropertyName(nodeOrPropertyName ?: NodeOrPropertyName): ResultsByProperty { + nodeOrPropertyName = nodeOrPropertyName ?? 'id'; + + switch (nodeOrPropertyName) { + case 'id': + return this._visitedId; + case 'val': + return this._visitedVal; + case 'node': + return this._visitedNode; + case 'count': + return this._visitedCount; + default: + return this._visitedId; + } + } + + // --- end additional methods --- +} \ No newline at end of file diff --git a/src/data-structures/binary-tree/avl-tree.ts b/src/data-structures/binary-tree/avl-tree.ts index 7c5953d..0b95185 100644 --- a/src/data-structures/binary-tree/avl-tree.ts +++ b/src/data-structures/binary-tree/avl-tree.ts @@ -6,7 +6,7 @@ * @license MIT License */ import {BST, BSTNode} from './bst'; -import type {AVLTreeDeleted, BinaryTreeNodeId, RecursiveAVLTreeNode} from '../types'; +import type {AVLTreeDeleted, AVLTreeOptions, BinaryTreeNodeId, RecursiveAVLTreeNode} from '../types'; import {IBinaryTreeNode} from '../interfaces'; @@ -15,6 +15,9 @@ export class AVLTreeNode = RecursiveAVL } export class AVLTree = AVLTreeNode> extends BST { + constructor(options?: AVLTreeOptions) { + super(options); + } override _createNode(id: BinaryTreeNodeId, val: N['val'], count?: number): N { const node = new AVLTreeNode(id, val, count); diff --git a/src/data-structures/binary-tree/binary-tree.ts b/src/data-structures/binary-tree/binary-tree.ts index 606a3c9..ad5e36b 100644 --- a/src/data-structures/binary-tree/binary-tree.ts +++ b/src/data-structures/binary-tree/binary-tree.ts @@ -12,23 +12,15 @@ import type { BinaryTreeNodeId, BinaryTreeNodePropertyName, DFSOrderPattern, + KeyValObject, NodeOrPropertyName, RecursiveBinaryTreeNode, ResultByProperty, ResultsByProperty } from '../types'; +import {BinaryTreeOptions, FamilyPosition, LoopType} from '../types'; import {IBinaryTree, IBinaryTreeNode} from '../interfaces'; -/* This enumeration defines the position of a node within a family tree composed of three associated nodes, where 'root' represents the root node of the family tree, 'left' represents the left child node, and 'right' represents the right child node. */ -export enum FamilyPosition {root, left, right} - -/** - * Enum representing different loop types. - * - * - `iterative`: Indicates the iterative loop type (with loops that use iterations). - * - `recursive`: Indicates the recursive loop type (with loops that call themselves). - */ -export enum LoopType { iterative = 1, recursive = 2} export class BinaryTreeNode = RecursiveBinaryTreeNode> implements IBinaryTreeNode { @@ -163,11 +155,7 @@ export class BinaryTree = BinaryTreeNode = BinaryTreeNode { @@ -314,12 +302,12 @@ export class BinaryTree = BinaryTreeNode = BinaryTreeNode = BinaryTreeNode = BinaryTreeNode = RecursiveBSTNode> extends BinaryTreeNode implements IBinaryTreeNode { } @@ -26,10 +25,7 @@ export class BST = BSTNode> extends Binar * The constructor function accepts an optional options object and sets the comparator property if provided. * @param [options] - An optional object that can contain the following properties: */ - constructor(options?: { - comparator?: BSTComparator, - loopType?: LoopType - }) { + constructor(options?: BSTOptions) { super(options); if (options !== undefined) { const {comparator} = options; diff --git a/src/data-structures/binary-tree/index.ts b/src/data-structures/binary-tree/index.ts index 43fa442..8b20023 100644 --- a/src/data-structures/binary-tree/index.ts +++ b/src/data-structures/binary-tree/index.ts @@ -1,3 +1,4 @@ +// export * from './abstract-binary-tree'; export * from './binary-tree'; export * from './bst'; export * from './binary-indexed-tree'; diff --git a/src/data-structures/binary-tree/rb-tree.ts b/src/data-structures/binary-tree/rb-tree.ts index dedf8e6..5e09186 100644 --- a/src/data-structures/binary-tree/rb-tree.ts +++ b/src/data-structures/binary-tree/rb-tree.ts @@ -1,5 +1,6 @@ -import {BinaryTree, BinaryTreeNode, LoopType} from './binary-tree'; +import {BinaryTree, BinaryTreeNode} from './binary-tree'; import {IBinaryTree, IBinaryTreeNode} from '../interfaces'; +import {LoopType} from '../types'; enum RBColor { Red, Black } diff --git a/src/data-structures/graph/directed-graph.ts b/src/data-structures/graph/directed-graph.ts index 6379e4c..bebbecc 100644 --- a/src/data-structures/graph/directed-graph.ts +++ b/src/data-structures/graph/directed-graph.ts @@ -74,14 +74,10 @@ export class DirectedEdge extends AbstractEdge { } // Strongly connected, One direction connected, Weakly connected -export class DirectedGraph, E extends DirectedEdge> extends AbstractGraph implements IDirectedGraph { - private readonly _vertexConstructor: new (id: VertexId, val?: V['val']) => V; - private readonly _edgeConstructor: new (src: VertexId, dest: VertexId, weight?: number, val?: E['val']) => E; +export class DirectedGraph = DirectedVertex, E extends DirectedEdge = DirectedEdge> extends AbstractGraph implements IDirectedGraph { - constructor(vertexConstructor: new (id: VertexId, val?: V['val']) => V, edgeConstructor: new (src: VertexId, dest: VertexId, weight?: number, val?: E['val']) => E) { + constructor() { super(); - this._vertexConstructor = vertexConstructor; - this._edgeConstructor = edgeConstructor; } private _outEdgeMap: Map = new Map(); @@ -103,7 +99,7 @@ export class DirectedGraph, E extends DirectedEdge * @param val */ _createVertex(id: VertexId, val?: V['val']): V { - return new this._vertexConstructor(id, val); + return new DirectedVertex(id, val ?? id) as V; } /** @@ -115,8 +111,7 @@ export class DirectedGraph, E extends DirectedEdge * @param val */ _createEdge(src: VertexId, dest: VertexId, weight?: number, val?: E['val']): E { - if (weight === undefined || weight === null) weight = 1; - return new this._edgeConstructor(src, dest, weight, val); + return new DirectedEdge(src, dest, weight ?? 1, val) as E; } /** diff --git a/src/data-structures/graph/undirected-graph.ts b/src/data-structures/graph/undirected-graph.ts index 2d448da..a556550 100644 --- a/src/data-structures/graph/undirected-graph.ts +++ b/src/data-structures/graph/undirected-graph.ts @@ -58,15 +58,10 @@ export class UndirectedEdge extends AbstractEdge { // } } -export class UndirectedGraph, E extends UndirectedEdge> extends AbstractGraph { +export class UndirectedGraph = UndirectedVertex, E extends UndirectedEdge = UndirectedEdge> extends AbstractGraph { - private readonly _vertexConstructor: new (id: VertexId, val?: V['val']) => V; - private readonly _edgeConstructor: new (src: VertexId, dest: VertexId, weight?: number, val?: E['val']) => E; - - constructor(vertexConstructor: new (id: VertexId, val?: V['val']) => V, edgeConstructor: new (src: VertexId, dest: VertexId, weight?: number, val?: E['val']) => E) { + constructor() { super(); - this._vertexConstructor = vertexConstructor; - this._edgeConstructor = edgeConstructor; this._edges = new Map(); } @@ -83,20 +78,24 @@ export class UndirectedGraph, E extends Undirect * @param val */ _createVertex(id: VertexId, val?: V['val']): V { - return new this._vertexConstructor(id, val); + return new UndirectedVertex(id, val ?? id) as V; } + /** - * In TypeScript, a subclass inherits the interface implementation of its parent class, without needing to implement the same interface again in the subclass. This behavior differs from Java's approach. In Java, if a parent class implements an interface, the subclass needs to explicitly implement the same interface, even if the parent class has already implemented it. - * This means that using abstract methods in the parent class cannot constrain the grandchild classes. Defining methods within an interface also cannot constrain the descendant classes. When inheriting from this class, developers need to be aware that this method needs to be overridden. - * @param src - * @param dest - * @param weight - * @param val + * The function _createEdge creates an undirected edge between two vertices with an optional weight and value. + * @param {VertexId} v1 - The parameter `v1` represents the first vertex of the edge. It is of type `VertexId`, which + * could be a unique identifier or label for the vertex. + * @param {VertexId} v2 - The parameter `v2` represents the second vertex of the edge. It is of type `VertexId`, which + * is typically a unique identifier for a vertex in a graph. + * @param {number} [weight] - The weight parameter is an optional number that represents the weight of the edge. If no + * weight is provided, the default value is 1. + * @param [val] - The `val` parameter is an optional value that can be assigned to the edge. It can be of any type and + * is used to store additional information or data associated with the edge. + * @returns an instance of the UndirectedEdge class, casted as type E. */ - _createEdge(src: VertexId, dest: VertexId, weight?: number, val?: E['val']): E { - if (weight === undefined || weight === null) weight = 1; - return new this._edgeConstructor(src, dest, weight, val); + _createEdge(v1: VertexId, v2: VertexId, weight?: number, val?: E['val']): E { + return new UndirectedEdge(v1, v2, weight ?? 1, val) as E; } /** diff --git a/src/data-structures/interfaces/binary-tree.ts b/src/data-structures/interfaces/binary-tree.ts index cb464c1..c3c7e82 100644 --- a/src/data-structures/interfaces/binary-tree.ts +++ b/src/data-structures/interfaces/binary-tree.ts @@ -1,5 +1,4 @@ -import {BinaryTreeNodeId} from '../types'; -import {FamilyPosition} from '../binary-tree'; +import {BinaryTreeNodeId, FamilyPosition} from '../types'; export interface IBinaryTreeNode> { _createNode(id: BinaryTreeNodeId, val: T | null, count?: number): FAMILY | null; diff --git a/src/data-structures/types/abstract-binary-tree.ts b/src/data-structures/types/abstract-binary-tree.ts new file mode 100644 index 0000000..b1b9e67 --- /dev/null +++ b/src/data-structures/types/abstract-binary-tree.ts @@ -0,0 +1,14 @@ +import {AbstractBinaryTreeNode} from '../binary-tree/abstract-binary-tree'; + +/** + * Enum representing different loop types. + * + * - `iterative`: Indicates the iterative loop type (with loops that use iterations). + * - `recursive`: Indicates the recursive loop type (with loops that call themselves). + */ +export enum LoopType { iterative = 1, recursive = 2} + +/* This enumeration defines the position of a node within a family tree composed of three associated nodes, where 'root' represents the root node of the family tree, 'left' represents the left child node, and 'right' represents the right child node. */ +export enum FamilyPosition {root, left, right} + +export type RecursiveAbstractBinaryTreeNode = AbstractBinaryTreeNode>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> diff --git a/src/data-structures/types/avl-tree.ts b/src/data-structures/types/avl-tree.ts index 9c69860..c3da3b4 100644 --- a/src/data-structures/types/avl-tree.ts +++ b/src/data-structures/types/avl-tree.ts @@ -1,4 +1,5 @@ import {AVLTreeNode} from '../binary-tree'; +import {BSTOptions} from './bst'; export type AVLTreeDeleted = { deleted: N | null; @@ -6,3 +7,4 @@ export type AVLTreeDeleted = { } export type RecursiveAVLTreeNode = AVLTreeNode>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> +export type AVLTreeOptions = BSTOptions & {}; \ No newline at end of file diff --git a/src/data-structures/types/binary-tree.ts b/src/data-structures/types/binary-tree.ts index 562c5f3..cd2b078 100644 --- a/src/data-structures/types/binary-tree.ts +++ b/src/data-structures/types/binary-tree.ts @@ -1,4 +1,5 @@ import {BinaryTreeNode} from '../binary-tree'; +import {LoopType} from './abstract-binary-tree'; export type BinaryTreeNodePropertyName = 'id' | 'val' | 'count'; export type NodeOrPropertyName = 'node' | BinaryTreeNodePropertyName; @@ -8,3 +9,8 @@ export type BinaryTreeDeleted = { deleted: N | null | undefined, needBalanced export type ResultByProperty> = N['val'] | N | number | BinaryTreeNodeId; export type ResultsByProperty> = ResultByProperty[]; export type RecursiveBinaryTreeNode = BinaryTreeNode>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> +export type BinaryTreeOptions = { + loopType?: LoopType, + autoIncrementId?: boolean, + isDuplicatedVal?: boolean +} \ No newline at end of file diff --git a/src/data-structures/types/bst.ts b/src/data-structures/types/bst.ts index ac03bf8..89f59c2 100644 --- a/src/data-structures/types/bst.ts +++ b/src/data-structures/types/bst.ts @@ -1,6 +1,11 @@ import {BSTNode} from '../binary-tree'; -import type {BinaryTreeNodeId} from './binary-tree'; +import type {BinaryTreeNodeId, BinaryTreeOptions} from './binary-tree'; export type BSTComparator = (a: BinaryTreeNodeId, b: BinaryTreeNodeId) => number; export type BSTDeletedResult> = { deleted: N | null, needBalanced: N | null }; export type RecursiveBSTNode = BSTNode>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> +export type BSTOptions = BinaryTreeOptions & { + comparator?: BSTComparator, +} + +export enum CP {lt = 'lt', eq = 'eq', gt = 'gt'} \ No newline at end of file diff --git a/src/data-structures/types/helpers.ts b/src/data-structures/types/helpers.ts new file mode 100644 index 0000000..70d502f --- /dev/null +++ b/src/data-structures/types/helpers.ts @@ -0,0 +1,2 @@ +export type IdObject = { id: number; } & { [key: string]: any; }; +export type KeyValObject = { [key: string]: any }; \ No newline at end of file diff --git a/src/data-structures/types/index.ts b/src/data-structures/types/index.ts index 3a58bb1..0f589ce 100644 --- a/src/data-structures/types/index.ts +++ b/src/data-structures/types/index.ts @@ -4,9 +4,11 @@ export * from './avl-tree'; export * from './segment-tree'; export * from './tree-multiset'; export * from './abstract-graph'; +export * from './abstract-binary-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'; \ No newline at end of file +export * from './navigator'; +export * from './helpers'; \ No newline at end of file diff --git a/tests/unit/data-structures/binary-tree/bst.test.ts b/tests/unit/data-structures/binary-tree/bst.test.ts index 9cebc53..0f43e24 100644 --- a/tests/unit/data-structures/binary-tree/bst.test.ts +++ b/tests/unit/data-structures/binary-tree/bst.test.ts @@ -1,7 +1,7 @@ import {BST, BSTNode} from '../../../../src'; -describe('BST Case6', () => { - it('should perform various operations on a Binary Search Tree', () => { +describe('BST operations test', () => { + it('should perform various operations on a Binary Search Tree with numeric values', () => { const tree = new BST(); expect(tree).toBeInstanceOf(BST); @@ -190,4 +190,203 @@ describe('BST Case6', () => { expect(bfsNodes[1].id).toBe(12); expect(bfsNodes[2].id).toBe(16); }); + + it('should perform various operations on a Binary Search Tree with object values', () => { + const objBST = new BST>({autoIncrementId: false}); + expect(objBST).toBeInstanceOf(BST); + + const values = [{id: 11, keyA: 11}, {id: 3, keyA: 3}, {id: 15, keyA: 15}, {id: 1, keyA: 1}, { + id: 8, + keyA: 8 + }, {id: 13, keyA: 13}, {id: 16, keyA: 16}, {id: 2, keyA: 2}, {id: 6, keyA: 6}, {id: 9, keyA: 9}, { + id: 12, + keyA: 12 + }, {id: 14, keyA: 14}, {id: 4, keyA: 4}, {id: 7, keyA: 7}, {id: 10, keyA: 10}, {id: 5, keyA: 5}]; + + objBST.addMany(values); + + expect(objBST.root).toBeInstanceOf(BSTNode); + + if (objBST.root) expect(objBST.root.id).toBe(11); + + expect(objBST.count).toBe(16); + + expect(objBST.has(6)).toBe(true); + + const node6 = objBST.get(6); + expect(node6 && objBST.getHeight(node6)).toBe(2); + expect(node6 && objBST.getDepth(node6)).toBe(3); + + const nodeId10 = objBST.get(10, 'id'); + expect(nodeId10?.id).toBe(10); + + const nodeVal9 = objBST.get(9, 'id'); + expect(nodeVal9?.id).toBe(9); + + const nodesByCount1 = objBST.getNodes(1, 'count'); + expect(nodesByCount1.length).toBe(16); + + const leftMost = objBST.getLeftMost(); + expect(leftMost?.id).toBe(1); + + const node15 = objBST.get(15); + expect(node15?.val).toEqual({id: 15, keyA: 15}); + const minNodeBySpecificNode = node15 && objBST.getLeftMost(node15); + expect(minNodeBySpecificNode?.id).toBe(12); + + const subTreeSum = node15 && objBST.subTreeSum(node15); + expect(subTreeSum).toBe(70); + + const lesserSum = objBST.lesserSum(10); + expect(lesserSum).toBe(45); + + expect(node15).toBeInstanceOf(BSTNode); + if (node15 instanceof BSTNode) { + const subTreeAdd = objBST.subTreeAdd(node15, 1, 'count'); + expect(subTreeAdd).toBeDefined(); + } + + const node11 = objBST.get(11); + expect(node11).toBeInstanceOf(BSTNode); + if (node11 instanceof BSTNode) { + const allGreaterNodesAdded = objBST.allGreaterNodesAdd(node11, 2, 'count'); + expect(allGreaterNodesAdded).toBeDefined(); + } + + const dfsInorderNodes = objBST.DFS('in', 'node'); + expect(dfsInorderNodes[0].id).toBe(1); + expect(dfsInorderNodes[dfsInorderNodes.length - 1].id).toBe(16); + + objBST.balance(); + expect(objBST.isBalanced()).toBe(true); + + const bfsNodesAfterBalanced = objBST.BFS('node'); + expect(bfsNodesAfterBalanced[0].id).toBe(8); + expect(bfsNodesAfterBalanced[bfsNodesAfterBalanced.length - 1].id).toBe(16); + + const removed11 = objBST.remove(11, true); + expect(removed11).toBeInstanceOf(Array); + expect(removed11[0]).toBeDefined(); + expect(removed11[0].deleted).toBeDefined(); + + if (removed11[0].deleted) expect(removed11[0].deleted.id).toBe(11); + + expect(objBST.isAVLBalanced()).toBe(true); + + expect(node15 && objBST.getHeight(node15)).toBe(2); + + const removed1 = objBST.remove(1, true); + expect(removed1).toBeInstanceOf(Array); + expect(removed1[0]).toBeDefined(); + expect(removed1[0].deleted).toBeDefined(); + if (removed1[0].deleted) expect(removed1[0].deleted.id).toBe(1); + + expect(objBST.isAVLBalanced()).toBe(true); + + expect(objBST.getHeight()).toBe(4); + + const removed4 = objBST.remove(4, true); + expect(removed4).toBeInstanceOf(Array); + expect(removed4[0]).toBeDefined(); + expect(removed4[0].deleted).toBeDefined(); + if (removed4[0].deleted) expect(removed4[0].deleted.id).toBe(4); + expect(objBST.isAVLBalanced()).toBe(true); + expect(objBST.getHeight()).toBe(4); + + const removed10 = objBST.remove(10, true); + expect(removed10).toBeInstanceOf(Array); + expect(removed10[0]).toBeDefined(); + expect(removed10[0].deleted).toBeDefined(); + if (removed10[0].deleted) expect(removed10[0].deleted.id).toBe(10); + expect(objBST.isAVLBalanced()).toBe(false); + expect(objBST.getHeight()).toBe(4); + + const removed15 = objBST.remove(15, true); + expect(removed15).toBeInstanceOf(Array); + expect(removed15[0]).toBeDefined(); + expect(removed15[0].deleted).toBeDefined(); + if (removed15[0].deleted) expect(removed15[0].deleted.id).toBe(15); + + expect(objBST.isAVLBalanced()).toBe(true); + expect(objBST.getHeight()).toBe(3); + + const removed5 = objBST.remove(5, true); + expect(removed5).toBeInstanceOf(Array); + expect(removed5[0]).toBeDefined(); + expect(removed5[0].deleted).toBeDefined(); + if (removed5[0].deleted) expect(removed5[0].deleted.id).toBe(5); + + expect(objBST.isAVLBalanced()).toBe(true); + expect(objBST.getHeight()).toBe(3); + + const removed13 = objBST.remove(13, true); + expect(removed13).toBeInstanceOf(Array); + expect(removed13[0]).toBeDefined(); + expect(removed13[0].deleted).toBeDefined(); + if (removed13[0].deleted) expect(removed13[0].deleted.id).toBe(13); + expect(objBST.isAVLBalanced()).toBe(true); + expect(objBST.getHeight()).toBe(3); + + const removed3 = objBST.remove(3, true); + expect(removed3).toBeInstanceOf(Array); + expect(removed3[0]).toBeDefined(); + expect(removed3[0].deleted).toBeDefined(); + if (removed3[0].deleted) expect(removed3[0].deleted.id).toBe(3); + expect(objBST.isAVLBalanced()).toBe(false); + expect(objBST.getHeight()).toBe(3); + + const removed8 = objBST.remove(8, true); + expect(removed8).toBeInstanceOf(Array); + expect(removed8[0]).toBeDefined(); + expect(removed8[0].deleted).toBeDefined(); + if (removed8[0].deleted) expect(removed8[0].deleted.id).toBe(8); + expect(objBST.isAVLBalanced()).toBe(true); + expect(objBST.getHeight()).toBe(3); + + const removed6 = objBST.remove(6, true); + expect(removed6).toBeInstanceOf(Array); + expect(removed6[0]).toBeDefined(); + expect(removed6[0].deleted).toBeDefined(); + if (removed6[0].deleted) expect(removed6[0].deleted.id).toBe(6); + expect(objBST.remove(6, true).length).toBe(0); + expect(objBST.isAVLBalanced()).toBe(false); + expect(objBST.getHeight()).toBe(3); + + const removed7 = objBST.remove(7, true); + expect(removed7).toBeInstanceOf(Array); + expect(removed7[0]).toBeDefined(); + expect(removed7[0].deleted).toBeDefined(); + if (removed7[0].deleted) expect(removed7[0].deleted.id).toBe(7); + expect(objBST.isAVLBalanced()).toBe(false); + expect(objBST.getHeight()).toBe(3); + + const removed9 = objBST.remove(9, true); + expect(removed9).toBeInstanceOf(Array); + expect(removed9[0]).toBeDefined(); + expect(removed9[0].deleted).toBeDefined(); + if (removed9[0].deleted) expect(removed9[0].deleted.id).toBe(9); + expect(objBST.isAVLBalanced()).toBe(false); + expect(objBST.getHeight()).toBe(3); + + const removed14 = objBST.remove(14, true); + expect(removed14).toBeInstanceOf(Array); + expect(removed14[0]).toBeDefined(); + expect(removed14[0].deleted).toBeDefined(); + if (removed14[0].deleted) expect(removed14[0].deleted.id).toBe(14); + expect(objBST.isAVLBalanced()).toBe(false); + expect(objBST.getHeight()).toBe(2); + + + expect(objBST.isAVLBalanced()).toBe(false); + + const bfsIDs = objBST.BFS(); + expect(bfsIDs[0]).toBe(2); + expect(bfsIDs[1]).toBe(12); + expect(bfsIDs[2]).toBe(16); + + const bfsNodes = objBST.BFS('node'); + expect(bfsNodes[0].id).toBe(2); + expect(bfsNodes[1].id).toBe(12); + expect(bfsNodes[2].id).toBe(16); + }); }); diff --git a/tests/unit/data-structures/graph/directed-graph.test.ts b/tests/unit/data-structures/graph/directed-graph.test.ts index 29f7e5c..dffc6ef 100644 --- a/tests/unit/data-structures/graph/directed-graph.test.ts +++ b/tests/unit/data-structures/graph/directed-graph.test.ts @@ -1,10 +1,10 @@ import {DirectedEdge, DirectedGraph, DirectedVertex, VertexId} from '../../../../src'; describe('DirectedGraph Operation Test', () => { - let graph: DirectedGraph; + let graph: DirectedGraph; beforeEach(() => { - graph = new DirectedGraph(DirectedVertex, DirectedEdge); + graph = new DirectedGraph(); }); @@ -100,13 +100,19 @@ class MyEdge extends DirectedEdge { } class MyDirectedGraph, E extends MyEdge> extends DirectedGraph { + _createVertex(id: VertexId, val: V['val']): V { + return new MyVertex(id, val) as V; + } + _createEdge(src: VertexId, dest: VertexId, weight?: number, val?: E['val']): E { + return new MyEdge(src, dest, weight ?? 1, val) as E; + } } describe('Inherit from DirectedGraph and perform operations', () => { - let myGraph = new MyDirectedGraph, MyEdge>(MyVertex, MyEdge); + let myGraph = new MyDirectedGraph, MyEdge>(); beforeEach(() => { - myGraph = new MyDirectedGraph(MyVertex, MyEdge); + myGraph = new MyDirectedGraph(); }); it('Add vertices', () => { @@ -211,7 +217,7 @@ describe('Inherit from DirectedGraph and perform operations', () => { }); describe('Inherit from DirectedGraph and perform operations test2.', () => { - const myGraph = new MyDirectedGraph, MyEdge>(MyVertex, MyEdge); + const myGraph = new MyDirectedGraph, MyEdge>(); it('should test graph operations', () => { const vertex1 = new MyVertex(1, 'data1'); diff --git a/tests/unit/data-structures/graph/undirected-graph.test.ts b/tests/unit/data-structures/graph/undirected-graph.test.ts index af852ea..34a75cd 100644 --- a/tests/unit/data-structures/graph/undirected-graph.test.ts +++ b/tests/unit/data-structures/graph/undirected-graph.test.ts @@ -1,5 +1,64 @@ -describe('UndirectedGraph Operation Test', () => { - it('should xxx', function () { +import {UndirectedEdge, UndirectedGraph, UndirectedVertex} from '../../../../src'; +describe('UndirectedGraph Operation Test', () => { + let graph: UndirectedGraph; + + beforeEach(() => { + graph = new UndirectedGraph(); + }); + + + it('should add vertices', () => { + const vertex1 = new UndirectedVertex('A'); + const vertex2 = new UndirectedVertex('B'); + + graph.addVertex(vertex1); + graph.addVertex(vertex2); + + expect(graph.hasVertex(vertex1)).toBe(true); + expect(graph.hasVertex(vertex2)).toBe(true); + }); + + it('should add edges', () => { + const vertex1 = new UndirectedVertex('A'); + const vertex2 = new UndirectedVertex('B'); + const edge = new UndirectedEdge('A', 'B'); + + graph.addVertex(vertex1); + graph.addVertex(vertex2); + graph.addEdge(edge); + + expect(graph.hasEdge('A', 'B')).toBe(true); + expect(graph.hasEdge('B', 'A')).toBe(true); + }); + + it('should remove edges', () => { + const vertex1 = new UndirectedVertex('A'); + const vertex2 = new UndirectedVertex('B'); + const edge = new UndirectedEdge('A', 'B'); + + graph.addVertex(vertex1); + graph.addVertex(vertex2); + graph.addEdge(edge); + + expect(graph.removeEdge(edge)).toBe(edge); + expect(graph.hasEdge('A', 'B')).toBe(false); + }); + + it('should perform topological sort', () => { + const vertexA = new UndirectedVertex('A'); + const vertexB = new UndirectedVertex('B'); + const vertexC = new UndirectedVertex('C'); + const edgeAB = new UndirectedEdge('A', 'B'); + const edgeBC = new UndirectedEdge('B', 'C'); + + graph.addVertex(vertexA); + graph.addVertex(vertexB); + graph.addVertex(vertexC); + graph.addEdge(edgeAB); + graph.addEdge(edgeBC); + + const dijkstraResult = graph.dijkstra('A'); + // TODO to be tested }); });