Merge pull request #4 from iramirezc/chapter-2

Chapter 2: Sorting

Author: Isaac Ramírez

.gitignore

@@ -1,4 +1,8 @@
-# Logs
+# docs output
+docs/html/*
+!docs/html/.gitkeep
+
+# logs
 logs
 *.log
 npm-debug.log*
@@ -7,4 +11,7 @@ yarn-error.log*
 lerna-debug.log*
 
 # npm modules
-node_modules/
+node_modules
+
+# symlinks
+algs4-data

README.md

@@ -2,15 +2,6 @@
 
 Personal notes and JavaScript code for the book Algorithms (4th edition) by Robert Sedgewick & Kevin Wayne.
 
-## Chapters' Notes
-
-* [Chapter 1. Fundamentals](/docs/chapter-1.notes.md)
-* Chapter 2. Sorting
-* Chapter 3. Searching
-* Chapter 4. Graphs
-* Chapter 5. Strings
-* Chapter 6. Context
-
 ## Standard Libraries for JavaScript
 
 * [In](/src/libs/in/in.js)
@@ -19,13 +10,9 @@ Personal notes and JavaScript code for the book Algorithms (4th edition) by Robe
 * [StdOut](/src/libs/std-out/std-out.js)
 * [StdRandom](/src/libs/std-random/std-random.js)
 
-## Benchmarks
-
-* [Linear Search vs. Binary Search](/src/benchmarks/searching/linear-vs-binary-search.js)
-
 ## Algorithms & Data Structures
 
-_For a list similar to the book site see this [algorithms list](/docs/algorithms-list.md)._
+_For a list similar to the book site see this [algorithms list](/markdown/algorithms.md)._
 
 ### Chapter 1. Fundamentals
 
@@ -61,19 +48,27 @@ _For a list similar to the book site see this [algorithms list](/docs/algorithms
 
 **Algorithms:**
 
-> TODO
+* [Selection Sort - p. 249](/src/algorithms/selection-sort/selection-sort.js)
+* [Insertion Sort - p. 251](/src/algorithms/insertion-sort/insertion-sort.js)
+* [Shell Sort - p. 259](/src/algorithms/shell-sort/shell-sort.js)
+* [Merge Sort - p. 273](/src/algorithms/merge-sort/merge-sort.js)
+* [MergeBU Sort - p. 278](/src/algorithms/merge-sort-bu/merge-sort-bu.js)
+* [Quick Sort - p. 289](/src/algorithms/quick-sort/quick-sort.js)
+* [Quick3way Sort - p. 299](/src/algorithms/quick-3way-sort/quick-3way-sort.js)
 
 **ADTs:**
 
-> TODO
+* [MinPQ - p. 311](/src/adts/min-priority-queue/min-priority-queue.js)
+* [MaxPQ - p. 318](/src/adts/max-priority-queue/max-priority-queue.js)
+
+**Clients:**
+
+* [SortCompare - p. 256](/src/examples/test-clients/sort-compare.client.js)
 
 ## Exercise Solutions
 
-:warning: _Do **NOT** copy any of these solutions. These are for my reference only. You should have attempted to solve any of these exercises by your own after at least a few days before even trying to look for the solution. Finally, my solutions can be wrong too._
+:warning: _Do **NOT** copy any of [these solutions](/src/exercises/index.md). These are for my reference only. You should have attempted to solve any of these exercises by your own after at least a few days before even trying to look for the solution. Finally, my solutions can be wrong too._
+
+## Benchmarks
 
-* [Chapter 1. Fundamentals](/src/exercises/index.md)
-* Chapter 2. Sorting
-* Chapter 3. Searching
-* Chapter 4. Graphs
-* Chapter 5. Strings
-* Chapter 6. Context
+* [Linear Search vs. Binary Search](/benchmarks/searching/linear-vs-binary-search.js)

src/benchmarks/searching/linear-vs-binary-search.js renamed to benchmarks/searching/linear-vs-binary-search.js

@@ -1,6 +1,6 @@
 const Benchmark = require('../tools/benchmark')
 const { getSortedArray, getRandomInt } = require('../tools/data-generators')
-const { BinarySearch, LinearSearch } = require('../../algorithms')
+const { BinarySearch, LinearSearch } = require('../../src/algorithms')
 
 class SearchingBenchmark extends Benchmark {
   setUp ({ arraySize }) {

src/benchmarks/tools/benchmark.js renamed to benchmarks/tools/benchmark.js

@@ -28,6 +28,7 @@ class Benchmark {
 
   /**
    * Set up the data for the tests.
+   * @abstract
    * @throws SyntaxError This function should be implemented by the client.
    */
   setUp () {

src/benchmarks/tools/data-generators.js renamed to benchmarks/tools/data-generators.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const { sync } = require('glob')
+
+const [clientName, ...args] = process.argv.slice(2)
+
+const globOptions = { realpath: true, cwd: __dirname }
+
+const files = sync('src/**/*.client.js', globOptions)
+
+const clients = files.reduce((modules, path) => Object.assign(modules, require(path)), {})
+
+if (!clients[clientName]) {
+  throw new ReferenceError(`Client '${clientName}' not found.`)
+}
+
+clients[clientName].main(args)

client

@@ -0,0 +1,47 @@
+{
+  "plugins": [
+    "plugins/markdown",
+    "plugins/my-tags"
+  ],
+  "markdown": {
+    "tags": ["note"]
+  },
+  "recurseDepth": 10,
+  "source": {
+    "include": ["./src"],
+    "exclude": [],
+    "includePattern": ".+\\.js(doc|x)?$",
+    "excludePattern": "(^|\\/|\\\\)_|.+\\.spec\\.js$"
+  },
+  "sourceType": "module",
+  "opts": {
+    "template": "./node_modules/ink-docstrap/template",
+    "encoding": "utf8",
+    "destination": "./docs/html",
+    "recurse": true,
+    "readme": "./README.md"
+  },
+  "tags": {
+    "allowUnknownTags": true,
+    "dictionaries": ["jsdoc", "closure"]
+  },
+  "templates": {
+    "cleverLinks": false,
+    "monospaceLinks": false,
+    "default": {
+      "outputSourceFiles": true,
+      "staticFiles": {
+        "include": ["./static"]
+      },
+      "includeDate": false,
+      "useLongnameInNav": false
+    },
+    "theme": "simplex",
+    "includeDate": false,
+    "navType": "vertical",
+    "inverseNav": false,
+    "outputSourceFiles": true,
+    "linenums": true,
+    "sort": true
+  }
+}

docs/chapter-1.notes.md

@@ -0,0 +1 @@
+The contents of this folder are auto-generated by issuing the command: yarn docs

docs/conf.json

@@ -44,3 +44,26 @@ Every algorithm or ADT has a link pointing to the original Java implementation a
 * QuickUnionUF | [js](/src/algorithms/union-find-quick/union-find-quick.js) | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/QuickUnionUF.java.html) |
 * WeightedQuickUnionUF | [js](/src/algorithms/union-find-weighted/union-find-weighted.js) | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/WeightedQuickUnionUF.java.html) |
 * UF | js | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/UF.java.html) |
