Add more array functions

Author: siddhesh321995

DOCUMENTATION.md

@@ -1,10 +1,25 @@
 # @dsinjs/binary-tree
-Data structure in your javascript code, Binary Trees.
+> Data structure in your JavaScript code, Binary Trees.
 
 [![Build Status](https://travis-ci.com/dsinjs/binary-tree.svg?branch=main)](https://travis-ci.com/dsinjs/binary-tree)
 ![Node.js CI](https://github.com/dsinjs/binary-tree/workflows/Node.js%20CI/badge.svg?branch=main)
 
-## Installation:
+## Overview
+Binary Tree in Javascript
+```
+      tree
+      ----
+       j    <-- root
+     /   \
+    f      k  
+  /   \     \
+ a     h     z    <-- leaves
+```
+- Binary tree always has nodes with maximum children of 2.
+- Index starts with 1 such that index of j is 1, f is 2, z is 7 and so on.
+- Root is single node always on top of the tree, in this case its j.
+- Leaves nodes are the nodes who does not have any children, in this case its a, h, z.
+## Installation
 Using npm
 ```
 npm install @dsinjs/binary-tree --save
@@ -16,7 +31,7 @@ Or directly on your browser, simply download your file from the following:
 <script type="application/javascript" src="dsinjs-binarytree.js"></script>
 <script type="application/javascript" src="dsinjs-binarytree.min.js"></script>
 ```
-## Usage:
+## Usage
 ```
 const { BTreeNode, BTree } = require('@dsinjs/binary-tree');
 ```
@@ -32,12 +47,14 @@ tree.delete(30);
 tree.toArray(); // [{value:10,...},{value:20,...}]
 ```
 ```
+// Classic ES6 iterations
 for (const node of tree) {
     console.log(node.value); // 10, 20
 }
 ```
 ## All Features:
 - All Binary Tree data structure functionality.
+- 25+ Binary Tree functions.
 - Main functions like insert(), delete(), each(), find() etc.
 - Extended functions like entries(), Symbol.iterator, supports `for...of` loops.
 - Conversion methods like fromArray(), toArray(), toString(), toJSON().
@@ -46,6 +63,6 @@ for (const node of tree) {
 Checkout [DOCUMENTATION.md](DOCUMENTATION.md) for complete documentation or View Documentation online at [https://dsinjs.github.io/binary-tree/](https://dsinjs.github.io/binary-tree/)
 
 
-## Help us expand:
+## Help us expand
 Let me know in issues/github page or on email which javascript functions to include in next release.
 Check all the [Contributing authors](CONTRIBUTING.md) to this library.

README.md

@@ -754,7 +754,7 @@ var BTree = function () {
      * @returns {BTree} Returns current tree instance.
      * @example
      * var tree = BTree.fromArray([10, 20, 30, 40, 50, 60, 70, 80]);
-     * tree.reverse().toArray(); // [10, 30, 20, 70, 60, 50, 40, 80]
+     * tree.reverse().toArray(); // => [10, 30, 20, 70, 60, 50, 40, 80]
      */
 
   }, {
@@ -774,6 +774,89 @@ var BTree = function () {
       return this;
     }
 
+    /**
+     * Returns first index of a value matched, if it is not present, it returns -1.
+     * @param {any} value Any value to find.
+     * @method indexOf
+     * @member
+     * @public
+     * @returns {number} Returns index of given item.
+     * @example
+     * var tree = BTree.fromArray([10, 20, 30, 40, 50, 60, 70, 80]);
+     * tree.indexOf(30); // => 3
+     * tree.indexOf(51); // => -1
+     */
+
+  }, {
+    key: "indexOf",
+    value: function indexOf(value) {
+      var retIndex = -1;
+      this.each(function (node, index) {
+        if (node.value === value && retIndex === -1) {
+          retIndex = index;
+        }
+      });
+
+      return retIndex;
+    }
+
+    /**
+     * Checks if given item exists or not, returns boolean.
+     * @param {any} value Any value to check if it exists or not.
+     * @method includes
+     * @member
+     * @public
+     * @returns {boolean} Returns true if it is present, otherwise false.
+     * @example
+     * var tree = BTree.fromArray([10, 20, 30, 40, 50, 60, 70, 80]);
+     * tree.includes(30); // true
+     * tree.includes(51); // false
+     */
+
+  }, {
+    key: "includes",
+    value: function includes(value) {
+      return this.indexOf(value) !== -1;
+    }
+
+    /**
+     * Checks if given item exists or not, returns boolean.
+     * @param {any} value Any value to check if it exists or not.
+     * @method exists
+     * @member
+     * @public
+     * @returns {boolean} Returns true if it is present, otherwise false.
+     * @example
+     * var tree = BTree.fromArray([10, 20, 30, 40, 50, 60, 70, 80]);
+     * tree.includes(30); // true
+     * tree.includes(51); // false
+     */
+
+  }, {
+    key: "exists",
+    value: function exists(value) {
+      return this.indexOf(value) !== -1;
+    }
+
+    /**
+     * Checks if given item exists or not, returns boolean.
+     * @param {any} value Any value to check if it exists or not.
+     * @method has
+     * @member
+     * @public
+     * @returns {boolean} Returns true if it is present, otherwise false.
+     * @example
+     * var tree = BTree.fromArray([10, 20, 30, 40, 50, 60, 70, 80]);
+     * tree.includes(30); // true
+     * tree.includes(51); // false
+     */
+
+  }, {
+    key: "has",
+    value: function has(value) {
+      return this.indexOf(value) !== -1;
+    }
+
     /**
      * Returns index value from given path.
      * @param {Array<'U'|'L'|'R'>} path Array for U L or R, which represents the quickest path to get to a node.

dist/dsinjs-binarytree.js

@@ -590,7 +590,7 @@ var BTree = function () {
      * @returns {BTree} Returns current tree instance.
      * @example
      * var tree = BTree.fromArray([10, 20, 30, 40, 50, 60, 70, 80]);
-     * tree.reverse().toArray(); // [10, 30, 20, 70, 60, 50, 40, 80]
+     * tree.reverse().toArray(); // => [10, 30, 20, 70, 60, 50, 40, 80]
      */
 
   }, {
@@ -610,6 +610,89 @@ var BTree = function () {
       return this;
     }
 
+    /**
+     * Returns first index of a value matched, if it is not present, it returns -1.
+     * @param {any} value Any value to find.
+     * @method indexOf
+     * @member
+     * @public
+     * @returns {number} Returns index of given item.
+     * @example
+     * var tree = BTree.fromArray([10, 20, 30, 40, 50, 60, 70, 80]);
+     * tree.indexOf(30); // => 3
+     * tree.indexOf(51); // => -1
+     */
+
+  }, {
+    key: "indexOf",
+    value: function indexOf(value) {
+      var retIndex = -1;
+      this.each(function (node, index) {
+        if (node.value === value && retIndex === -1) {
+          retIndex = index;
+        }
+      });
+
+      return retIndex;
+    }
+
+    /**
+     * Checks if given item exists or not, returns boolean.
+     * @param {any} value Any value to check if it exists or not.
+     * @method includes
+     * @member
+     * @public
+     * @returns {boolean} Returns true if it is present, otherwise false.
+     * @example
+     * var tree = BTree.fromArray([10, 20, 30, 40, 50, 60, 70, 80]);
+     * tree.includes(30); // true
+     * tree.includes(51); // false
+     */
+
+  }, {
+    key: "includes",
+    value: function includes(value) {
+      return this.indexOf(value) !== -1;
+    }
+
+    /**
+     * Checks if given item exists or not, returns boolean.
+     * @param {any} value Any value to check if it exists or not.
+     * @method exists
+     * @member
+     * @public
+     * @returns {boolean} Returns true if it is present, otherwise false.
+     * @example
+     * var tree = BTree.fromArray([10, 20, 30, 40, 50, 60, 70, 80]);
+     * tree.includes(30); // true
+     * tree.includes(51); // false
+     */
+
+  }, {
+    key: "exists",
+    value: function exists(value) {
+      return this.indexOf(value) !== -1;
+    }
+
+    /**
+     * Checks if given item exists or not, returns boolean.
+     * @param {any} value Any value to check if it exists or not.
+     * @method has
+     * @member
+     * @public
+     * @returns {boolean} Returns true if it is present, otherwise false.
+     * @example
+     * var tree = BTree.fromArray([10, 20, 30, 40, 50, 60, 70, 80]);
+     * tree.includes(30); // true
+     * tree.includes(51); // false
+     */
+
+  }, {
+    key: "has",
+    value: function has(value) {
+      return this.indexOf(value) !== -1;
+    }
+
     /**
      * Returns index value from given path.
      * @param {Array<'U'|'L'|'R'>} path Array for U L or R, which represents the quickest path to get to a node.