avl-tree-typed 1.40.0-rc → 1.40.0

package/coverage/lcov-report/sorter.js

@@ -1,196 +1,206 @@
 /* eslint-disable */
-var addSorting = (function() {
-    'use strict';
-    var cols,
-        currentSort = {
-            index: 0,
-            desc: false
-        };
+var addSorting = (function () {
+  'use strict';
+  var cols,
+    currentSort = {
+      index: 0,
+      desc: false
+    };
 
-    // returns the summary table element
-    function getTable() {
-        return document.querySelector('.coverage-summary');
-    }
-    // returns the thead element of the summary table
-    function getTableHeader() {
-        return getTable().querySelector('thead tr');
-    }
-    // returns the tbody element of the summary table
-    function getTableBody() {
-        return getTable().querySelector('tbody');
+  // returns the summary table element
+  function getTable() {
+    return document.querySelector('.coverage-summary');
+  }
+
+  // returns the thead element of the summary table
+  function getTableHeader() {
+    return getTable().querySelector('thead tr');
+  }
+
+  // returns the tbody element of the summary table
+  function getTableBody() {
+    return getTable().querySelector('tbody');
+  }
+
+  // returns the th element for nth column
+  function getNthColumn(n) {
+    return getTableHeader().querySelectorAll('th')[n];
+  }
+
+  function onFilterInput() {
+    const searchValue = document.getElementById('fileSearch').value;
+    const rows = document.getElementsByTagName('tbody')[0].children;
+    for (let i = 0; i < rows.length; i++) {
+      const row = rows[i];
+      if (
+        row.textContent
+          .toLowerCase()
+          .includes(searchValue.toLowerCase())
+      ) {
+        row.style.display = '';
+      } else {
+        row.style.display = 'none';
+      }
     }
-    // returns the th element for nth column
-    function getNthColumn(n) {
-        return getTableHeader().querySelectorAll('th')[n];
+  }
+
+  // loads the search box
+  function addSearchBox() {
+    var template = document.getElementById('filterTemplate');
+    var templateClone = template.content.cloneNode(true);
+    templateClone.getElementById('fileSearch').oninput = onFilterInput;
+    template.parentElement.appendChild(templateClone);
+  }
+
+  // loads all columns
+  function loadColumns() {
+    var colNodes = getTableHeader().querySelectorAll('th'),
+      colNode,
+      cols = [],
+      col,
+      i;
+
+    for (i = 0; i < colNodes.length; i += 1) {
+      colNode = colNodes[i];
+      col = {
+        key: colNode.getAttribute('data-col'),
+        sortable: !colNode.getAttribute('data-nosort'),
+        type: colNode.getAttribute('data-type') || 'string'
+      };
+      cols.push(col);
+      if (col.sortable) {
+        col.defaultDescSort = col.type === 'number';
+        colNode.innerHTML =
+          colNode.innerHTML + '<span class="sorter"></span>';
+      }
     }
+    return cols;
+  }
 
-    function onFilterInput() {
-        const searchValue = document.getElementById('fileSearch').value;
-        const rows = document.getElementsByTagName('tbody')[0].children;
-        for (let i = 0; i < rows.length; i++) {
-            const row = rows[i];
-            if (
-                row.textContent
-                    .toLowerCase()
-                    .includes(searchValue.toLowerCase())
-            ) {
-                row.style.display = '';
-            } else {
-                row.style.display = 'none';
-            }
-        }
+  // attaches a data attribute to every tr element with an object
+  // of data values keyed by column name
+  function loadRowData(tableRow) {
+    var tableCols = tableRow.querySelectorAll('td'),
+      colNode,
+      col,
+      data = {},
+      i,
+      val;
+    for (i = 0; i < tableCols.length; i += 1) {
+      colNode = tableCols[i];
+      col = cols[i];
+      val = colNode.getAttribute('data-value');
+      if (col.type === 'number') {
+        val = Number(val);
+      }
+      data[col.key] = val;
     }
+    return data;
+  }
 
-    // loads the search box
-    function addSearchBox() {
-        var template = document.getElementById('filterTemplate');
-        var templateClone = template.content.cloneNode(true);
-        templateClone.getElementById('fileSearch').oninput = onFilterInput;
-        template.parentElement.appendChild(templateClone);
+  // loads all row data
+  function loadData() {
+    var rows = getTableBody().querySelectorAll('tr'),
+      i;
+
+    for (i = 0; i < rows.length; i += 1) {
+      rows[i].data = loadRowData(rows[i]);
     }
+  }
 
-    // loads all columns
-    function loadColumns() {
-        var colNodes = getTableHeader().querySelectorAll('th'),
-            colNode,
-            cols = [],
-            col,
-            i;
-
-        for (i = 0; i < colNodes.length; i += 1) {
-            colNode = colNodes[i];
-            col = {
-                key: colNode.getAttribute('data-col'),
-                sortable: !colNode.getAttribute('data-nosort'),
-                type: colNode.getAttribute('data-type') || 'string'
-            };
-            cols.push(col);
-            if (col.sortable) {
-                col.defaultDescSort = col.type === 'number';
-                colNode.innerHTML =
-                    colNode.innerHTML + '<span class="sorter"></span>';
-            }
-        }
-        return cols;
+  // sorts the table using the data for the ith column
+  function sortByIndex(index, desc) {
+    var key = cols[index].key,
+      sorter = function (a, b) {
+        a = a.data[key];
+        b = b.data[key];
+        return a < b ? -1 : a > b ? 1 : 0;
+      },
+      finalSorter = sorter,
+      tableBody = document.querySelector('.coverage-summary tbody'),
+      rowNodes = tableBody.querySelectorAll('tr'),
+      rows = [],
+      i;
+
+    if (desc) {
+      finalSorter = function (a, b) {
+        return -1 * sorter(a, b);
+      };
     }
-    // attaches a data attribute to every tr element with an object
-    // of data values keyed by column name
-    function loadRowData(tableRow) {
-        var tableCols = tableRow.querySelectorAll('td'),
-            colNode,
-            col,
-            data = {},
-            i,
-            val;
-        for (i = 0; i < tableCols.length; i += 1) {
-            colNode = tableCols[i];
-            col = cols[i];
-            val = colNode.getAttribute('data-value');
-            if (col.type === 'number') {
-                val = Number(val);
-            }
-            data[col.key] = val;
-        }
-        return data;
+
+    for (i = 0; i < rowNodes.length; i += 1) {
+      rows.push(rowNodes[i]);
+      tableBody.removeChild(rowNodes[i]);
     }
-    // loads all row data
-    function loadData() {
-        var rows = getTableBody().querySelectorAll('tr'),
-            i;
 
-        for (i = 0; i < rows.length; i += 1) {
-            rows[i].data = loadRowData(rows[i]);
-        }
+    rows.sort(finalSorter);
+
+    for (i = 0; i < rows.length; i += 1) {
+      tableBody.appendChild(rows[i]);
     }
-    // sorts the table using the data for the ith column
-    function sortByIndex(index, desc) {
-        var key = cols[index].key,
-            sorter = function(a, b) {
-                a = a.data[key];
-                b = b.data[key];
-                return a < b ? -1 : a > b ? 1 : 0;
-            },
-            finalSorter = sorter,
-            tableBody = document.querySelector('.coverage-summary tbody'),
-            rowNodes = tableBody.querySelectorAll('tr'),
-            rows = [],
-            i;
-
-        if (desc) {
-            finalSorter = function(a, b) {
-                return -1 * sorter(a, b);
-            };
-        }
+  }
 
-        for (i = 0; i < rowNodes.length; i += 1) {
-            rows.push(rowNodes[i]);
-            tableBody.removeChild(rowNodes[i]);
-        }
+  // removes sort indicators for current column being sorted
+  function removeSortIndicators() {
+    var col = getNthColumn(currentSort.index),
+      cls = col.className;
+
+    cls = cls.replace(/ sorted$/, '').replace(/ sorted-desc$/, '');
+    col.className = cls;
+  }
+
+  // adds sort indicators for current column being sorted
+  function addSortIndicators() {
+    getNthColumn(currentSort.index).className += currentSort.desc
+      ? ' sorted-desc'
+      : ' sorted';
+  }
 
-        rows.sort(finalSorter);
+  // adds event listeners for all sorter widgets
+  function enableUI() {
+    var i,
+      el,
+      ithSorter = function ithSorter(i) {
+        var col = cols[i];
 
-        for (i = 0; i < rows.length; i += 1) {
-            tableBody.appendChild(rows[i]);
+        return function () {
+          var desc = col.defaultDescSort;
+
+          if (currentSort.index === i) {
+            desc = !currentSort.desc;
+          }
+          sortByIndex(i, desc);
+          removeSortIndicators();
+          currentSort.index = i;
+          currentSort.desc = desc;
+          addSortIndicators();
+        };
+      };
+    for (i = 0; i < cols.length; i += 1) {
+      if (cols[i].sortable) {
+        // add the click event handler on the th so users
+        // dont have to click on those tiny arrows
+        el = getNthColumn(i).querySelector('.sorter').parentElement;
+        if (el.addEventListener) {
+          el.addEventListener('click', ithSorter(i));
+        } else {
+          el.attachEvent('onclick', ithSorter(i));
         }
+      }
     }
-    // removes sort indicators for current column being sorted
-    function removeSortIndicators() {
-        var col = getNthColumn(currentSort.index),
-            cls = col.className;
+  }
 
-        cls = cls.replace(/ sorted$/, '').replace(/ sorted-desc$/, '');
-        col.className = cls;
+  // adds sorting functionality to the UI
+  return function () {
+    if (!getTable()) {
+      return;
     }
-    // adds sort indicators for current column being sorted
-    function addSortIndicators() {
-        getNthColumn(currentSort.index).className += currentSort.desc
-            ? ' sorted-desc'
-            : ' sorted';
-    }
-    // adds event listeners for all sorter widgets
-    function enableUI() {
-        var i,
-            el,
-            ithSorter = function ithSorter(i) {
-                var col = cols[i];
-
-                return function() {
-                    var desc = col.defaultDescSort;
-
-                    if (currentSort.index === i) {
-                        desc = !currentSort.desc;
-                    }
-                    sortByIndex(i, desc);
-                    removeSortIndicators();
-                    currentSort.index = i;
-                    currentSort.desc = desc;
-                    addSortIndicators();
-                };
-            };
-        for (i = 0; i < cols.length; i += 1) {
-            if (cols[i].sortable) {
-                // add the click event handler on the th so users
-                // dont have to click on those tiny arrows
-                el = getNthColumn(i).querySelector('.sorter').parentElement;
-                if (el.addEventListener) {
-                    el.addEventListener('click', ithSorter(i));
-                } else {
-                    el.attachEvent('onclick', ithSorter(i));
-                }
-            }
-        }
-    }
-    // adds sorting functionality to the UI
-    return function() {
-        if (!getTable()) {
-            return;
-        }
-        cols = loadColumns();
-        loadData();
-        addSearchBox();
-        addSortIndicators();
-        enableUI();
-    };
+    cols = loadColumns();
+    loadData();
+    addSearchBox();
+    addSortIndicators();
+    enableUI();
+  };
 })();
 
 window.addEventListener('load', addSorting);

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

@@ -0,0 +1,106 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import { BST, BSTNode } from './bst';
+import type { AVLTreeNodeNested, AVLTreeOptions, BinaryTreeDeletedResult, BTNKey } from '../../types';
+import { BTNCallback } from '../../types';
+import { IBinaryTree } from '../../interfaces';
+export declare class AVLTreeNode<V = any, N extends AVLTreeNode<V, N> = AVLTreeNodeNested<V>> extends BSTNode<V, N> {
+    height: number;
+    constructor(key: BTNKey, value?: V);
+}
+export declare class AVLTree<V = any, N extends AVLTreeNode<V, N> = AVLTreeNode<V, AVLTreeNodeNested<V>>> extends BST<V, N> implements IBinaryTree<V, N> {
+    /**
+     * This is a constructor function for an AVL tree data structure in TypeScript.
+     * @param {AVLTreeOptions} [options] - The `options` parameter is an optional object that can be passed to the
+     * constructor of the AVLTree class. It allows you to customize the behavior of the AVL tree by providing different
+     * options.
+     */
+    constructor(options?: AVLTreeOptions);
+    /**
+     * The function creates a new AVL tree node with the specified key and value.
+     * @param {BTNKey} key - The key parameter is the key value that will be associated with
+     * the new node. It is used to determine the position of the node in the binary search tree.
+     * @param [value] - The parameter `value` is an optional value that can be assigned to the node. It is of
+     * type `V`, which means it can be any value that is assignable to the `value` property of the
+     * node type `N`.
+     * @returns a new AVLTreeNode object with the specified key and value.
+     */
+    createNode(key: BTNKey, value?: V): N;
+    /**
+     * The function overrides the add method of a binary tree node and balances the tree after inserting
+     * a new node.
+     * @param {BTNKey | N | null} keyOrNode - The `keyOrNode` parameter can accept either a
+     * `BTNKey` or a `N` (which represents a node in the binary tree) or `null`.
+     * @param [value] - The `value` parameter is the value that you want to assign to the new node that you
+     * are adding to the binary search tree.
+     * @returns The method is returning the inserted node (`N`), `null`, or `undefined`.
+     */
+    add(keyOrNode: BTNKey | N | null, value?: V): N | null | undefined;
+    /**
+     * The function overrides the delete method of a binary tree and balances the tree after deleting a
+     * node if necessary.
+     * @param {ReturnType<C>} identifier - The `identifier` parameter is either a
+     * `BTNKey` or a generic type `N`. It represents the property of the node that we are
+     * searching for. It can be a specific key value or any other property of the node.
+     * @param callback - The `callback` parameter is a function that takes a node as input and returns a
+     * value. This value is compared with the `identifier` parameter to determine if the node should be
+     * included in the result. The `callback` parameter has a default value of
+     * `((node: N) => node.key)`
+     * @returns The method is returning an array of `BinaryTreeDeletedResult<N>` objects.
+     */
+    delete<C extends BTNCallback<N>>(identifier: ReturnType<C>, callback?: C): BinaryTreeDeletedResult<N>[];
+    /**
+     * The function swaps the key, value, and height properties between two nodes in a binary tree.
+     * @param {N} srcNode - The `srcNode` parameter represents the source node that needs to be swapped
+     * with the `destNode`.
+     * @param {N} destNode - The `destNode` parameter represents the destination node where the values
+     * from the source node (`srcNode`) will be swapped to.
+     * @returns The method is returning the `destNode` after swapping its properties with the `srcNode`.
+     */
+    protected _swap(srcNode: N, destNode: N): N;
+    /**
+     * The function calculates the balance factor of a node in a binary tree.
+     * @param {N} node - The parameter "node" represents a node in a binary tree data structure.
+     * @returns the balance factor of a given node. The balance factor is calculated by subtracting the
+     * height of the left subtree from the height of the right subtree.
+     */
+    protected _balanceFactor(node: N): number;
+    /**
+     * The function updates the height of a node in a binary tree based on the heights of its left and
+     * right children.
+     * @param {N} node - The parameter "node" represents a node in a binary tree data structure.
+     */
+    protected _updateHeight(node: N): void;
+    /**
+     * The `_balancePath` function is used to update the heights of nodes and perform rotation operations
+     * to restore balance in an AVL tree after inserting a node.
+     * @param {N} node - The `node` parameter in the `_balancePath` function represents the node in the
+     * AVL tree that needs to be balanced.
+     */
+    protected _balancePath(node: N): void;
+    /**
+     * The function `_balanceLL` performs a left-left rotation to balance a binary tree.
+     * @param {N} A - A is a node in a binary tree.
+     */
+    protected _balanceLL(A: N): void;
+    /**
+     * The `_balanceLR` function performs a left-right rotation to balance a binary tree.
+     * @param {N} A - A is a node in a binary tree.
+     */
+    protected _balanceLR(A: N): void;
+    /**
+     * The function `_balanceRR` performs a right-right rotation to balance a binary tree.
+     * @param {N} A - A is a node in a binary tree.
+     */
+    protected _balanceRR(A: N): void;
+    /**
+     * The function `_balanceRL` performs a right-left rotation to balance a binary tree.
+     * @param {N} A - A is a node in a binary tree.
+     */
+    protected _balanceRL(A: N): void;
+}