data-structure-typed 0.9.16 → 1.3.0

package/dist/data-structures/binary-tree/binary-tree.d.ts

@@ -1,128 +1,31 @@
-import type { BinaryTreeDeleted, BinaryTreeNodeId, BinaryTreeNodePropertyName, DFSOrderPattern, NodeOrPropertyName, ResultsByProperty } from '../types';
-export declare enum FamilyPosition {
-    root = 0,
-    left = 1,
-    right = 2
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import type { BinaryTreeNodeId, BinaryTreeNodeNested, BinaryTreeOptions } from '../../types';
+import { AbstractBinaryTree, AbstractBinaryTreeNode } from './abstract-binary-tree';
+import { IBinaryTree, IBinaryTreeNode } from '../../interfaces';
+export declare class BinaryTreeNode<T = any, NEIGHBOR extends BinaryTreeNode<T, NEIGHBOR> = BinaryTreeNodeNested<T>> extends AbstractBinaryTreeNode<T, NEIGHBOR> implements IBinaryTreeNode<T, NEIGHBOR> {
+    constructor(id: BinaryTreeNodeId, val?: T);
 }
-export declare enum LoopType {
-    iterative = 1,
-    recursive = 2
-}
-export declare class BinaryTreeNode<T> {
-    constructor(id: BinaryTreeNodeId, val: T, count?: number);
-    protected _id: BinaryTreeNodeId;
-    get id(): BinaryTreeNodeId;
-    set id(v: BinaryTreeNodeId);
-    protected _val: T;
-    get val(): T;
-    set val(v: T);
-    protected _left?: BinaryTreeNode<T> | null;
-    get left(): BinaryTreeNode<T> | null | undefined;
-    set left(v: BinaryTreeNode<T> | null | undefined);
-    protected _right?: BinaryTreeNode<T> | null;
-    get right(): BinaryTreeNode<T> | null | undefined;
-    set right(v: BinaryTreeNode<T> | null | undefined);
-    protected _parent: BinaryTreeNode<T> | null | undefined;
-    get parent(): BinaryTreeNode<T> | null | undefined;
-    set parent(v: BinaryTreeNode<T> | null | undefined);
-    protected _familyPosition: FamilyPosition;
-    get familyPosition(): FamilyPosition;
-    set familyPosition(v: FamilyPosition);
-    protected _count: number;
-    get count(): number;
-    set count(v: number);
-    protected _height: number;
-    get height(): number;
-    set height(v: number);
-    swapLocation(swapNode: BinaryTreeNode<T>): BinaryTreeNode<T>;
-    clone(): BinaryTreeNode<T>;
-}
-export declare class BinaryTree<T> {
-    protected _loopType: LoopType;
-    protected _visitedId: BinaryTreeNodeId[];
-    protected _visitedVal: Array<T>;
-    protected _visitedNode: BinaryTreeNode<T>[];
-    protected _visitedCount: number[];
-    protected _visitedLeftSum: number[];
-    private readonly _autoIncrementId;
-    private _maxId;
-    private readonly _isDuplicatedVal;
-    constructor(options?: {
-        loopType?: LoopType;
-        autoIncrementId?: boolean;
-        isDuplicatedVal?: boolean;
-    });
-    protected _root: BinaryTreeNode<T> | null;
-    protected get root(): BinaryTreeNode<T> | null;
-    protected set root(v: BinaryTreeNode<T> | null);
-    protected _size: number;
-    protected get size(): number;
-    protected set size(v: number);
-    protected _count: number;
-    protected get count(): number;
-    protected set count(v: number);
-    getCount(): number;
-    createNode(id: BinaryTreeNodeId, val: T | null, count?: number): BinaryTreeNode<T> | null;
-    clear(): void;
-    isEmpty(): boolean;
-    insertTo({ newNode, parent }: {
-        newNode: BinaryTreeNode<T> | null;
-        parent: BinaryTreeNode<T>;
-    }): BinaryTreeNode<T> | null | undefined;
-    put(id: BinaryTreeNodeId, val: T, count?: number): BinaryTreeNode<T> | null | undefined;
-    insertMany(data: T[] | BinaryTreeNode<T>[]): (BinaryTreeNode<T> | null | undefined)[];
-    fill(data: T[] | BinaryTreeNode<T>[]): boolean;
-    remove(id: BinaryTreeNodeId, ignoreCount?: boolean): BinaryTreeDeleted<T>[];
-    getDepth(node: BinaryTreeNode<T>): number;
-    getHeight(beginRoot?: BinaryTreeNode<T> | null): number;
-    getMinHeight(beginRoot?: BinaryTreeNode<T> | null): number;
-    isBalanced(beginRoot?: BinaryTreeNode<T> | null): boolean;
-    getNodes(nodeProperty: BinaryTreeNodeId | T, propertyName?: BinaryTreeNodePropertyName, onlyOne?: boolean): (BinaryTreeNode<T> | null | undefined)[];
-    has(nodeProperty: BinaryTreeNodeId | T, propertyName?: BinaryTreeNodePropertyName): boolean;
-    get(nodeProperty: BinaryTreeNodeId | T, propertyName?: BinaryTreeNodePropertyName): BinaryTreeNode<T> | null;
-    getPathToRoot(node: BinaryTreeNode<T>): BinaryTreeNode<T>[];
-    getRoot(): BinaryTreeNode<T> | null;
-    getLeftMost(): BinaryTreeNode<T> | null;
-    getLeftMost(node: BinaryTreeNode<T>): BinaryTreeNode<T>;
-    getRightMost(): BinaryTreeNode<T> | null;
-    getRightMost(node: BinaryTreeNode<T>): BinaryTreeNode<T>;
-    isBST(node?: BinaryTreeNode<T> | null): boolean;
-    getSubTreeSizeAndCount(subTreeRoot: BinaryTreeNode<T> | null | undefined): [number, number];
-    subTreeSum(subTreeRoot: BinaryTreeNode<T>, propertyName?: BinaryTreeNodePropertyName): number;
-    subTreeAdd(subTreeRoot: BinaryTreeNode<T>, delta: number, propertyName?: BinaryTreeNodePropertyName): boolean;
-    BFS(): BinaryTreeNodeId[];
-    BFS(nodeOrPropertyName: 'id'): BinaryTreeNodeId[];
-    BFS(nodeOrPropertyName: 'val'): T[];
-    BFS(nodeOrPropertyName: 'node'): BinaryTreeNode<T>[];
-    BFS(nodeOrPropertyName: 'count'): number[];
-    DFS(): BinaryTreeNodeId[];
-    DFS(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'id'): BinaryTreeNodeId[];
-    DFS(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'val'): T[];
-    DFS(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'node'): BinaryTreeNode<T>[];
-    DFS(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'count'): number[];
-    DFSIterative(): BinaryTreeNodeId[];
-    DFSIterative(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'id'): BinaryTreeNodeId[];
-    DFSIterative(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'val'): T[];
-    DFSIterative(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'node'): BinaryTreeNode<T>[];
-    DFSIterative(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'count'): number[];
-    levelIterative(node: BinaryTreeNode<T> | null): BinaryTreeNodeId[];
-    levelIterative(node: BinaryTreeNode<T> | null, nodeOrPropertyName?: 'id'): BinaryTreeNodeId[];
-    levelIterative(node: BinaryTreeNode<T> | null, nodeOrPropertyName?: 'val'): T[];
-    levelIterative(node: BinaryTreeNode<T> | null, nodeOrPropertyName?: 'node'): BinaryTreeNode<T>[];
-    levelIterative(node: BinaryTreeNode<T> | null, nodeOrPropertyName?: 'count'): number[];
-    listLevels(node: BinaryTreeNode<T> | null): BinaryTreeNodeId[][];
-    listLevels(node: BinaryTreeNode<T> | null, nodeOrPropertyName?: 'id'): BinaryTreeNodeId[][];
-    listLevels(node: BinaryTreeNode<T> | null, nodeOrPropertyName?: 'val'): T[][];
-    listLevels(node: BinaryTreeNode<T> | null, nodeOrPropertyName?: 'node'): BinaryTreeNode<T>[][];
-    listLevels(node: BinaryTreeNode<T> | null, nodeOrPropertyName?: 'count'): number[][];
-    getPredecessor(node: BinaryTreeNode<T>): BinaryTreeNode<T>;
-    morris(): BinaryTreeNodeId[];
-    morris(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'id'): BinaryTreeNodeId[];
-    morris(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'val'): T[];
-    morris(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'node'): BinaryTreeNode<T>[];
-    morris(pattern?: DFSOrderPattern, nodeOrPropertyName?: 'count'): number[];
-    protected _resetResults(): void;
-    protected _pushByPropertyNameStopOrNot(cur: BinaryTreeNode<T>, result: (BinaryTreeNode<T> | null | undefined)[], nodeProperty: BinaryTreeNodeId | T, propertyName?: BinaryTreeNodePropertyName, onlyOne?: boolean): boolean | undefined;
-    protected _accumulatedByPropertyName(node: BinaryTreeNode<T>, nodeOrPropertyName?: NodeOrPropertyName): void;
-    protected _getResultByPropertyName(nodeOrPropertyName?: NodeOrPropertyName): ResultsByProperty<T>;
+export declare class BinaryTree<N extends BinaryTreeNode<N['val'], N> = BinaryTreeNode> extends AbstractBinaryTree<N> implements IBinaryTree<N> {
+    /**
+     * This is a constructor function for a binary tree class that takes an optional options parameter.
+     * @param {BinaryTreeOptions} [options] - The `options` parameter is an optional object that can be passed to the
+     * constructor of the `BinaryTree` class. It allows you to customize the behavior of the binary tree by providing
+     * different configuration options.
+     */
+    constructor(options?: BinaryTreeOptions);
+    /**
+     * The function creates a new binary tree node with an optional value.
+     * @param {BinaryTreeNodeId} id - The `id` parameter is the identifier for the binary tree node. It is of type
+     * `BinaryTreeNodeId`, which represents the unique identifier for each node in the binary tree.
+     * @param [val] - The `val` parameter is an optional value that can be assigned to the node. It represents the value
+     * stored in the node.
+     * @returns a new instance of a BinaryTreeNode with the specified id and value.
+     */
+    createNode(id: BinaryTreeNodeId, val?: N['val']): N;
 }