refactor: all common functions for bup and nat in msort_shared.js gave meaningful names to colours

Author: dwangng

src/algorithms/controllers/msort_arr_bup.js

@@ -3,9 +3,22 @@
 
 import { msort_arr_bup } from '../explanations';
 import ArrayTracer from '../../components/DataStructures/Array/Array1DTracer';
+
+
 import {
-  areExpanded,
-} from './collapseChunkPlugin';
+  isMergeCopyExpanded,
+  isMergeExpanded,
+  highlight,
+  highlightB,
+  unhighlight,
+  highlight2Runlength,
+  assignVarToA,
+  assignVarToB,
+  displayMergeLabels,
+  highlightAPointers,
+  set_simple_stack,
+  resetArrayA
+} from './msort_shared.js';
 
 
 const run = run_msort();
@@ -50,51 +63,10 @@ export function initVisualisers() {
   }
 }
 
-// arrayB exists and is displayed only if MergeCopy is expanded
-function isMergeCopyExpanded() {
-  return areExpanded(['MergeCopy']);
-}
-
-// We don't strictly need isMergeExpanded: only needed if last chunk of
-// merge still had extra vars displayed.  Some code still needs
-// isMergeCopyExpanded because it uses arrayB
-function isMergeExpanded() {
-  return areExpanded(['MergeCopy', 'Merge']); // MergeCopy contains Merge
-}
-
 // -------------------------------------------------------------------------------
 // Define helper functions
 // -------------------------------------------------------------------------------
 
-// Highlights Array A either red or green
-// Can add more colours in future
-function highlight(vis, index, color) {
-  if (color == 'red') {
-    vis.array.select(index);
-  }
-  if (color == 'green') {
-    vis.array.patch(index);
-  }
-}
-// Same as highlight() but checks isMergeExpanded()/arrayB is displayed, otherwise does nothing
-function highlightB(vis, index, color) {
-  if (isMergeExpanded()) {
-    if (color == 'red') {
-      vis.arrayB.select(index);
-    }
-    if (color == 'green') {
-      vis.arrayB.patch(index);
-    }
-  }
-}
-
-// Highlights two runlengths two different colours
-function highlight2Runlength(vis, left, mid, right, colorA, colorB) {
-  // highlight first runlength color A
-  for (let i = left; i <= mid; i++) highlight(vis, i, colorA);
-  // highlight second runlength color B
-  for (let j = mid + 1; j <= right; j++) highlight(vis, j, colorB);
-}
 
 // Highlight entire array alternating colors for runlength
 function highlightAllRunlengths(vis, runlength, colorA, colorB, size) {
@@ -103,125 +75,20 @@ function highlightAllRunlengths(vis, runlength, colorA, colorB, size) {
   for (let i = 0; i < size; i++) {
     if (toggle == 0) {
       highlight(vis, i, colorA);
-      console.log("toggle == 0");
     }
     if (toggle == 1) {
       highlight(vis, i, colorB);
-      console.log("toggle == 1");
     }
-    console.log("(i + 1) % runlength = " + (runlength % (i + 1)));
-    console.log("(runlength = " + (runlength));
-    // Switch color after completing a run of length 'runlength'
-    if ((i + 1) % runlength == 0) {
-
-      console.log("(i + 1) % runlength == 0");
-
-      toggle = 1 - toggle; // Flip toggle between 0 and 1
-
-    } console.log("toggle = " + toggle);
-  }
-}
-
-// Unhighlight entire array alternating colors for runlength
-function unhighlightAllRunlengths(vis, runlength, colorA, colorB, size) {
-  let toggle = 0; // 0 = colorA, 1 = colorB
 
-  for (let i = 0; i < size; i++) {
-    if (toggle == 0) {
-      unhighlight(vis, i, colorA);
-      console.log("toggle == 0");
-    }
-    if (toggle == 1) {
-      unhighlight(vis, i, colorB);
-      console.log("toggle == 1");
-    }
-    console.log("(i + 1) % runlength = " + (runlength % (i + 1)));
-    console.log("(runlength = " + (runlength));
     // Switch color after completing a run of length 'runlength'
     if ((i + 1) % runlength == 0) {
-
-      console.log("(i + 1) % runlength == 0");
-
       toggle = 1 - toggle; // Flip toggle between 0 and 1
-
-    } console.log("toggle = " + toggle);
-  }
-}
-
-// unhighlights arrayA
-function unhighlight(vis, index, color) {
-  if (color == 'red') {
-    vis.array.deselect(index);
-  }
-  if (color == 'green') {
-    vis.array.depatch(index);
-  }
-}
-
-function highlightAPointers(vis, ap1, max1, ap2, max2, color) {
-  if (ap1 <= max1) {
-    highlight(vis, ap1, color);
-  }
-  if (ap2 <= max2) {
-    highlight(vis, ap2, color);
-  }
-}
-
-// this function sets array a, highlighting from left to mid red, and set the stack
-function resetArrayA(vis, A, left, mid, right, runlength) {
-  vis.array.set(A, 'msort_arr_bup');
-  highlight2Runlength(vis, left, mid, right, colorA, colorA);
-  set_simple_stack(vis.array, [runlength]);
-}
-
-// Assigns label to array A at index, checks if index is greater than size of array
-// if index is greater than size, assign label to last element in array
-function assignVarToA(vis, variable_name, index, size) {
-  if (index === undefined)
-    vis.array.removeVariable(variable_name);
-  else if (index >= size)
-    vis.array.assignVariable(variable_name, size - 1)
-  else
-    vis.array.assignVariable(variable_name, index);
-}
-
-// Same as above function bet also checks if array B is displayed
-function assignVarToB(vis, variable_name, index, size) {
-  if (isMergeExpanded()) {
-    if (index === undefined)
-      vis.arrayB.removeVariable(variable_name);
-    else if (index >= size)
-      vis.arrayB.assignVariable(variable_name, size - 1);
-    else
-      vis.arrayB.assignVariable(variable_name, index);
+    }
   }
 }
 
