Nimble Package Maestros

    js-sorting

    3.0.4 • Public • Published

    js-sorting

    Build Status

    A collection of sorting algorithms written in JavaScript.

    Detailed information on the complexity of each algorithm is located here. To learn more about how some of the algorithms are implemented, have a look at the technical articles on my blog.

    Installing

    npm install --save js-sorting

    Usage

    See the source files for a list sorts available and their public interfaces, Here is an example for merge sort.

    var mergeSort = require("js-sorting").mergeSort;
     
    // Sort normally
    mergeSort([5, 3, 2, 4, 1]);
     
    // Sort in reverse
    var reverseCompare = function (a, b) {
        return b - a;
    };
    mergeSort([5, 3, 2, 4, 1], reverseCompare);
     
    // Sort complex objects
    var list = [
      { 'firstname': 'John',   'lastname': 'Smith'   },
      { 'firstname': 'Daniel', 'lastname': 'Imms'    },
      { 'firstname': 'Mary',   'lastname': 'Jackson' },
      { 'firstname': 'John',   'lastname': 'Brown'   },
      { 'firstname': 'Mary',   'lastname': 'Harris'  },
    ];
    var complexNameSort = function (a, b) {
      // Sort by first name first
      if (a.firstname.toLowerCase() < b.firstname.toLowerCase()) return -1;
      if (a.firstname.toLowerCase() > b.firstname.toLowerCase()) return 1;
      // Sort by last name second
      if (a.lastname.toLowerCase() < b.lastname.toLowerCase()) return -1;
      if (a.lastname.toLowerCase() > b.lastname.toLowerCase()) return 1;
      return 0;
    };
    mergeSort.sort(list, complexNameSort);

    Observing array changes

    In order to support one of my other projects, various methods are exposed for each sort that allow observation of internal array changes. This can be done by wrapping the functions like so:

    bubbleSort.attachCompareObserver = function (array, a, b) {
      alert('Comparing "' + array[a] + '" (i=' + a + ') with "' +
                            array[b] + '" (i=' + b + ')');
    };
     
    bubbleSort.attachSwapObserver(function (array, a, b) {
      alert('Swapping "' + array[a] + '" (i=' + a + ') with "' +
                           array[b] + '" (i=' + b + ')');
    });

    The functions available are different for each algorithm since not all sorts only do compares and swaps to transform the array in a standard way. For example insertion sort exposes a shift function which shifts an item to a particular index. While this is the same as swapping the item with the adjacent item until it reaches the index, it is achieved in half the number of assignments by only assigning the item being shifted once. The way that this operation is visualised is quite different to just x swaps.

    Contributing

    I'd love to get some contributions for other sorting algorithms, if you want to make a pull request try to follow the existing style of the code and make sure you add tests for the new algorithm.

    Testing locally

    npm install
    npm test
     
    # generate coverage report in ./coverage/ 
    grunt coverage

    License

    MIT © Daniel Imms

    See also

    Install

    npm i js-sorting

    DownloadsWeekly Downloads

    11

    Version

    3.0.4

    License

    MIT

    Last publish

    Collaborators

    • tyriar