Nail Polishing Minions

    tbin-tree
    TypeScript icon, indicating that this package has built-in type declarations

    0.10.0 • Public • Published

    tbin-tree

    A Node.js binary tree module for add, remove, search and traverse the nodes with any content.

    Installation

    npm install tbin-tree --save

    Usage

    Quick Examples

    Javascript ES5 Example

    var BinaryTree  = require("tbin-tree").BinaryTree;
    var myBinaryTree = new BinaryTree();
    // First param the value (Number) , and second optional argument T the content.
    myBinaryTree.insert(5, "Hello World!");
    myBinaryTree.insert(15, "Nel");
    myBinaryTree.insert(2, "Bye World!");
    
    var myNode = myBinaryTree.search(15);
    
    myNode.getContent(); // => { value: 15, content:"Nel"}
    
    // Without arguments the default is showBy="Value"
    
    myBinaryTree.inorder({ showBy: "Content" });
    
    /**
     *    [
     *       { value: 2, content: 'Bye World!' },
     *       { value: 5, content: 'Hello World!' },
     *       { value: 15, content: 'Nel'}
     *   ]
     */

    ES6 | TS Example

    import { BinaryTree, Node } from "tbin-tree";
    
    const myBinaryTree = new BinaryTree<string>();
    myBinaryTree.insert(5, "Hello World!");
    myBinaryTree.insert(15, "Nel");
    myBinaryTree.insert(2, "Bye World!");
    
    const myNode: Node = myBinaryTree.search(15);
    myNode.getContent();

    Documentation

    Import

    const { BinaryTree } = require("tbin-tree");

    Initialize

    We could initialize the Binary Tree by with two optional arguments to initialize the root Node:

    • value : Number (The unique identifier of a Node in base of this value the Binary Tree is ordered)
    • content : T (Any value that we want to store in the root Node)
    const { BinaryTree } = require("tbin-tree");
    const myBinaryTree = new BinaryTree(5, "foo");
    const mySecondaryBinaryTree = new BinaryTree();

    Insert Values

    We must use the first argument the value, the content is optional by default is null, repeating a value will throw an Error

    myBinaryTree.insert(11);
    myBinaryTree.insert(13, "Im the Content :D!");

    Delete Nodes

    Takes the target value to delete the node, reorganize the Binary Tree if we remove a Node with childs.

    myBinaryTree.remove(11);

    Search for Node

    Takes the target value and returns the nodes if match, if there is no Node return null

    myBinaryTree.search(11); // => Node

    Traverse the Binary Tree

    The class has 3 ways of traversing the Binary Tree.

    • Inorder
    • PostOrder
    • Preorder

    It returns an array of Nodes, its content or value. All takes an optional object argument, with the key = showBy='Value' as default. Also can show by: "Content", "Node"

    myBinaryTree.inorder({ showBy: "Content" });
    
    /**
     *    [
     *       { value: 2, content: 'Bye World!' },
     *       { value: 5, content: 'Hello World!' },
     *       { value: 15, content: 'Nel' }
     *   ]
     */
    
    myBinaryTree.inorder();
    
    // [2,5,15]

    Clases

    • ? -Optional argument "=" Default value

    BinaryTree

    Method Paramaters Description
    Contructor value(Number)? = null , content(T)? = null Creates a new BinaryTree
    insert value(Number) , content(T)? = null Insert a new Node in the BinaryTree
    remove value(Number) Removes a Node from the BinaryTree
    search => Node / null value(Number) Search for a Node in the BinaryTree
    inorder => Node[] / T[] / Number[] arg(Object) ? = { showBy = "Value" } Traverse the BinaryTree in inorder and gets the Nodes
    postorder => Node[] / T[] / Number[] arg(Object) ? = { showBy = "Value" } Traverse the BinaryTree in postorder and gets the Nodes
    preorder => Node[] / T[] / Number[] arg(Object) ? = { showBy = "Value" } Traverse the BinaryTree in preorder and gets the Nodes
    searchMin => Number node(Node) Return the minimum value stored in a Node, counting the Node itself

    Node

    Method Paramaters Description
    Contructor value(Number) , content(T)? = null Creates a new Node
    getContent => Object NONE Get the content of the Node
    insert node(Node) Insert the Node as a child, if it can (No repeated values)
    setLeft node(Node) Insert the Node as left child, if it can (No repeated values)
    setRight node(Node) Insert the Node as right child, if it can (No repeated values)
    getLeft => Node / null NONE Get the left Node
    getRight => Node / null NONE Get the right Node
    setValue value(Number) Force the value of Node
    getValue => Number NONE Get the value of the Node

    License

    The MIT License (MIT)

    Copyright (c) 2020 Wilfredo Hernández - Woohaik

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i tbin-tree

    DownloadsWeekly Downloads

    1

    Version

    0.10.0

    License

    MIT

    Unpacked Size

    19 kB

    Total Files

    9

    Last publish

    Collaborators

    • woohaik