Merge pull request #1 from datastructures-js/development

v1.0.0

Author: eyas-ranjous

.eslintrc

@@ -0,0 +1,13 @@
+{
+  "rules": {
+    max-len: ["error", { "code": 80, "ignoreComments": true }],
+    "comma-dangle": ["error", {
+      "functions": "ignore"
+    }]
+  },
+  "env": {
+    "mocha": true,
+    "node": true
+  },
+  "extends": ["airbnb-base"]
+}

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+coverage
+.DS_Store

.gitignore/.gitignore

@@ -0,0 +1,5 @@
+.git*
+*.spec.js
+.travis.yml
+Gruntfile.js
+coverage/

.npmignore

@@ -0,0 +1,27 @@
+module.exports = (grunt) => {
+  grunt.initConfig({
+    eslint: {
+      src: ['./*.js', './*.spec.js']
+    },
+    mochaTest: {
+      files: ['./*.spec.js']
+    },
+    mocha_istanbul: {
+      coverage: {
+        src: './',
+        options: {
+          mask: '*.spec.js'
+        }
+      }
+    }
+  });
+
+  grunt.loadNpmTasks('grunt-eslint');
+  grunt.loadNpmTasks('grunt-mocha-test');
+  grunt.loadNpmTasks('grunt-mocha-istanbul');
+
+  grunt.registerTask('lint', ['eslint']);
+  grunt.registerTask('test', ['mochaTest']);
+  grunt.registerTask('coverage', ['mocha_istanbul']);
+  grunt.registerTask('build', ['lint', 'coverage']);
+};

.travis.yml

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Eyas Ranjous <eyas.ranjous@gmail.com>
+
+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.

Gruntfile.js

@@ -0,0 +1,189 @@
+# @datastrucures-js/binary-search-tree
+
+[![build:?](https://travis-ci.org/eyas-ranjous/datatructures-js/binary-search-tree.svg?branch=master)](https://travis-ci.org/eyas-ranjous/datatructures-js/binary-search-tree) 
+[![npm](https://img.shields.io/npm/v/@datastructures-js/binary-search-tree.svg)](https://www.npmjs.com/package/@datastructures-js/binary-search-tree)
+[![npm](https://img.shields.io/npm/dm/@datastructures-js/binary-search-tree.svg)](https://www.npmjs.com/packages/@datastructures-js/binary-search-tree) [![npm](https://img.shields.io/badge/node-%3E=%206.0-blue.svg)](https://www.npmjs.com/package/@datastructures-js/binary-search-tree)
+
+node's data type: **string**, **number**.
+
+<img width="413" alt="Binary Search Tree" src="https://user-images.githubusercontent.com/6517308/35762621-74a72626-085f-11e8-8934-ef6facdd6e10.png">
+
+## Usage
+```js
+const binarySearchTree = require('@datastructures-js/binary-search-tree');
+const bst = binarySearchTree();
+```
+
+## API
+
+**.node(value, parent, left, right)**
+
+creates a bst node.
+
+* **.setValue(value)** sets the node's value.
+* **.getValue(value)** gets the node's value.
+* **.setParent(parent)** sets the parent node.
+* **.getParent(parent)** gets the parent node.
+* **.setLeft(left)** sets the node's left child.
+* **.getLeft()** gets the node's left child.
+* **.setRight(left)** sets the node's right child.
+* **.getRight()** gets the node's right child.
+
+```js
+const n = bst.node('test', null,);
+console.log(n.getValue()); // test
+console.log(n.getParent()); // null
+console.log(n.getLeft()); // null
+console.log(n.getRight()); // null
+```
+
+**.insert(value)** 
+
+inserts a value into the tree.
+```javascript
+bst.insert(50);
+bst.insert(80);
+bst.insert(30);
+bst.insert(90);
+bst.insert(60);
+bst.insert(40);
+bst.insert(20);
+```
+
+**.root()** 
+
+gets the root node
+```javascript
+console.log(bst.root().getValue()); // 90
+```
+
+**.min()** 
+
+finds the min value node (most left).
+```javascript
+console.log(bst.min().getValue()); // 20
+```
+
+**.max()** 
+
+finds the min value node (most right).
+```javascript
+console.log(bst.max().getValue()); // 90
+```
+
+**.count()** 
+
+gets nodes count.
+```javascript
+console.log(bst.count()); // 7
+```
+
+**.find(value)** 
+
+finds the value's node or returns null if not found.
+```javascript
+let n = bst.find(30);
+console.log(n.getValue()); // 30
+console.log(n.getRight().getValue()); // 40
+console.log(n.getLeft().getValue()); // 20
+```
+
+**.traverseInOrder(cb)** 
+```js
+// in-order traverse (left-parent-right)
+bst.traverseInOrder(node => console.log(node.getValue()));
+
+// 20
+// 30
+// 40
+// 50
+// 60
+// 80
+// 90
+```
+
+**.traversePreOrder(cb)** 
+
+```js
+// pre-order traverse (parent-left-right)
+bst.traversePreOrder(node => console.log(node.getValue()));
+
+// 50
+// 30
+// 20
+// 40
+// 80
+// 60
+// 90
+```
+
+**.traversePostOrder(cb)** 
+
+```js
+// post-order traverse (left-right-parent)
+bst.traverse(node => console.log(node.getValue()));
+
+// 20
+// 40
+// 30
+// 60
+// 90
+// 80
+// 50
+```
+
+**.traverse(cb, order)** 
+
+traverse the tree in the defined order and apply a callback on each node.
+
+order values: `inOrder`, `preOrder` OR `postOrder`. default is `inOrder`
+
+```js
+bst.traverse(node => console.log(node.getValue())); // in-order
+
+// 20
+// 30
+// 40
+// 50
+// 60
+// 80
+// 90
+
+bst.traverse(node => console.log(node.getValue()), 'preOrder');
+
+// 50
+// 30
+// 20
+// 40
+// 80
+// 60
+// 90
+```
+
+
+**.remove(value)** 
+
+removes a value's node (if exists) from the tree.
+```javascript
+bst.remove(30);
+let n50 = bst.find(50);
+let n40 = bst.find(40);
+console.log(n50.getLeft().getValue()); // 40
+console.log(n40.getLeft().getValue()); // 20
+```
+
+**.clear()** 
+
+clears the tree.
+```javascript
+bst.clear();
+console.log(bst.count()); // 0
+```
+
+## Build
+```
+grunt build
+```
+
+## License
+The MIT License. Full License is [here](https://github.com/datastructures-js/binary-search-tree/blob/master/LICENSE)