ALGOTUTOR(1)

🦋 algotutor 🦋

User Contributed Perl Documentation, the official manual for your new study bestie 💅

✨ NAME ✨

algotutor is an interactive program for observing the intermediate steps of algorithms. It's giving "watch the magic happen in slow motion" 🧚

🌸 SYNOPSIS 🌸

algotutor [OPTION] ... DATA ...

That's the whole formula, bestie: some OPTIONs, then your DATA 💖

💅 DESCRIPTION 💅

Okay so algotutor is made for computer science students and/or literally anyone who studies algorithms and/or data structures 🎀 You make data files in plain text format (technically they're perl anonymous hashes, but honestly you don't need to care 🙈), and algotutor runs through some predefined algorithm for you. Then you can step backward and forward through the execution sequence at different levels of detail. Main character energy 👑 It requires perl-Tk.

DATA is your input data 🧃 For the dynamic programming algorithms, lcs and matc, check their entries in the OPTIONS list below. For everything else, DATA is the name of the file holding your actual input data 📁

🎀 OPTIONS 🎀

• -a ALGO — this picks the algorithm to run 🧠 Right now ALGO can be one of these:
  • bst — operations on binary search trees 🌳
  • rbt — operations on red-black trees (remove() is not implemented yet 💀)
  • heap — operations on heaps. Heads up, the remove operation on a heap always removes the top element, no matter the argument 🙈
  • sbs — stack-based search on graphs, a variant of depth first search
  • bfs — breadth first search on graphs
  • prim — Prim's minimal spanning tree on graphs 🌿
  • dijk — Dijkstra's single-source shortest path on graphs
  • flwa — Floyd-Warshall's all-pair shortest path on graphs (very, very slow 🐌)
  • dom — 2-dimensional point domination
  • graham — Graham's scan for convex hull

💀 Bestie, watch out: rbt's remove() isn't implemented yet, heap's remove always takes the top element no matter what you pass, and flwa is very, very slow.

For lcs, you pass two strings as command line arguments, like so:

algotutor -a lcs AGCTATACGATGACT GTCAGTATAGTCATATG

For matc, you pass an alternating sequence of integers and matrix names as command line arguments. Example:

algotutor -a matc 32 A 35 B 24 C 30 D 36 E 25 F 40 G 34 H 35

That one means finding the optimal multiplication sequence of the chain of matrices: A of size 32 by 35, B of size 35 by 24, ... H of size 34 by 35 🧮🔥

• -s VERTEX — use VERTEX as your starting vertex 📍 (works for sbs, bfs, prim, and dijk)
• -i STEP — display step STEP as the initial image 🖼️
• -d FILENAME — dump the picture into FILENAME as a ps file and exit immediately, skipping interactive mode 📄

📜 LICENSE 📜

This code is distributed under the GNU General Public License ✨

🧑‍💻 AUTHOR 🧑‍💻

Chao-Kuei Hung, ckhung AT ofset DOT org 💜

🔗 SEE ALSO 🔗

Peep /usr/share/doc/algotutor/doc/ for examples and the full set of documentation 📚

---

That's the tea, bestie 🫶 This page came from perl v5.34.0, dated 2022-04-12, and it's filed under ALGOTUTOR(1) 🦋✨ Periodt 💅