Merge branch 'parkjs814/master'

Author: Kevin Nadro

.gitmodules

@@ -0,0 +1,7 @@
+##This project has seen a high number of contributions from:
+1. [Arka Prava Basu](https://github.com/archie94)
+2. [Kevin Nadro](https://github.com/nadr0)
+3. [Steven Syrek](https://github.com/sjsyrek)
+4. [Jarett Gross](https://github.com/jarettgross)
+
+If you too [want to be on this list](https://github.com/parkjs814/AlgorithmVisualizer/wiki/Contributing), all you need is creative ideas and a dozen Red Bulls!

CONTRIBUTORS.md

@@ -13,6 +13,9 @@ http://parkjs814.github.io/AlgorithmVisualizer
 We encourage you to check out [**Wiki**](https://github.com/parkjs814/AlgorithmVisualizer/wiki) before you get started.
 
 If in need of any help, join our [Gitter](https://gitter.im/parkjs814/AlgorithmVisualizer?utm_source=share-link&utm_medium=link&utm_campaign=share-link) chatroom!
+
+Special thanks to our [Top Contributors](CONTRIBUTORS.md)!
+
 ### Backers
 
 Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/algorithmvisualizer#backer)]

README.md

@@ -18,11 +18,12 @@
          "fibonacci": "Fibonacci Sequence",
          "integer_partition": "Integer Partition",
          "knapsack_problem": "Knapsack Problem",
-         "longest_increasing_subsequence": "Longest Increasing Subsequence",
          "longest_common_subsequence": "Longest Common Subsequence",
+         "longest_increasing_subsequence": "Longest Increasing Subsequence",
          "max_subarray": "Maximum Subarray",
          "max_sum_path": "Maximum Sum Path",
          "pascal_triangle": "Pascal's Triangle",
+         "shortest_common_supersequence": "Shortest Common Supersequence",
          "sliding_window": "Sliding Window",
          "ugly_numbers": "Ugly Numbers"
       },
@@ -69,6 +70,7 @@
    },
    "sorting": {
       "list": {
+         "bucket": "Bucket Sort",
          "bubble": "Bubble Sort",
          "comb": "Comb Sort",
 		 "counting": "Counting Sort",

algorithm/category.json

@@ -0,0 +1,38 @@
+var i,j;
+
+// Fill memo table in bottom up manner 
+for ( i = 0; i <= m; i++ ) {
+	for ( j = 0; j <= n; j++ ) {
+		if( i === 0 ) {
+			A[i][j] = j;
+		} else if ( j === 0 ) {
+			A[i][j] = i;
+		} else if ( string1[i-1] == string2[j-1] ) {
+			tracer1._select ( i-1 )._wait ();
+ 			tracer2._select ( j-1 )._wait ();
+ 			tracer3._select ( i-1, j-1 )._wait ();
+
+			A[i][j] = A[i-1][j-1] + 1;
+
+			tracer1._deselect ( i-1 );
+ 			tracer2._deselect ( j-1 );
+ 			tracer3._deselect ( i-1, j-1 );
+		} else {
+			tracer3._select ( i-1, j )._wait ();
+ 			tracer3._select ( i, j-1 )._wait ();
+
+			if ( A[i-1][j] < A[i][j-1] ) {
+				A[i][j] = 1 + A[i-1][j];
+			} else {
+				A[i][j] = 1 + A[i][j-1];
+			}
+
+			tracer3._deselect ( i-1, j );
+ 			tracer3._deselect ( i, j-1 );
+		}
+		tracer3._notify ( i, j , A[i][j] )._wait ();
+ 		tracer3._denotify( i, j );
+	}
+}
+
+ logger._print ( 'Shortest Common Supersequence is ' + A[m][n] );

algorithm/dp/shortest_common_supersequence/basic/code.js

@@ -0,0 +1,13 @@
+var string1 = 'AGGTAB';
+var string2 = 'GXTXAYB';
+var m = string1.length;
+var n = string2.length;
+var A = new Array (m+1);
+for (var i = 0; i < m+1; i++ ) {
+	A[i] = new Array (n+1);
+}
+
+var tracer1 = new Array1DTracer ( 'String 1')._setData ( string1 );
+var tracer2 = new Array1DTracer ( 'String 2')._setData ( string2 );
+var tracer3 = new Array2DTracer ( 'Memo Table')._setData ( A );
+var logger = new LogTracer ();

algorithm/dp/shortest_common_supersequence/basic/data.js

@@ -0,0 +1,13 @@
+{
+  "Shortest Common Supersequence": "n computer science, the shortest common supersequence problem is a problem closely related to the longest common subsequence problem. Given two sequences X = < x1,...,xm > and Y = < y1,...,yn >, a sequence U = < u1,...,uk > is a common supersequence of X and Y if U is a supersequence of both X and Y. In other words, a shortest common supersequence of strings x and y is a shortest string z such that both x and y are subsequences of z." ,
+  "Complexity": {
+    "time": "O(mn)",
+    "space": "O(mn)"
+  },
+  "References": [
+    "<a href='https://en.wikipedia.org/wiki/Shortest_common_supersequence_problem'>Wikipedia</a>"
+  ],
+  "files": {
+    "basic": "Shortest common supersequence"
+  }
+}

algorithm/dp/shortest_common_supersequence/desc.json

@@ -0,0 +1,34 @@
+//place numbers into appropriate buckets
+for (let i = 0; i < array.length; i++) {
+	var bucketPos = Math.floor(numBuckets * (array[i] / maxValue));
+	buckets[bucketPos].push(array[i]);
+	bucketsCount[bucketPos]++;
+	tracer._select(0, i)._wait();
+	tracer._notify(1, bucketPos, D[1][bucketPos])._wait();
+	tracer._deselect(0, i);
+	tracer._denotify(1, bucketPos, D[1][bucketPos]);
+}
+
+var sortLocation = 0;
+for (let k = 0; k < buckets.length; k++) {
+	//do insertion sort
+	for (let i = 1; i < buckets[k].length; i++) {
+		var key = buckets[k][i];
+		var j;
+		for (j = i - 1; (j >= 0) && (buckets[k][j] > key); j--) {
+			buckets[k][j + 1] = buckets[k][j];
+		}
+		buckets[k][j + 1] = key;
+	}
+	
+	//place ordered buckets into sorted array
+	for (let i = 0; i < buckets[k].length; i++) {
+		sortedArray[sortLocation] = buckets[k][i];
+		bucketsCount[k]--;
+		tracer._notify(1, k, D[1][k]);
+        tracer._notify(2, sortLocation, D[2][sortLocation])._wait();
+		tracer._denotify(1, k, D[1][k]);
+        tracer._denotify(2, sortLocation, D[2][sortLocation]);
+		sortLocation++;
+	}
+}

algorithm/sorting/bucket/basic/code.js

@@ -0,0 +1,24 @@
+var maxValue = 100;
+var arraySize = 10;
+var numBuckets = 5;
+
+//initialize array values
+var array = Array1D.random(arraySize, 0, maxValue - 1);
+var buckets = [];
+var bucketsCount = [];
+var sortedArray = [];
+for (let i = 0; i < arraySize; i++) {
+    if (i < numBuckets) {
+		buckets[i] = [];
+		bucketsCount[i] = 0;
+	}
+    sortedArray[i] = 0;
+}	
+var D = [
+    array,
+    bucketsCount,
+    sortedArray
+];
+
+var tracer = new Array2DTracer();
+tracer._setData(D);

algorithm/sorting/bucket/basic/data.js

@@ -0,0 +1,13 @@
+{
+  "Bucket Sort": "Bucket sort, or bin sort, is a sorting algorithm that works by distributing the elements of an array into a number of buckets. Each bucket is then sorted individually, either using a different sorting algorithm, or by recursively applying the bucket sorting algorithm.",
+  "Complexity": {
+    "time": "worst O(n<sup>2</sup>), best O(n+k), average O(n+k) where n is the number of buckets and k is the range of the input",
+    "space": "worst O(n*k)"
+  },
+  "References": [
+    "<a href='https://en.wikipedia.org/wiki/Bucket_sort'>Wikipedia</a>"
+  ],
+  "files": {
+    "basic": "Bucket sort"
+  }
+}

algorithm/sorting/bucket/desc.json

@@ -43,11 +43,27 @@ class DirectedGraphTracer extends Tracer {
     return this;
   }
 
+  _setNodePositions(positions) {
+    this.manager.pushStep(this.capsule, {
+      type: 'setNodePositions',
+      positions: positions
+    });
+    return this;
+  }
+
   processStep(step, options) {
     switch (step.type) {
       case 'setTreeData':
         this.setTreeData.apply(this, step.arguments);
         break;
+      case 'setNodePositions':
+        $.each(this.graph.nodes(), (i, node) => {
+          if (i >= step.positions.length) return false;
+          const position = step.positions[i];
+          node.x = position.x;
+          node.y = position.y;
+        });
+        break;
       case 'visit':
       case 'leave':
         var visit = step.type == 'visit';
@@ -116,7 +132,6 @@ class DirectedGraphTracer extends Tracer {
 
   setData(G, undirected) {
     if (super.setData.apply(this, arguments)) return true;
-
     this.graph.clear();
     const nodes = [];
     const edges = [];

js/module/tracer/directed_graph.js

@@ -0,0 +1,23 @@
+**Array1DTracer** inherits **[Array2DTracer](Array2DTracer)**.
+
+## Methods
+
+| Method | Description |
+|--------|-------------|
+| **Array1DTracer**((String) name) | create Array1DTracer and set its name |
+| **attach**((ChartTracer) chartTracer)| automatically visualize array data to the bar chart |
+| **palette**((Object) {selected, notified, default})| set colors (e.g., `{selected: 'green', notified: '#FFA500', default: 'rgb(255,255,255)'}`) |
+| **_setData**((Number[]) data)| set one-dimensional array data to visualize |
+| **_notify**((Number) idx, (Number) v) | notify that the value of element _idx_ has been changed to _v_ |
+| **_denotify**((Number) idx) | stop notifying that the value of element _idx_ has been changed |
+| **_select**((Number) s, (Number) e) | select a range between elements _s_ and _e_ |
+| **_select**((Number) idx) | select element _idx_ |
+| **_deselect**((Number) s, (Number) e) | deselect a range between elements _s_ and _e_ |
+| **_deselect**((Number) idx) | deselect element _idx_ |
+| **_separate**((Number) idx) | put a divider between elements _idx_ and (_idx+1_) |
+| **_deseparate**((Number) idx) | remove a divider between elements _idx_ and (_idx+1_) |
+| **_clear**() | erase traces on the array |
+| **_wait**() | wait for a certain amount of time |
+
+## Usage
+[Show examples](https://github.com/search?utf8=✓&q=Array1DTracer+repo%3Aparkjs814%2FAlgorithmVisualizer+path%3A%2Falgorithm&type=Code&ref=advsearch&l=&l=)

wiki

@@ -0,0 +1,34 @@
+**Array2DTracer** inherits **[Tracer](Tracer)**.
+
+## Methods
+
+| Method | Description |
+|--------|-------------|
+| **Array2DTracer**((String) name)| create Array2DTracer and set its name |
+| **palette**((Object) {selected, notified, default})| set colors (e.g., `{selected: 'green', notified: '#FFA500', default: 'rgb(255,255,255)'}`) |
+| **_setData**((Number[][]) data)| set two-dimensional array data to visualize |
+| **_notify**((Number) x, (Number) y, (Number) v) | notify that the value of (x, y) has been changed to _v_ |
+| **_denotify**((Number) x, (Number) y) | stop notifying that the value of (x, y) has been changed |
+| **_select**((Number) sx, (Number) sy, (Number) ex, (Number) ey) | select a rectangle formed by (sx, sy) and (ex, ey) |
+| **_select**((Number) x, (Number) y) | select (x, y) |
+| **_selectRow**((Number) x, (Number) sy, (Number) ey) | equivalent to **_select**(x, sy, x, ey) |
+| **_selectCol**((Number) y, (Number) sx, (Number) ex) | equivalent to **_select**(sx, y, ex, y) |
+| **_deselect**((Number) sx, (Number) sy, (Number) ex, (Number) ey) | deselect a rectangle formed by (sx, sy) and (ex, ey) |
+| **_deselect**((Number) x, (Number) y) | deselect (x, y) |
+| **_deselectRow**((Number) x, (Number) sy, (Number) ey) | equivalent to **_deselect**(x, sy, x, ey) |
+| **_deselectCol**((Number) y, (Number) sx, (Number) ex) | equivalent to **_deselect**(sx, y, ex, y) |
+| **_separate**((Number) x, (Number) y) | put dividers between _x_-th and (_x+1_)-th rows and between _y_-th and (_y+1_)-th columns |
+| **_separateRow**((Number) x) | put a divider between _x_-th and (_x+1_)-th rows |
+| **_separateCol**((Number) y) | put a divider between _y_-th and (_y+1_)-th columns |
+| **_deseparate**((Number) x, (Number) y) | remove dividers between _x_-th and (_x+1_)-th rows and between _y_-th and (_y+1_)-th columns |
+| **_deseparateRow**((Number) x) | remove a divider between _x_-th and (_x+1_)-th rows |
+| **_deseparateCol**((Number) y) | remove a divider between _y_-th and (_y+1_)-th columns |
+| **_clear**() | erase traces on the array |
+| **_wait**() | wait for a certain amount of time |
+
+## Child Modules
+
+* [Array1DTracer](Array1DTracer)
+
+## Usage
+[Show examples](https://github.com/search?utf8=✓&q=Array2DTracer+repo%3Aparkjs814%2FAlgorithmVisualizer+path%3A%2Falgorithm&type=Code&ref=advsearch&l=&l=)

wiki/Array1DTracer.md

@@ -0,0 +1,20 @@
+**ChartTracer** inherits **[Tracer](Tracer)**.
+
+## Methods
+
+| Method | Description |
+|--------|-------------|
+| **ChartTracer**((String) name)| create ChartTracer and set its name |
+| **palette**((Object) {selected, notified, default})| set colors (e.g., `{selected: 'green', notified: '#FFA500', default: 'rgb(255,255,255)'}`) |
+| **_setData**((Number[]) data)| set one-dimensional array data to visualize |
+| **_notify**((Number) idx, (Number) v) | notify that the value of element _idx_ has been changed to _v_ |
+| **_denotify**((Number) idx) | stop notifying that the value of element _idx_ has been changed |
+| **_select**((Number) s, (Number) e) | select a range between elements _s_ and _e_ |
+| **_select**((Number) idx) | select element _idx_ |
+| **_deselect**((Number) s, (Number) e) | deselect a range between elements _s_ and _e_ |
+| **_deselect**((Number) idx) | deselect element _idx_ |
+| **_clear**() | erase traces on the chart |
+| **_wait**() | wait for a certain amount of time |
+
+## Usage
+[Show examples](https://github.com/search?utf8=✓&q=ChartTracer+repo%3Aparkjs814%2FAlgorithmVisualizer+path%3A%2Falgorithm&type=Code&ref=advsearch&l=&l=)

wiki/Array2DTracer.md

@@ -0,0 +1,50 @@
+**NOTE**: Check out [**Project Details**](Project-Details) before running it locally!
+
+To add changes and improvements or resolve issues, these are the usual steps:
+
+1. Fork the project on Github then clone it to your machine:
+  
+  ```bash
+  git clone https://github.com/<your-username>/AlgorithmVisualizer # clone your forked repo
+  cd AlgorithmVisualizer                                           # navigate inside the created directory
+  git submodule init                                               # initialize wiki submodule
+  git submodule update                                             # setup wiki submodule updates
+  ```
+2. Your fork's remote repository should be named `origin` by default, so add the main repository as a remote as well and give it a name to distinguish it from your fork (something like `main` would work):
+
+  ```bash
+  git remote add main https://github.com/parkjs814/AlgorithmVisualizer
+  ```
+
+3. Create a branch addressing the issue/improvement you'd like to tackle.
+
+  ```bash
+  git checkout -b my-problem-fixer-branch
+  ```
+
+4. Make your changes and push to `my-problem-fixer-branch` on your repo
+
+  ```bash
+  # write some awesome code and then ...
+  git add .
+  git commit -m "Explain my awesome changes"
+  git push origin my-problem-fixer-branch
+  ```
+
+5. Next create a pull request from `my-problem-fixer-branch` branch on `origin` to `master` branch on `main`.
+
+6. Once approved, just delete `my-problem-fixer-branch` both locally and remotely because it's not needed anymore.
+
+7. Finally, checkout `master` locally, pull the approved changes from the `main` repo, and push them to your `origin` repo:
+
+  ```bash
+  git checkout master  # checkout master locally
+  git pull main master # pull new changes from main repository
+  git push main master # push the changes to your fork
+  ```
+
+That's it, everything should be in sync now.
+
+If you run into problems, feel free to [ask us for help on gitter](https://gitter.im/parkjs814/AlgorithmVisualizer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+As mentioned, check out [**Project Details**](Project-Details) for more information on how to run the project.

wiki/ChartTracer.md

@@ -0,0 +1,23 @@
+**DirectedGraphTracer** inherits **[Tracer](Tracer)**.
+
+## Methods
+
+| Method | Description |
+|--------|-------------|
+| **DirectedGraphTracer**((String) name)| create DirectedGraphTracer and set its name |
+| **attach**((LogTracer) logTracer)| automatically print log when visiting or leaving nodes |
+| **palette**((Object) {visited, left, default})| set colors (e.g., `{visited: 'green', left: '#FFA500', default: 'rgb(255,255,255)'}`) |
+| **_setTreeData**((Number[][]) tree, (Number) root) | set tree data to visualize |
+| **_setData**((Number[][]) graph) | set graph data to visualize |
+| **_visit**((Number) target, (Number) source) | visit _target_ node from _source_ node |
+| **_leave**((Number) target, (Number) source) | leave _target_ node to _source_ node |
+| **_clear**() | erase traces on the graph |
+| **_wait**() | wait for a certain amount of time |
+
+## Child Modules
+
+* [UndirectedGraphTracer](UndirectedGraphTracer)
+* [WeightedDirectedGraphTracer](WeightedDirectedGraphTracer)
+
+## Usage
+[Show examples](https://github.com/search?utf8=✓&q=DirectedGraphTracer+repo%3Aparkjs814%2FAlgorithmVisualizer+path%3A%2Falgorithm&type=Code&ref=advsearch&l=&l=)