common-algorithms v1.0.1

Common algorithms

A small module that contains the most common sorting and searching algorithms.

Installation

npm install --save common-algorithms

Contents

Usage

Using require()

const algorithms = require('common-algorithms')

Using ES6 Import/Export

import * as algorithms from 'common-algorithms'

Exports

The module exports the following object:

{
  search: {
    binarySearch <Function>,
  },
  sort: {
    heapSort <Function>,
    insertionSort <Function>,
    mergeSort <Function>,
    quickSort <Function>,
    selectionSort <Function>,
    shellSort <Function>,
    shuffle <Function>,
  },
}

Custom comparator

A custom comparator can be given as a parameter.

Example 1:

const { quickSort } = require('common-algorithms').sort

const arr = [12, 0, -23, 4, 6, 14, 102, -5];

quickSort(arr, (a, b) => {
  if (a < b) return 1;
  if (a > b) return -1;
  return 0
});

Example 2:

const { quickSort } = require('common-algorithms').sort

function SomeObj(value) {
  this.value = value;
}
        
const arr = [new SomeObj(5), new SomeObj(-5), new SomeObj(-22), new SomeObj(108), new SomeObj(37)];

quickSort(arr, (a, b) => {
  if (a.value < b.value) return -1;
  if (a.value > b.value) return 1;
  return 0;
});