linny-r 2.0.8 → 2.0.9

package/static/scripts/linny-r-gui-undo-redo.js

@@ -72,19 +72,17 @@ class UndoEdit {
   }
 
   setSelection() {
-    // Compile the list of IDs of selected entities
+    // Compile the list of IDs of selected entities.
     this.selection.length = 0;
-    for(let i = 0; i < MODEL.selection.length; i++) {
-      this.selection.push(MODEL.selection[i].identifier);
-    }
+    for(const obj of MODEL.selection) this.selection.push(obj.identifier);
   }
   
   get getSelection() {
-    // Return the list of entities that were selected at the time of the action
+    // Return the list of entities that were selected at the time of the action.
     const ol = [];
-    for(let i = 0; i < this.selection.length; i++) {
-      const obj = MODEL.objectByID(this.selection[i]);
-      // Guard against pushing NULL pointers in case object is not found
+    for(const id of this.selection) {
+      const obj = MODEL.objectByID(id);
+      // Guard against pushing NULL pointers in case object is not found.
       if(obj) ol.push(obj);
     }
     return ol;
@@ -93,8 +91,8 @@ class UndoEdit {
 
 
 // CLASS UndoStack
-// NOTE: this object actually comprises TWO stacks -- one with undoable actions
-// and one with redoable actions
+// NOTE: This object actually comprises TWO stacks -- one with undoable actions
+// and one with redoable actions.
 class UndoStack {
   constructor() {
     this.undoables = [];
@@ -108,36 +106,36 @@ class UndoStack {
   }
   
   get topUndo() {
-    // Return the short name of the top undoable action (if any)
-    const i = this.undoables.length;
-    if(i > 0) return this.undoables[i - 1].action;
+    // Return the short name of the top undoable action (if any).
+    const n = this.undoables.length;
+    if(n > 0) return this.undoables[n - 1].action;
     return false;    
   }
 
   get canUndo() {
-    // Return the "display name" of the top undoable action (if any)
-    const i = this.undoables.length;
-    if(i > 0) return `Undo "${this.undoables[i - 1].fullAction}"`;
+    // Return the "display name" of the top undoable action (if any).
+    const n = this.undoables.length;
+    if(n > 0) return `Undo "${this.undoables[n - 1].fullAction}"`;
     return false;
   }
   
   get topRedo() {
-    // Return the short name of the top undoable action (if any)
-    const i = this.redoables.length;
-    if(i > 0) return this.redoables[i - 1].action;
+    // Return the short name of the top undoable action (if any).
+    const n = this.redoables.length;
+    if(n > 0) return this.redoables[n - 1].action;
     return false;    
   }
 
   get canRedo() {
-    // Return the "display name" of the top redoable action (if any)
-    const i = this.redoables.length;
-    if(i > 0) return `Redo "${this.redoables[i - 1].fullAction}"`;
+    // Return the "display name" of the top redoable action (if any).
+    const n = this.redoables.length;
+    if(n > 0) return `Redo "${this.redoables[n - 1].fullAction}"`;
     return false;
   }
   
   addXML(xml) {
     // Insert xml at the start (!) of any XML added previously to the UndoEdit
-    // at the top of the UNDO stack
+    // at the top of the UNDO stack.
     const i = this.undoables.length;
     if(i === 0) return false;
     this.undoables[i-1].xml = xml + this.undoables[i-1].xml;
@@ -145,7 +143,7 @@ class UndoStack {
 
   addOffset(dx, dy) {
     // Add (dx, dy) to the offset of the "move" UndoEdit that should be at the
-    // top of the UNDO stack
+    // top of the UNDO stack.
     let i = this.undoables.length;
     if(i === 0) return false;
     this.undoables[i-1].properties[3] += dx;
@@ -154,115 +152,116 @@ class UndoStack {
 
   push(action, args=null, tentative=false) {
     // Add an UndoEdit to the undo stack, labeled with edit action that is
-    // about to be performed. NOTE: the IDs of objects are stored, rather than
-    // the objects themselves, because deleted objects will have different
-    // memory addresses when restored by an UNDO
+    // about to be performed.
+    // NOTE: The IDs of objects are stored, rather than the objects themselves,
+    // because deleted objects will have different memory addresses when
+    // restored by an UNDO.
 
-    // Any action except "move" is likely to invalidate the solver result
+    // Any action except "move" is likely to invalidate the solver result.
     if(action !== 'move' && !(
       // Exceptions:
       // (1) adding/modifying notes
       (args instanceof Note)
         )) VM.reset();
 
-    // If this edit is new (i.e., not a redo) then remove all "redoable" edits
+    // If this edit is new (i.e., not a redo) then remove all "redoable" edits.
     if(!tentative) this.redoables.length = 0;
-    // If the undo stack is full then discard its bottom edit
+    // If the undo stack is full, then discard its bottom edit.
     if(this.undoables.length == CONFIGURATION.undo_stack_size) this.undoables.splice(0, 1);
     const ue = new UndoEdit(action);
-    // For specific actions, store the IDs of the selected entities
+    // For specific actions, store the IDs of the selected entities.
     if(['move', 'delete', 'drop', 'lift'].indexOf(action) >= 0) {
       ue.setSelection();
     }
-    // Set the properties of this undoable, depending on the type of action
+    // Set the properties of this undoable, depending on the type of action.
     if(action === 'move') {
-      // `args` holds the dragged node => store its ID and position
-      // NOTE: for products, use their ProductPosition in the focal cluster
+      // `args` holds the dragged node => store its ID and position.
+      // NOTE: For products, use their ProductPosition in the focal cluster.
       const obj = (args instanceof Product ?
           args.positionInFocalCluster : args);
       ue.properties = [args.identifier, obj.x, obj.y, 0, 0];
       // NOTE: object_id is NOT set, as dragged selection may contain
-      // multiple entities
+      // multiple entities.
     } else if(action === 'add') {
-      // `args` holds the added entity => store its ID
+      // `args` holds the added entity => store its ID.
       ue.object_id = args.identifier;
     } else if(action === 'drop' || action === 'lift') {
-      // Store ID of target cluster
+      // Store ID of target cluster.
       ue.object_id = args.identifier;
       ue.properties = MODEL.getSelectionPositions;
     } else if(action === 'replace') {
-      // Replace passes its undo information as an object
+      // Replace passes its undo information as an object.
       ue.properties = args;
     }
 
-    // NOTE: for a DELETE action, no properties are stored; the XML needed to
-    // restore deleted entities will be added by the respective delete methods
+    // NOTE: For a DELETE action, no properties are stored; the XML needed to
+    // restore deleted entities will be added by the respective delete methods.
 
-    // Push the new edit onto the UNDO stack
+    // Push the new edit onto the UNDO stack.
     this.undoables.push(ue);
     // Update the GUI buttons
     UI.updateButtons();
-    // NOTE: update the Finder only if needed, and with a delay because
-    // the "prepare for undo" is performed before the actual change 
+    // NOTE: Update the Finder only if needed, and with a timeout because
+    // the "prepare for undo" is performed before the actual change.
     if(action !== 'move') setTimeout(() => { FINDER.updateDialog(); }, 5);
-//console.log('push ' + action);
-//console.log(UNDO_STACK);
   }
 
   pop(action='') {
-    // Remove the top edit (if any) from the stack if it has the specified action
-    // NOTE: pop does NOT undo the action (the model is not modified)
+    // Remove the top edit (if any) from the stack if it has the specified action.
+    // NOTE: `pop` does NOT undo the action (the model is not modified).
     let i = this.undoables.length - 1;
     if(i >= 0 && (action === '' || this.undoables[i].action === action)) {
       this.undoables.pop();
       UI.updateButtons();
     }
-//console.log('pop ' + action);
-//console.log(UNDO_STACK);
   }
 
   doMove(ue) {
-    // This method implements shared code for UNDO and REDO of "move" actions
-    // First get the dragged node
+    // This method implements shared code for UNDO and REDO of "move" actions.
+    // First get the dragged node.
     let obj = MODEL.objectByID(ue.properties[0]); 
     if(obj) {
-      // For products, use the x and y of the ProductPosition
+      // For products, use the x and y of the ProductPosition.
       if(obj instanceof Product) obj = obj.positionInFocalCluster;
-      // Calculate the relative move (dx, dy)
+      // Calculate the relative move (dx, dy).
       const
           dx = ue.properties[1] - obj.x,
           dy = ue.properties[2] - obj.y,
           tdx = -ue.properties[3],
           tdy = -ue.properties[4];
       // Update the undo edit's x and y properties so that it can be pushed onto
-      // the other stack (as the dragged node ID and the selection stays the same)
+      // the other stack (as the dragged node ID and the selection stay the same).
       ue.properties[1] = obj.x;
       ue.properties[2] = obj.y;
-      // Prepare to translate back (NOTE: this will also prepare for REDO)
+      // Prepare to translate back. NOTE: this will also prepare for REDO.
       ue.properties[3] = tdx;
       ue.properties[4] = tdy;
-      // Translate the entire graph (NOTE: this does nothing if dx and dy both equal 0)
+      // Translate the entire graph.
+      // NOTE: This does nothing if dx and dy both equal 0.
       MODEL.translateGraph(tdx, tdy);
-      // Restore the selection as it was at the time of the "move" action
+      // Restore the selection as it was at the time of the "move" action.
       MODEL.selectList(ue.getSelection);
-      // Move the selection back to its original position
+      // Move the selection back to its original position.
       MODEL.moveSelection(dx - tdx, dy - tdy);
     }
   }
   
   restoreFromXML(xml) {
     // Restore deleted objects from XML and add them to the UndoEdit's selection
-    // (so that they can be RE-deleted)
+    // (so that they can be RE-deleted).
     // NOTES:
     // (1) Store focal cluster, because this may change while initializing a
-    //     cluster from XML
+    //     cluster from XML.
     // (2) Set "selected" attribute of objects to FALSE, as the selection will
-    //     be restored from UndoEdit
+    //     be restored from UndoEdit.
     const n = parseXML(MODEL.xml_header + `<edits>${xml}</edits>`);
     if(n && n.childNodes) {
-      let c, li = [], ppi = [], ci = [];  
+      const
+          li = [],
+          ppi = [],
+          ci = [];  
       for(let i = 0; i < n.childNodes.length; i++) {
-        c = n.childNodes[i];
+        const c = n.childNodes[i];
       // Immediately restore "independent" entities ...
         if(c.nodeName === 'dataset') {
           MODEL.addDataset(xmlDecoded(nodeContentByTag(c, 'name')), c);
@@ -281,7 +280,7 @@ class UndoStack {
           obj.selected = false;
         } else if(c.nodeName === 'chart') {
           MODEL.addChart(xmlDecoded(nodeContentByTag(c, 'title')), c);
-        // ... but merely collect indices of other entities
+        // ... but merely collect indices of other entities.
         } else if(c.nodeName === 'link' || c.nodeName === 'constraint') {
           li.push(i);
         } else if(c.nodeName === 'product-position') {
@@ -290,12 +289,12 @@ class UndoStack {
           ci.push(i);
         }
       }
-      // NOTE: collecting the indices of links, product positions and clusters
-      // saves the effort to iterate over ALL childnodes again
-      // First restore links and constraints
-      for(let i = 0; i < li.length; i++) {
-        c = n.childNodes[li[i]];
-        // Double-check that this node defines a link or a constraint
+      // NOTE: Collecting the indices of links, product positions and clusters
+      // saves the effort to iterate over ALL childnodes again.
+      // First restore links and constraints.
+      for(const i of li) {
+        const c = n.childNodes[i];
+        // Double-check that this node defines a link or a constraint.
         if(c.nodeName === 'link' || c.nodeName === 'constraint') {
           let name = xmlDecoded(nodeContentByTag(c, 'from-name'));
           let actor = xmlDecoded(nodeContentByTag(c, 'from-owner'));
@@ -319,10 +318,10 @@ class UndoStack {
       // Then restore product positions.
       // NOTE: These correspond to the products that were part of the
       // selection; all other product positions are restored as part of their
-      // containing clusters
-      for(let i = 0; i < ppi.length; i++) {
-        c = n.childNodes[ppi[i]];
-        // Double-check that this node defines a product position
+      // containing clusters.
+      for(const i of ppi) {
+        const c = n.childNodes[i];
+        // Double-check that this node defines a product position.
         if(c.nodeName === 'product-position') {
           const obj = MODEL.nodeBoxByID(UI.nameToID(
             xmlDecoded(nodeContentByTag(c, 'product-name'))));
@@ -334,10 +333,10 @@ class UndoStack {
       }
       // Lastly, restore clusters.
       // NOTE: Store focal cluster, because this may change while initializing
-      // a cluster from XML
+      // a cluster from XML.
       const fc = MODEL.focal_cluster;
-      for(let i = 0; i < ci.length; i++) {
-        c = n.childNodes[ci[i]];
+      for(const i of ci) {
+        const c = n.childNodes[i];
         if(c.nodeName === 'cluster') {
           const obj = MODEL.addCluster(xmlDecoded(nodeContentByTag(c, 'name')),
             xmlDecoded(nodeContentByTag(c, 'owner')), c);
@@ -350,7 +349,7 @@ if (MODEL.focal_cluster === fc) {
   console.log('Refocusing from ... to ... : ', MODEL.focal_cluster, fc);
 }
           // Restore original focal cluster because addCluster may shift focus
-          // to a sub-cluster
+          // to a sub-cluster.
           MODEL.focal_cluster = fc;
         }
       }
@@ -359,15 +358,15 @@ if (MODEL.focal_cluster === fc) {
   }
   
   undo() {
-    // Undo the most recent "undoable" action
+    // Undo the most recent "undoable" action.
     let ue;
     if(this.undoables.length > 0) {
       UI.reset();
-      // Get the action to be undone
+      // Get the action to be undone.
       ue = this.undoables.pop();
-      // Focus on the cluster that was focal at the time of action
-      // NOTE: do this WITHOUT calling UI.makeFocalCluster because this
-      // clears the selection and redraws the graph
+      // Focus on the cluster that was focal at the time of action.
+      // NOTE: Do this WITHOUT calling UI.makeFocalCluster because this
+      // clears the selection and redraws the graph.
       MODEL.focal_cluster = ue.cluster;
 //console.log('undo' + ue.fullAction);
 //console.log(ue);
@@ -441,7 +440,7 @@ if (MODEL.focal_cluster === fc) {
       } else if(ue.action === 'replace') {
         let uep = ue.properties,
             p = MODEL.objectByName(uep.p);
-        // First check whether product P needs to be restored
+        // First check whether product P needs to be restored.
         if(!p && ue.xml) {
           const n = parseXML(MODEL.xml_header + `<edits>${ue.xml}</edits>`);
           if(n && n.childNodes) {
@@ -454,36 +453,36 @@ if (MODEL.focal_cluster === fc) {
           }
         }
         if(p) {
-          // Restore product position of P in focal cluster
+          // Restore product position of P in focal cluster.
           MODEL.focal_cluster.addProductPosition(p, uep.x, uep.y);
-          // Restore links in/out of P
-          for(let i = 0; i < uep.lt.length; i++) {
-            const l = MODEL.linkByID(uep.lt[i]);
+          // Restore links in/out of P.
+          for(const id of uep.lt) {
+            const l = MODEL.linkByID(id);
             if(l) {
               const ml = MODEL.addLink(l.from_node, p);
               ml.copyPropertiesFrom(l);
               MODEL.deleteLink(l);
             }
           }
-          for(let i = 0; i < uep.lf.length; i++) {
-            const l = MODEL.linkByID(uep.lf[i]);
+          for(const id of uep.lf) {
+            const l = MODEL.linkByID(id);
             if(l) {
               const ml = MODEL.addLink(p, l.to_node);
               ml.copyPropertiesFrom(l);
               MODEL.deleteLink(l);
             }
           }
-          // Restore constraints on/by P
-          for(let i = 0; i < uep.ct.length; i++) {
-            const c = MODEL.constraintByID(uep.ct[i]);
+          // Restore constraints on/by P.
+          for(const id of uep.ct) {
+            const c = MODEL.constraintByID(id);
             if(c) {
               const mc = MODEL.addConstraint(c.from_node, p);
               mc.copyPropertiesFrom(c);
               MODEL.deleteConstraint(c);
             }
           }
-          for(let i = 0; i < uep.cf.length; i++) {
-            const c = MODEL.constraintByID(uep.cf[i]);
+          for(const id of uep.cf) {
+            const c = MODEL.constraintByID(id);
             if(c) c.fromNode = p;
             if(c) {
               const mc = MODEL.addConstraint(p, c.to_node);

package/static/scripts/linny-r-milp.js

@@ -96,12 +96,12 @@ module.exports = class MILPSolver {
         windows = os.platform().startsWith('win'),
         path_list = process.env.PATH.split(path.delimiter);
     // Iterate over all seprate paths in environment variable PATH. 
-    for(let i = 0; i < path_list.length; i++) {
+    for(const p of path_list) {
       // Assume that path is not a solver path.
       sp = '';
       // Check whether it is a Gurobi path.
-      match = path_list[i].match(/gurobi(\d+)/i);
-      if(match) sp = path_list[i];
+      match = p.match(/gurobi(\d+)/i);
+      if(match) sp = p;
       // If so, ensure that it has a higher version number.
       if(sp && parseInt(match[1]) > max_vn) {
         // Check whether command line version is executable.
@@ -119,10 +119,10 @@ module.exports = class MILPSolver {
       }
       if(sp) continue;
       // If no Gurobi path, check whether it is a MOSEK path.
-      match = path_list[i].match(/[\/\\]mosek.*[\/\\]bin/i);
+      match = p.match(/[\/\\]mosek.*[\/\\]bin/i);
       if(match) {
         // Check whether mosek(.exe) exists in its directory
-        sp = path.join(path_list[i], 'mosek' + (windows ? '.exe' : ''));
+        sp = path.join(p, 'mosek' + (windows ? '.exe' : ''));
         try {
           fs.accessSync(sp, fs.constants.X_OK);
           console.log('Path to MOSEK:', sp);
@@ -134,17 +134,18 @@ module.exports = class MILPSolver {
       }
       if(sp) continue;
       // If no MOSEK path, check whether it is a CPLEX path.
-      match = path_list[i].match(/[\/\\]cplex[\/\\]bin/i);
+      match = p.match(/[\/\\]cplex[\/\\]bin/i);
       if(match) {
-        sp = path_list[i];
+        sp = p;
       } else {
         // CPLEX may create its own environment variable for its paths.
-        match = path_list[i].match(/%(.*cplex.*)%/i);
+        match = p.match(/%(.*cplex.*)%/i);
         if(match) {
-          const cpl = process.env[match[1]].split(path.delimiter);
-          for(let i = 0; i < cpl.length && !sp; i++) {
-            match = cpl[i].match(/[\/\\]cplex[\/\\]bin/i);
-            if(match) sp = cpl[i];
+          for(const cp of process.env[match[1]].split(path.delimiter)) {
+            if(cp.match(/[\/\\]cplex[\/\\]bin/i)) {
+              sp = cp;
+              break;
+            }
           }
         }
       }
@@ -162,10 +163,10 @@ module.exports = class MILPSolver {
         continue;
       }
       // If no CPLEX path, check whether it is a SCIP path.
-      match = path_list[i].match(/[\/\\]scip[^\/\\]+[\/\\]bin/i);
+      match = p.match(/[\/\\]scip[^\/\\]+[\/\\]bin/i);
       if(match) {
         // Check whether scip(.exe) exists in its directory
-        sp = path.join(path_list[i], 'scip' + (windows ? '.exe' : ''));
+        sp = path.join(p, 'scip' + (windows ? '.exe' : ''));
         try {
           fs.accessSync(sp, fs.constants.X_OK);
           console.log('Path to SCIP:', sp);
@@ -569,11 +570,9 @@ module.exports = class MILPSolver {
           const vlist = Object.keys(x_dict).sort();
           // Start with column 1.
           let col = 1;
-          for(let i = 0; i < vlist.length; i++) {
-            const
-                v = vlist[i],
-                // Variable names have zero-padded column numbers, e.g. "X001".
-                vnr = parseInt(v.substring(1));
+          for(const v of vlist) {
+            // Variable names have zero-padded column numbers, e.g. "X001".
+            const vnr = parseInt(v.substring(1));
             // Add zeros for unreported variables until column number matches.
             while(col < vnr) {
               x_values.push(0);
@@ -631,9 +630,7 @@ module.exports = class MILPSolver {
           // Values of solution vector.
           if(sol.Vars) {
             // Fill dictionary with variable name: value entries.
-            for(let i = 0; i < sol.Vars.length; i++) {
-              x_dict[sol.Vars[i].VarName] = sol.Vars[i].X;
-            }
+            for(const sv of sol.Vars) x_dict[sv.VarName] = sv.X;
             // Fill the solution vector, adding 0 for missing columns.
             getValuesFromDict();
           }
@@ -805,8 +802,7 @@ module.exports = class MILPSolver {
           console.log('No SCIP solution file');
         }
         // Look in messages for solver status and solving time.
-        for(let i = 0; i < result.messages.length; i++) {
-          const m = result.messages[i];
+        for(const m of result.messages) {
           if(m.startsWith('SCIP Status')) {
             if(m.indexOf('problem is solved') >= 0) {
               if(m.indexOf('infeasible') >= 0) {