-// Display the runlength of the array at the runlength'th element
-function displayRunlength(vis, runlength, size) {
-  let text = 'runlength = ' + runlength;
-  let index = runlength - 1;
-
-  assignVarToA(vis, text, index, size);
-}
-
-// Display all the labels needed for Merge()
-function displayMergeLabels(vis, ap1, max1, ap2, max2, bp, size) {
-  assignVarToA(vis, 'ap1', ap1, size);
-  assignVarToA(vis, 'max1', max1, size);
-  assignVarToA(vis, 'ap2', ap2, size);
-  assignVarToA(vis, 'max2', max2, size);
-  if (isMergeExpanded()) assignVarToB(vis, 'bp', bp, size);
-}
-
 
 
-function set_simple_stack(vis_array, c_stk) {
-  console.log("set_simple_stack" + c_stk);
-  console.log(c_stk);
-  vis_array.setList(c_stk);
-}
-
 /**
  *
  * @param {object} chunker
@@ -259,7 +126,8 @@ export function run_msort() {
     }, [A, B, size], length);
 
     chunker.add('runlength', (vis, c_rlength) => {
-      displayRunlength(vis, c_rlength, size);
+
+      assignVarToA(vis, "runlength", c_rlength, size);
 
       set_simple_stack(vis.array, [c_rlength]);
       highlightAllRunlengths(vis, c_rlength, colorA, colorB, size);
@@ -271,23 +139,23 @@ export function run_msort() {
       chunker.add('MainWhile', (vis, c_rlength, c_left) => {
 
         // display size label
-        assignVarToA(vis, ("size = " + size), size, size);
+        assignVarToA(vis, "size", size, size);
 
+      }, [runlength, left]);
 
+      chunker.add('left', (vis, a, c_left, c_rlength) => {
+        vis.array.set(a, 'msort_arr_bup');
 
-      }, [runlength, left]);
 
-      chunker.add('left', (vis, c_left, c_rlength) => {
         assignVarToA(vis, 'left', c_left, size);
-
-        unhighlightAllRunlengths(vis, c_rlength, colorA, colorB, size);
+        set_simple_stack(vis.array, [c_rlength]);
 
         let left_2 = c_left;
         let mid_2 = (c_rlength + c_left - 1);
         let right_2 = (Math.min(c_rlength * 2, size) - 1);
 
         highlight2Runlength(vis, left_2, mid_2, right_2, colorA, colorB);
-      }, [left, runlength]);
+      }, [A, left, runlength]);
 
       while ((left + runlength) <= size) {
 
@@ -305,8 +173,8 @@ export function run_msort() {
 
         chunker.add('mid', (vis, c_mid, c_rlength) => {
           // remove runlength and size labels
-          assignVarToA(vis, ('runlength = ' + c_rlength), undefined, size);
-          assignVarToA(vis, ('size = ' + (size)), undefined, size);
+          assignVarToA(vis, 'runlength', undefined, size);
+          assignVarToA(vis, 'size', undefined, size);
 
           assignVarToA(vis, 'mid', c_mid, size);
         }, [mid, runlength]);
@@ -321,7 +189,7 @@ export function run_msort() {
 
             // now in the nitty gritty of Merge
             // highlight the two parts you want to merge red
-            resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength);
+            resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength, colorA, colorA);
 
             assignVarToA(vis, 'left', undefined, size); // ap1 replaces left
             assignVarToA(vis, 'ap1', c_ap1, size);
@@ -348,7 +216,6 @@ export function run_msort() {
           if (isMergeExpanded()) {
             assignVarToA(vis, 'right', undefined, size); // max2 replaces right
             assignVarToA(vis, 'max2', c_max2, size);
-
           }
         }, [max2]);
 
@@ -365,7 +232,7 @@ export function run_msort() {
 
           chunker.add('MergeWhile', (vis, a, c_left, c_right, c_mid, c_ap1, c_max1, c_ap2, c_max2, c_bp, c_rlength) => {
 
-            resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength);
+            resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength, colorA, colorA);
 
             displayMergeLabels(vis, c_ap1, c_max1, c_ap2, c_max2, c_bp, size);
 
@@ -387,8 +254,7 @@ export function run_msort() {
 
               if (isMergeExpanded()) vis.arrayB.set(b, 'msort_arr_bup');
 
-              resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength);
-
+              resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength, colorA, colorA);
 
               displayMergeLabels(vis, c_ap1, c_max1, c_ap2, c_max2, c_bp, size);
               // future color: should be colorA & colorB
@@ -402,7 +268,7 @@ export function run_msort() {
             ap1 = ap1 + 1;
             chunker.add('ap1++', (vis, a, c_left, c_mid, c_right, c_rlength,
               c_ap1, c_max1, c_ap2, c_max2, c_bp) => {
-              resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength);
+              resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength, colorA, colorA);
               displayMergeLabels(vis, c_ap1, c_max1, c_ap2, c_max2, c_bp, size);
 
               assignVarToA(vis, 'ap1', c_ap1, size);
@@ -427,7 +293,7 @@ export function run_msort() {
 
             chunker.add('copyap2', (vis, a, b, c_ap1, c_ap2, c_bp, c_max1, c_max2, c_left, c_right, c_mid, c_rlength) => {
               if (isMergeExpanded()) vis.arrayB.set(b, 'msort_arr_bup');
-              resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength);
+              resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength, colorA, colorA);
 
               displayMergeLabels(vis, c_ap1, c_max1, c_ap2, c_max2, c_bp, size);
 
@@ -443,7 +309,7 @@ export function run_msort() {
             ap2 = ap2 + 1;
             chunker.add('ap2++', (vis, a, c_left, c_mid, c_right, c_rlength,
               c_ap1, c_max1, c_ap2, c_max2, c_bp) => {
-              resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength);
+              resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength, colorA, colorA);
               displayMergeLabels(vis, c_ap1, c_max1, c_ap2, c_max2, c_bp, size);
 
               assignVarToA(vis, "ap2", c_ap2, size);
@@ -466,7 +332,7 @@ export function run_msort() {
 
         chunker.add('CopyRest1', (vis, a, b, c_ap1, c_max1, c_left, c_right, c_mid, c_bp, c_rlength) => {
 
-          resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength);
+          resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength, colorA, colorA);
 
           if (isMergeExpanded()) vis.arrayB.set(b, 'msort_arr_bup');
 
@@ -488,7 +354,7 @@ export function run_msort() {
         }
 
         chunker.add('CopyRest2', (vis, a, b, c_ap2, c_max2, c_left, c_right, c_mid, c_rlength) => {
-          resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength);
+          resetArrayA(vis, a, c_left, c_mid, c_right, c_rlength, colorA, colorA);
 
           if (isMergeExpanded()) vis.arrayB.set(b, 'msort_arr_bup');
           assignVarToA(vis, 'ap2', c_ap2, size);
@@ -549,7 +415,7 @@ export function run_msort() {
         set_simple_stack(vis.array, [c_rlength]);
 
         if (c_rlength < size) {
-          displayRunlength(vis, c_rlength, size);
+          assignVarToA(vis, "runlength", c_rlength, size);
         }
 
       }, [runlength]);