Skip to content
Interactive algorithm visualizations
JavaScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
algorithms bfs: Use set instead of array to track `searched` items (#18) Feb 14, 2017
components
cosmos Upgrade Cosmos Oct 24, 2017
frame Improve rendering perf (#15) Feb 13, 2017
layout Layout typos (#26) Feb 20, 2017
pages Upgrade Cosmos Nov 21, 2017
static
utils Add algorithm name to page title (#16) Feb 13, 2017
.babelrc Upgrade to React 16 & Next 4 Oct 17, 2017
.gitignore Publish export instead of running instance (#30) Dec 16, 2018
.prettierignore Upgrade to React 16 & Next 4 Oct 17, 2017
.prettierrc Publish export instead of running instance (#30) Dec 16, 2018
.travis.yml Create test suite via React Cosmos & Jest snapshots (#11) Feb 3, 2017
CODE_OF_CONDUCT.md Add Contributor Covenant Code of Conduct (#27) Feb 22, 2017
CONTRIBUTING.md Add Gif & fix typos Jan 18, 2017
ISSUE_TEMPLATE.md
LICENSE Expand README Jan 18, 2017
README.md Add Contributor Covenant Code of Conduct (#27) Feb 22, 2017
binary-search.gif Add Gif & fix typos Jan 18, 2017
jest.setup.js Upgrade to React 16 & Next 4 Oct 17, 2017
next.config.js Publish export instead of running instance (#30) Dec 16, 2018
package.json Publish export instead of running instance (#30) Dec 16, 2018
yarn.lock Upgrade Cosmos May 13, 2018

README.md

Illustrated Algorithms

Algorithm → AST → CSS (3 x JavaScript)

Binary search

Inspired by Grokking Algorithms and python-execution-trace, this project aims to reveal the mechanics behind algorithms via interactive visualizations of their execution.

Visual representations of variables and operations augment the control flow, alongside actual source code. You can fast forward and rewind the execution to closely observe how an algorithm works.

Disclaimer ✌️

Edge cases and optimizations are beyond the scope of this project. The featured implementations are chosen for their simplicity and do not promise to work for data sets different from the illustrated ones. Please rely on other resources for learning algorithms in depth, from Wikipedia to other visualization projects. Also see community-driven Footnotes. Thanks.

Principles

  • The same code that is displayed next to the illustration is also decorated using babel-plugin-trace-execution and executed to record the context at every step. Literally the same source file.
  • Going back and forth between function execution (and call stack when algorithm uses recursion) is effortless. So is pausing and resuming.
  • Visualizations are easy to follow, fun to play with and simple enough to fit inside the screen of any modern phone.

Work in progress

Dynamic styles

This project uses styled-jsx, but takes the idea of CSS-in-JS even further. Sizing, positioning and transition offsets are computed by JS, all before elements hit the DOM. This provides complete control over layout (e.g. font scaling relative to container width, rounded to a multiplier of 2) and animation (e.g. pausing in the middle of a transition and rewinding). It's a wild concept that hopefully gets mainstream someday.

How to contribute

Consider the following actions if you want to advance this project:

  • Find and/or fix bugs
  • Add tests to babel-plugin-trace-execution
  • Improve rendering perf (already decent, but not ideal due to how styles are applied)
  • Propose algorithms to add (that can fit in a func <=25 lines of ES6)
  • Create elegant illustrations (sketches/wireframes do) – Hello graphic designers and people who draw!

Before submitting a PR, make sure to:

  • Briefly describe the value of your contribution
  • Stay in line with the project's mission (i.e. to make algorithms easy, see above sections)
  • Test code before committing it via npm run test
  • Thoroughly test the visual experience you're creating (e.g. algorithms must fit nicely on the screen)

Development

npm i
# Start Next.js server (localhost:3000)
npm run dev
# Run tests
npm test
# Start React Cosmos playground (localhost:8989)
npm run cosmos

Footnotes

While this project doesn't focus on algorithm implementation specifics, here's a list of valuable insights brought up by the community which serves to complement the visuals.

Binary Search

  • #21 Calculating mid can be improved to avoid overflow when list is sufficiently large enough (@mhaji)

Quicksort


Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

You can’t perform that action at this time.