avl-tree-typed

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>avl-tree-typed</title><meta name="description" content="Documentation for avl-tree-typed"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> <div class="tsd-toolbar-contents container"> <div class="table-cell" id="tsd-search" data-base="."> <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> <div class="field"> <div id="tsd-toolbar-links"></div></div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">avl-tree-typed</a></div> <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header> <div class="container container-main"> <div class="col-content"> <div class="tsd-page-title"> <h2>avl-tree-typed</h2></div> <div class="tsd-panel tsd-typography"><a id="md:what" class="tsd-anchor"></a><h1><a href="#md:what">What</a></h1><a id="md:brief" class="tsd-anchor"></a><h2><a href="#md:brief">Brief</a></h2>This is a standalone AVL Tree data structure from the data-structure-typed collection. If you wish to access more data structures or advanced features, you can transition to directly installing the complete <a href="https://www.npmjs.com/package/data-structure-typed">data-structure-typed</a> package <a id="md:how" class="tsd-anchor"></a><h1><a href="#md:how">How</a></h1><a id="md:install" class="tsd-anchor"></a><h2><a href="#md:install">install</a></h2><a id="md:npm" class="tsd-anchor"></a><h3><a href="#md:npm">npm</a></h3><pre><code class="language-bash">npm i avl-tree-typed --save </code><button>Copy</button></pre> <a id="md:yarn" class="tsd-anchor"></a><h3><a href="#md:yarn">yarn</a></h3><pre><code class="language-bash">yarn add avl-tree-typed </code><button>Copy</button></pre> <a id="md:methods" class="tsd-anchor"></a><h3><a href="#md:methods">methods</a></h3><img src="https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/methods-8bit/avl-tree.png?raw=true" alt=""> <a id="md:snippet" class="tsd-anchor"></a><h3><a href="#md:snippet">snippet</a></h3><a id="md:ts" class="tsd-anchor"></a><h4><a href="#md:ts">TS</a></h4><pre><code class="language-typescript">import {AVLTree, AVLTreeNode} from 'data-structure-typed'; // /* or if you prefer */ import {AVLTree} from 'avl-tree-typed'; const avlTree = new AVLTree<AVLTreeNode<number>>(); const idsOrVals = [11, 3, 15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5]; avlTree.addMany(idsOrVals, idsOrVals); const node6 = avlTree.get(6); node6 && avlTree.getHeight(node6) // 3 node6 && avlTree.getDepth(node6) // 1 const getNodeById = avlTree.get(10, 'id'); getNodeById?.id // 10 const getMinNodeByRoot = avlTree.getLeftMost(); getMinNodeByRoot?.id // 1 const node15 = avlTree.get(15); const getMinNodeBySpecificNode = node15 && avlTree.getLeftMost(node15); getMinNodeBySpecificNode?.id // 12 const subTreeSum = node15 && avlTree.subTreeSum(node15); subTreeSum // 70 const lesserSum = avlTree.lesserSum(10); lesserSum // 45 const node11 = avlTree.get(11); node11?.id // 11 const dfs = avlTree.DFS('in', 'node'); dfs[0].id // 1 avlTree.perfectlyBalance(); const bfs = avlTree.BFS('node'); avlTree.isPerfectlyBalanced() && bfs[0].id // 8 avlTree.remove(11, true)[0].deleted?.id // 11 avlTree.isAVLBalanced(); // true node15 && avlTree.getHeight(node15) // 2 avlTree.remove(1, true)[0].deleted?.id // 1 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 4 avlTree.remove(4, true)[0].deleted?.id // 4 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 4 avlTree.remove(10, true)[0].deleted?.id // 10 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 3 avlTree.remove(15, true)[0].deleted?.id // 15 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 3 avlTree.remove(5, true)[0].deleted?.id // 5 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 3 avlTree.remove(13, true)[0].deleted?.id // 13 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 3 avlTree.remove(3, true)[0].deleted?.id // 3 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 3 avlTree.remove(8, true)[0].deleted?.id // 8 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 3 avlTree.remove(6, true)[0].deleted?.id // 6 avlTree.remove(6, true).length // 0 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 2 avlTree.remove(7, true)[0].deleted?.id // 7 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 2 avlTree.remove(9, true)[0].deleted?.id // 9 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 2 avlTree.remove(14, true)[0].deleted?.id // 14 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 1 avlTree.isAVLBalanced(); // true const lastBFSIds = avlTree.BFS(); lastBFSIds[0] // 12 const lastBFSNodes = avlTree.BFS('node'); lastBFSNodes[0].id // 12 </code><button>Copy</button></pre> <a id="md:js" class="tsd-anchor"></a><h4><a href="#md:js">JS</a></h4><pre><code class="language-javascript">const {AVLTree} = require('data-structure-typed'); // /* or if you prefer */ const {AVLTree} = require('avl-tree-typed'); const avlTree = new AVLTree(); const idsOrVals = [11, 3, 15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5]; avlTree.addMany(idsOrVals, idsOrVals); const node6 = avlTree.get(6); node6 && avlTree.getHeight(node6) // 3 node6 && avlTree.getDepth(node6) // 1 const getNodeById = avlTree.get(10, 'id'); getNodeById?.id // 10 const getMinNodeByRoot = avlTree.getLeftMost(); getMinNodeByRoot?.id // 1 const node15 = avlTree.get(15); const getMinNodeBySpecificNode = node15 && avlTree.getLeftMost(node15); getMinNodeBySpecificNode?.id // 12 const subTreeSum = node15 && avlTree.subTreeSum(node15); subTreeSum // 70 const lesserSum = avlTree.lesserSum(10); lesserSum // 45 const node11 = avlTree.get(11); node11?.id // 11 const dfs = avlTree.DFS('in', 'node'); dfs[0].id // 1 avlTree.perfectlyBalance(); const bfs = avlTree.BFS('node'); avlTree.isPerfectlyBalanced() && bfs[0].id // 8 avlTree.remove(11, true)[0].deleted?.id // 11 avlTree.isAVLBalanced(); // true node15 && avlTree.getHeight(node15) // 2 avlTree.remove(1, true)[0].deleted?.id // 1 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 4 avlTree.remove(4, true)[0].deleted?.id // 4 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 4 avlTree.remove(10, true)[0].deleted?.id // 10 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 3 avlTree.remove(15, true)[0].deleted?.id // 15 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 3 avlTree.remove(5, true)[0].deleted?.id // 5 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 3 avlTree.remove(13, true)[0].deleted?.id // 13 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 3 avlTree.remove(3, true)[0].deleted?.id // 3 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 3 avlTree.remove(8, true)[0].deleted?.id // 8 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 3 avlTree.remove(6, true)[0].deleted?.id // 6 avlTree.remove(6, true).length // 0 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 2 avlTree.remove(7, true)[0].deleted?.id // 7 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 2 avlTree.remove(9, true)[0].deleted?.id // 9 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 2 avlTree.remove(14, true)[0].deleted?.id // 14 avlTree.isAVLBalanced(); // true avlTree.getHeight() // 1 avlTree.isAVLBalanced(); // true const lastBFSIds = avlTree.BFS(); lastBFSIds[0] // 12 const lastBFSNodes = avlTree.BFS('node'); lastBFSNodes[0].id // 12 </code><button>Copy</button></pre> <a id="md:api-docs-amp-examples" class="tsd-anchor"></a><h2><a href="#md:api-docs-amp-examples">API docs & Examples</a></h2><a href="https://data-structure-typed-docs.vercel.app">API Docs</a> <a href="https://data-structure-typed-examples.vercel.app">Live Examples</a> <a href="https://github.com/zrwusa/data-structure-typed-examples" target="_blank">Examples Repository</a> <a id="md:data-structures" class="tsd-anchor"></a><h2><a href="#md:data-structures">Data Structures</a></h2><table> <thead> <tr> <th>Data Structure</th> <th>Unit Test</th> <th>Performance Test</th> <th>API Documentation</th> <th>Implemented</th> </tr> </thead> <tbody> <tr> <td>Binary Tree</td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""/> </td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""/> </td> <td><a href="https://data-structure-typed-docs.vercel.app/classes/BinaryTree.html">Binary Tree</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> </tr> <tr> <td>Binary Search Tree (BST)</td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><a href="https://data-structure-typed-docs.vercel.app/classes/BST.html">BST</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> </tr> <tr> <td>AVL Tree</td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><a href="https://data-structure-typed-docs.vercel.app/classes/AVLTree.html">AVLTree</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> </tr> <tr> <td>Tree Multiset</td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><a href="https://data-structure-typed-docs.vercel.app/classes/TreeMultiset.html">TreeMultiset</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> </tr> <tr> <td>Segment Tree</td> <td></td> <td></td> <td><a href="https://data-structure-typed-docs.vercel.app/classes/SegmentTree.html">SegmentTree</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> </tr> <tr> <td>Binary Indexed Tree</td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td></td> <td><a href="https://data-structure-typed-docs.vercel.app/classes/BinaryIndexedTree.html">BinaryIndexedTree</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> </tr> <tr> <td>Graph</td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><a href="https://data-structure-typed-docs.vercel.app/classes/AbstractGraph.html">AbstractGraph</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> </tr> <tr> <td>Directed Graph</td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><a href="https://data-structure-typed-docs.vercel.app/classes/DirectedGraph.html">DirectedGraph</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> </tr> <tr> <td>Undirected Graph</td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><a href="https://data-structure-typed-docs.vercel.app/classes/UndirectedGraph.html">UndirectedGraph</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> </tr> <tr> <td>Linked List</td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><a href="https://data-structure-typed-docs.vercel.app/classes/SinglyLinkedList.html">SinglyLinkedList</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> </tr> <tr> <td>Singly Linked List</td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><a href="https://data-structure-typed-docs.vercel.app/classes/SinglyLinkedList.html">SinglyLinkedList</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> </tr> <tr> <td>Doubly Linked List</td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> <td><a href="https://data-structure-typed-docs.vercel.app/classes/DoublyLinkedList.html">DoublyLinkedList</a></td> <td><img