Algorithm API

You can add or edit your own JavaScript sorting algorithm from the sorting controls on the main page. Choose Add Algorithm to create one, or open the selected algorithm's information dialog to edit its source.

Writing an algorithm

Enter the body of a JavaScript function, without a surrounding function declaration. Audio Sort passes in an object named AS that lets your code inspect the array, compare and swap items, and record sound and visualization markers. You do not need to return the sorted array.

The algorithm runs first, recording steps for later playback. AS.play() records which items should sound during playback; it does not produce sound immediately. Use the AS comparison and swap methods so those operations appear in the visualization and counters.

Methods that accept items take either zero-based array indexes or item objects returned by AS.get(index). A number refers to a position, not the value stored there. For example, AS.lt(0, 1) compares the values of the first two items. An item object keeps referring to the same item even after it moves during a swap.

Example

Paste this insertion sort into the editor to try it. It compares neighboring items, records both for playback, and swaps them until they are in order.

for (let i = 1; i < AS.length(); i++) {
  let j = i;
  while (j > 0 && AS.lt(j, j - 1)) {
    AS.play(j, j - 1);
    AS.swap(j, j - 1);
    j--;
  }
}

Reference