heap-typed/src/interfaces/binary-tree.ts

Heap. Javascript & Typescript Data Structure.

import { BinaryTree, BinaryTreeNode } from '../data-structures';
import type {
  BinaryTreeDeleteResult,
  BinaryTreeNested,
  BinaryTreeNodeNested,
  BinaryTreeOptions,
  BTNRep,
  NodePredicate
} from '../types';

export interface IBinaryTree<
  K = any,
  V = any,
  R = object,
  NODE extends BinaryTreeNode<K, V, NODE> = BinaryTreeNodeNested<K, V>,
  TREE extends BinaryTree<K, V, R, NODE, TREE> = BinaryTreeNested<K, V, R, NODE>
> {
  createNode(key: K, value?: NODE['value']): NODE;

  createTree(options?: Partial<BinaryTreeOptions<K, V, R>>): TREE;

  add(keyOrNodeOrEntryOrRawElement: BTNRep<K, V, NODE>, value?: V, count?: number): boolean;

  addMany(nodes: Iterable<BTNRep<K, V, NODE>>, values?: Iterable<V | undefined>): boolean[];

  delete(predicate: R | BTNRep<K, V, NODE> | NodePredicate<NODE>): BinaryTreeDeleteResult<NODE>[];
}