README.md

Sorting Algorithm Visualizer and Auralizer

Note

Pull requests are welcome!

Build

cargo build --release && ./target/release/algo-viz-rs [--options] or cargo run --release -- [--options]

Usage

Usage: algo-viz-rs [OPTIONS] [SORTING_ALGO]

Arguments:
  [SORTING_ALGO]  [default: bubblesort] [possible values: bubblesort, insertionsort, selectionsort]

Options:
  -m, --max-val <MAX_VAL>                    [default: 1000]
  -n, --no-rects <NO_RECTS>                  [default: 150]
  -s, --steps-per-second <STEPS_PER_SECOND>  [default: 10]
  -h, --help                                 Print help

Limitations

Audio/Auralization

To auralize the sorting steps I am using the rodio library. Depending on the device and its drivers following may happen: If one goes above around 70 steps, the audio becomes asynchronous and above 100 it disappears completely. This is because the sine waves that get generated do not have a duration long enough for the audio device/drive on the computer to pick up and therefore they are not able to output them.

Platform

Currently tested on Fedora 38 on X11, MacOS 12.

Warning

Wayland fails to load and work!

Algorithms

Currently the following 3 algorithms were implemented:

• Bubblesort
• Insertionsort
• Selectionsort

Dependencies

• Rust Compiler, >=1.67

Warning

For the rust toolchain below 1.67 version 0.8.1 works.

• You may need the systemd-devel package on Fedora based systems, in order for ggez to compile

TODO

• Add further algorithms
  • Mergesort, Quicksort, ...
• Spacing between bars?
• Add GUI wrapping rendering
  • dropdowns for CLI options
• Add cli option for audio range in Hz
• Improve sound at higher SPS, e.g., low-pass filter

Acknowledgments

• The algorithms were adopted from TheAlgorithms/Rust
• Used code examples from rodio and ggez