+
+### Chapter 2. Sorting
+
+* Insertion | [js](/src/algorithms/insertion-sort/insertion-sort.js) | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/Insertion.java.html) |
+* InsertionX | js | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/InsertionX.java.html) |
+* BinaryInsertion | js | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/BinaryInsertion.java.html) |
+* Selection | [js](/src/algorithms/selection-sort/selection-sort.js) | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/Selection.java.html) |
+* Shell | [js](/src/algorithms/shell-sort/shell-sort.js) | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/Shell.java.html) |
+* Merge | [js](/src/algorithms/merge-sort/merge-sort.js) | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/Merge.java.html) |
+* MergeBU | [js](/src/algorithms/merge-sort-bu/merge-sort-bu.js) | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/MergeBU.java.html) |
+* MergeX | js | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/MergeX.java.html) |
+* Inversions | js | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/Inversions.java.html) |
+* Quick | [js](/src/algorithms/quick-sort/quick-sort.js) | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/Quick.java.html) |
+* Quick3way | [js](/src/algorithms/quick-3way-sort/quick-3way-sort.js) | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/Quick3way.java.html) |
+* QuickX | js | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/QuickX.java.html) |
+* QuickBentleyMcIlroy | js | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/QuickBentleyMcIlroy.java.html) |
+* TopM | [js](/src/adts/min-priority-queue/min-priority-queue.client.js) | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/TopM.java.html) |
+* MaxPQ | [js](/src/adts/max-priority-queue/max-priority-queue.js) | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/MaxPQ.java.html) |
+* MinPQ | [js](/src/adts/min-priority-queue/min-priority-queue.js) | [java](https://algs4.cs.princeton.edu/code/edu/princeton/cs/algs4/MinPQ.java.html) |
+* IndexMinPQ | js | java |
+* IndexMaxPQ | js | java |
+* Multiway | js | java |
+* Heap | js | java |

docs/html/.gitkeep

@@ -0,0 +1,23 @@
+### [Exercise x.x.x](/samples/ex-x.x.x.js)
+
+:pencil2: **Answer**
+
+> your answer here
+
+:memo: **Example**
+
+> your example here
+
+:computer: **Output**
+
+```sh
+# your output here
+```
+
+:warning: **Note**
+
+> your notes here
+
+:bar_chart: **Drawing**
+
+![exercise x.x.x preview](/static/img/octocat.png "Octocat")

docs/algorithms-list.md renamed to docs/markdown/algorithms.md

@@ -0,0 +1,13 @@
+exports.defineTags = function (dictionary) {
+  dictionary.defineTag('note', {
+    onTagged: function (doclet, tag) {
+      const note = `<p><em><strong>NOTE:</strong>&nbsp;${tag.text}</em></p>`
+
+      if (doclet.classdesc) {
+        doclet.classdesc = `${doclet.classdesc}${note}`
+      } else {
+        doclet.description = `${doclet.description || ''}${note}`
+      }
+    }
+  })
+}