Merge pull request #37 from lamafab/lamafab-algos-data-ii

Cheatsheets for CM2035 Algorithms & Data Structures II

Author: sglavoie

level-5/algorithms-and-data-structures-ii/student-notes/fabio-lama/README.md

@@ -0,0 +1,69 @@
+# About
+
+Listed here is a collection of cheatsheet by topic. Those cheatsheets do not
+explain the topics in depth, but rather serve as quick lookup documents.
+Therefore, the course material provided by the lecturer should still be studied
+and understood. Not everything that is tested at the mid-terms or final exams is
+covered and the Author does not guarantee that the cheatsheets are free of
+errors.
+
+* [Time and Space Complexity](./cheatsheet_time_space_complexity.pdf)
+* [Asymptotic Analysis](./cheatsheet_asymptotic_analysis.pdf)
+* [Time Complexity of Recursive Algorithms](.cheatsheet_time_complexity_recursive_algorithms.pdf)
+* [Comparison and Non-Comparison Sorting Algorithms](./cheatsheet_sorting_algorithms.pdf)
+* [Hash Tables](./cheatsheet_hash_tables.pdf)
+
+**NOTE**: Those cheatsheets only cover the course material **up to the midterms**.
+The weeks after the midterms are not covered here.
+
+# Building
+
+_NOTE_: This step is only necessary if you chose to modify the base documents.
+
+The base documents are written in [AsciiDoc](https://asciidoc.org/) and can be
+found in the `src/` directory.
+
+The following dependencies must be installed (Ubuntu):
+
+```console
+$ apt install -y ruby-dev wkhtmltopdf
+$ gem install asciidoctor
+$ chmod +x build.sh
+```
+
+To build the documents (PDF version):
+
+```console
+$ ./build.sh pdf
+```
+
+Optionally, for the HTML version:
+
+```console
+$ ./build.sh html
+```
+
+and for the PNG version:
+
+```console
+$ ./build.sh png
+```
+
+The generated output can be deleted with `./build.sh clean`.
+
+# Disclaimer
+
+The Presented Documents ("cheatsheets") by the Author ("Fabio Lama") are
+summaries of specific topics. The term "cheatsheet" implies that the Presented
+Documents are intended to be used as learning aids or as references for
+practicing and does not imply that the Presented Documents should be used for
+inappropriate practices during exams such as cheating or other offenses.
+
+The Presented Documents are heavily based on the learning material provided by
+the University of London, respectively the VLeBooks Collection database in the
+Online Library and the material provided on the Coursera platform.
+
+The Presented Documents may incorporate direct or indirect definitions,
+examples, descriptions, graphs, sentences and/or other content used in those
+provided materials. **At no point does the Author present the work or ideas
+incorporated in the Presented Documents as their own.**

level-5/algorithms-and-data-structures-ii/student-notes/fabio-lama/build.sh

@@ -0,0 +1,77 @@
+#!/bin/bash
+
+# Because `make` sucks.
+
+gen_html() {
+    # Remove suffix and prefix
+    FILE=$1
+    OUT=${FILE%.adoc}
+    HTML_OUT="cheatsheet_${OUT}.html"
+
+    asciidoctor $FILE -o ${HTML_OUT}
+}
+
+# Change directory to src/ in order to have images included correctly.
+cd "$(dirname "$0")/src/"
+
+case $1 in
+    html)
+        for FILE in *.adoc
+        do
+            # Generate HTML file.
+            gen_html ${FILE}
+        done
+
+        # Move up from src/
+        mv *.html ../
+        ;;
+    pdf)
+        for FILE in *.adoc
+        do
+            # Generate HTML file.
+            gen_html ${FILE}
+
+            # Convert HTML to PDF.
+            PDF_OUT="cheatsheet_${OUT}.pdf"
+            wkhtmltopdf \
+                --enable-local-file-access \
+                --javascript-delay 2000\
+                $HTML_OUT $PDF_OUT
+        done
+
+        # Move up from src/
+        mv *.pdf ../
+
+        # Cleanup temporarily generated HTML files.
+        rm *.html > /dev/null 2>&1
+        ;;
+    png | img)
+        for FILE in *.adoc
+        do
+            # Generate HTML file.
+            gen_html ${FILE}
+
+            # Convert HTML to PNG.
+            IMG_OUT="cheatsheet_${OUT}.png"
+            wkhtmltopdf \
+                --enable-local-file-access \
+                --javascript-delay 2000\
+                $HTML_OUT $IMG_OUT
+        done
+
+        # Move up from src/
+        mv *.png ../
+
+        # Cleanup temporarily generated HTML files.
+        rm *.html > /dev/null 2>&1
+        ;;
+    clean)
+        rm *.html > /dev/null 2>&1
+        rm *.png > /dev/null 2>&1
+        rm ../*.html > /dev/null 2>&1
+        rm ../*.png > /dev/null 2>&1
+        ;;
+    *)
+        echo "Unrecognized command"
+        ;;
+esac