algo-helper

"algo-helper" is a javascript algorithms library which allows you to use various kind of sorting and searching algorithms in your project very easily. Our next version will be mainly focusing on Graphs.

Installation

Using npm:

$ npm i -g npm
$ npm i algo-helper

Note: add --save if you are using npm < 5.0.0

How to migrate from v1.0.0 to v2.0.0?

v1.0.0

// Load the build.
import { sort, search } from 'algo-helper'

v2.0.0

// Load the build.
import _algo from 'algo-helper'

Usage:

v1.0.0

// Load the build.
import { sort, search } from 'algo-helper'

let arr = [3,4,7,1,78,54,23]
// Use sort method.
let sortedArray = sort.bubbleSort(arr)

v2.0.0

// Load the build.
import _algo from 'algo-helper'

let arr = [3,4,7,1,78,54,23]
// Use sort method.
let sortedArray = _algo.bubbleSort(arr)

How to import?

ES6:

// Load the build.
import _algo from 'algo-helper'

let arr = [3,4,7,1,78,54,23]
// Use sort method.
let sortedArray = _algo.bubbleSort(arr)

// Use search method.
let index = _algo.linearSearch(arr,7)

In Node.js:

// Load the build.
var _algo = require('algo-helper');

var arr = [3,4,7,1,78,54,23]
// Use sort method.
var sortedArray = _algo.bubbleSort(arr)

// Use search method.
var index = _algo.linearSearch(arr,7)

Example

How to use 'sort' in ES6?

import _algo from 'algo-helper'

const arr = [3,2,34,65,1,8,54]

// How to use bubble sort
let bubbleSortedArr = _algo.bubbleSort(arr)
// console.log(bubbleSortedArr) 
// [1, 2, 3, 8, 34, 54, 65]

// How to use insertion sort
let insertionSortedArr = _algo.insertionSort(arr) 

// How to use selection sort
let selectionSortedArr = _algo.selectionSort(arr) 

// How to use quick sort
/**
 * @param {array} [array=[]] The array to inspect.
 * @param {number1} [number] The number selected from left
 * @param {number2} [number] The number selected from right
 * _algo.quickSort(array, number1, number2) 
 */
let quickSortedArr = _algo.quickSort(arr, 1, 5) 

// How to use merge sort
let mergeSortedArr = _algo.mergeSort(arr) 

// How to use heap sort
let heapSortedArr = _algo.heapSort(arr)

How to use 'search' in ES6?

In searching, you can give the input array as an unsorted array. If the number you are looking for is not available in the array, the output will be -1. Otherwise, you will get the index of the number you have entered.

import _algo from 'algo-helper'

const arr = [3,2,34,65,1,8,54]

// How to use linear search
/**
 * @param {array} [array=[]] The array which is not sorted
 * @param {number1} [number] The number to find
 * _algo.quickSort(array, number1, number2) 
 */
let foundIndexLs = _algo.linearSearch(arr,1)

// How to use binary search
/**
 * @param {number} [number] The number to find
 * @param {arr} [array=[]] The array which is not sorted
 * _algo.quickSort(array, number1, number2) 
 */
let foundIndexBs = _algo.binarySearch(34,arr)

Why algo-helper?

Algo-helper makes JavaScript easier by taking the hassle out of working with algorithms. Algo-helper’s modular methods are great for:

• Searching in arrays
• Sorting arrays
• Create Graphs/ Linked list (next version)
• Graph search (next version)

Author

Dushan Ranasinghe - Full Stack Javascript Developer

Feel free to visit my Github account: dushanranasinghe

License

This project is licensed under the MIT License - see the LICENSE.md file for details