linny-r 1.5.0 → 1.5.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "linny-r",
-  "version": "1.5.0",
+  "version": "1.5.3",
   "description": "Executable graphical language with WYSIWYG editor for MILP models",
   "main": "server.js",
   "scripts": {

package/static/index.html

@@ -1819,8 +1819,10 @@ NOTE: * and ? will be interpreted as wildcards"
              title="Clone selected chart">
         <img id="chart-results-btn" class="btn enab" src="images/experiment.png"
              title="Show chart for experiment results (if any)">
+        <img id="chart-runstat-btn" class="btn enab" src="images/runstat.png"
+             title="Plot statistic for selected runs as bar chart">
         <img id="chart-delete-btn" class="btn enab" src="images/delete.png"
-             title="Delete selected chart" style="margin-left: 105px">
+             title="Delete selected chart">
       </div>
       <select id="chart-selector">
         <!-- options are added by the chart manager -->

package/static/linny-r.css

@@ -2683,6 +2683,7 @@ td.equation-expression {
   position: absolute;
   top: 1px;
   left: 1px;
+  width: 202px;
 }
 
 #chart-buttons > img.btn,
@@ -2691,6 +2692,10 @@ td.equation-expression {
   width: 20px;
 }
 
+#chart-delete-btn {
+  float: right;
+}
+
 #chart-histogram {
   position: absolute;
   top: 46px;

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

@@ -743,6 +743,7 @@ class ChartManager {
     this.stretch_factor = 1;
     this.drawing_graph = false;
     this.runs_chart = false;
+    this.runs_stat = false;
     // Arrows indicating sort direction.
     this.sort_arrows = {
       'not' : '',
@@ -829,6 +830,7 @@ class ChartManager {
     this.stretch_factor = 1;
     this.drawing_graph = false;
     this.runs_chart = false;
+    this.runs_stat = false;
   }
   
   resetChartVectors() {
@@ -839,10 +841,16 @@ class ChartManager {
   }
 
   setRunsChart(show) {
-    // Indicates whether the chart manager should display a run result chart
+    // Indicate whether the chart manager should display a run result chart.
     this.runs_chart = show;
   }
 
+  setRunsStat(show) {
+    // Indicate whether the chart manager should display selected statistic
+    // for selected runs as a bar chart.
+    this.runs_stat = show;
+  }
+
   // Dummy methods: actions that are meaningful only for the graphical UI
   updateDialog() {}
   updateExperimentInfo() {}
@@ -1145,7 +1153,7 @@ class ExperimentManager {
   }  
   
   selectedRuns(chart) {
-    // Returns list of run numbers selected in the Experiment Manager
+    // Return list of run numbers selected in the Experiment Manager.
     const selx = this.selected_experiment;
     if(CHART_MANAGER.runs_chart && selx && selx.charts.indexOf(chart) >= 0) {
       return selx.chart_combinations;
@@ -1153,6 +1161,25 @@ class ExperimentManager {
     return [];
   }
   
+  get selectedStatisticName() {
+    // Return full name of selected statistic.
+    const x = this.selected_experiment;
+    if(!x) return '';
+    if(x.selected_scale === 'sec') return 'Solver time';
+    const sn = {
+        'N': 'Count',
+        'mean': 'Mean',
+        'sd': 'Standard deviation',
+        'sum': 'Sum',
+        'min': 'Lowest value',
+        'max': 'Highest value',
+        'nz': 'Non-zero count',
+        'except': 'Exception count',
+        'last': 'Value at final time step'
+      };
+    return sn[x.selected_statistic] || '';
+  }
+  
   selectExperiment(title) {
     const xi = MODEL.indexOfExperiment(title);
     this.selected_experiment = (xi < 0 ? null : MODEL.experiments[xi]);

package/static/scripts/linny-r-gui-chart-manager.js

@@ -54,6 +54,9 @@ class GUIChartManager extends ChartManager {
     this.results_btn = document.getElementById('chart-results-btn');
     this.results_btn.addEventListener(
         'click', () => CHART_MANAGER.toggleRunResults());
+    this.runstat_btn = document.getElementById('chart-runstat-btn');
+    this.runstat_btn.addEventListener(
+        'click', () => CHART_MANAGER.toggleRunStat());
     document.getElementById('chart-delete-btn').addEventListener(
         'click', () => CHART_MANAGER.deleteChart());
     this.control_panel = document.getElementById('chart-control-panel');
@@ -197,12 +200,12 @@ class GUIChartManager extends ChartManager {
     this.variable_index = -1;
     this.stretch_factor = 1;
     this.drawing_graph = false;
-    this.runs_chart = false;
     // Clear the model-related DOM elements
     this.chart_selector.innerHTML = '';
     this.variables_table.innerHTML = '';
     this.options_shown = true;
     this.setRunsChart(false);
+    this.setRunsStat(false);
     this.last_time_selected = 0;
     this.paste_color = '';
     this.hideSortingMenu();
@@ -234,12 +237,26 @@ class GUIChartManager extends ChartManager {
   }
   
   setRunsChart(show) {
-    // Indicates whether the chart manager should display a run result chart
+    // Indicates whether the chart manager should display a run result chart.
     this.runs_chart = show;
     if(show) {
       this.results_btn.classList.add('stay-activ');
+      this.runstat_btn.style.display = 'inline-block';
     } else {
       this.results_btn.classList.remove('stay-activ');
+      this.runstat_btn.style.display = 'none';
+    }
+  }
+
+  setRunsStat(show) {
+    // Indicates whether the chart manager should display run results
+    // as bar chart (for runs and statistic selected in the Experiment
+    // Manager).
+    this.runs_stat = show;
+    if(show) {
+      this.runstat_btn.classList.add('stay-activ');
+    } else {
+      this.runstat_btn.classList.remove('stay-activ');
     }
   }
 
@@ -562,13 +579,22 @@ class GUIChartManager extends ChartManager {
   }
 
   toggleRunResults() {
-    // Toggles the Boolean property that signals charts that they must plot
-    // run results if they are part of the selected experiment chart set
+    // Toggle the Boolean property that signals charts that they must plot
+    // run results if they are part of the selected experiment chart set.
     this.setRunsChart(!this.runs_chart);
     this.resetChartVectors();
     this.updateDialog();
   }
   
+  toggleRunStat() {
+    // Toggles the Boolean property that signals charts that they must
+    // plot the selected statistic for the selected runs if they are
+    // part of the selected experiment chart set.
+    this.setRunsStat(!this.runs_stat);
+    this.resetChartVectors();
+    this.updateDialog();
+  }
+  
   deleteChart() {
     // Deletes the shown chart (if any)
     if(this.chart_index >= 0) {

package/static/scripts/linny-r-gui-experiment-manager.js

@@ -944,11 +944,14 @@ N = ${rr.N}, vector length = ${rr.vector.length}` : '')].join('');
   }
   
   setStatistic() {
-    // Update view for selected variable
+    // Update view for selected variable.
     const x = this.selected_experiment;
     if(x) {
       x.selected_statistic = document.getElementById('viewer-statistic').value;
       this.updateData();
+      // NOTE: Update of Chart Manager is needed only when it is showing
+      // run statistics.
+      if(CHART_MANAGER.runs_stat) CHART_MANAGER.updateDialog();
     }
   }
 
@@ -1012,6 +1015,9 @@ N = ${rr.N}, vector length = ${rr.vector.length}` : '')].join('');
     if(x) {
       x.selected_scale = document.getElementById('viewer-scale').value;
       this.updateData();
+      // NOTE: Update of Chart Manager is needed when it is showing
+      // run statistics because solver times may be plotted.
+      if(CHART_MANAGER.runs_stat) CHART_MANAGER.updateDialog();
     }
   }
   

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

@@ -9614,10 +9614,13 @@ class Chart {
     let runnrs = '';
     const
         selx = EXPERIMENT_MANAGER.selected_experiment,
-        runs = EXPERIMENT_MANAGER.selectedRuns(this);
+        runs = EXPERIMENT_MANAGER.selectedRuns(this),
+        stat_bars = CHART_MANAGER.runs_stat;
     if(runs.length > 0) {
-      runnrs = [' (', selx.title, ': run', (runs.length > 1 ? 's' : ''), ' #',
-          runs.join(', '), ')'].join('');
+      const stat = (stat_bars ?
+          EXPERIMENT_MANAGER.selectedStatisticName + ' for ': ''); 
+      runnrs = [' (', selx.title, ': ', stat, 'run',
+          (runs.length > 1 ? 's' : ''), ' #', runs.join(', '), ')'].join('');
     }
     // Let Chart Manager display experiment title if selected runs are shown
     CHART_MANAGER.updateExperimentInfo();
@@ -9638,17 +9641,53 @@ class Chart {
     // NOTE: let scale start at 0 unless minimum < 0 EXCEPT for a histogram
     let minv = (this.histogram ? VM.PLUS_INFINITY : 0),
         maxv = VM.MINUS_INFINITY;
+    const bar_values = {};
     for(let i = 0; i < this.variables.length; i++) {
       const v = this.variables[i];
       if(v.visible) {
+        bar_values[i] = {};
         if(runs.length > 0) {
           for(let j = 0; j < runs.length; j++) {
             // NOTE: run index >= 0 makes variables use run results vector,
             // scaled to the just established chart time scale
             this.run_index = runs[j];
-            v.computeVector();
-            minv = Math.min(minv, v.lowestValueInVector);
-            maxv = Math.max(maxv, v.highestValueInVector);
+            if(stat_bars) {
+              const rri = selx.resultIndex(v.displayName);
+              let bv;
+              if(rri >= 0) {
+                const
+                    r = selx.runs[this.run_index],
+                    rr = r.results[rri];
+                if(selx.selected_scale === 'sec') {
+                  bv = r.solver_seconds;
+                } else if(selx.selected_statistic === 'N') {
+                  bv = rr.N;
+                } else if(selx.selected_statistic === 'sum') {
+                  bv = rr.sum;
+                } else if(selx.selected_statistic === 'mean') {
+                  bv = rr.mean;
+                } else if(selx.selected_statistic === 'sd') {
+                  bv = Math.sqrt(rr.variance);
+                } else if(selx.selected_statistic === 'min') {
+                  bv = rr.minimum;
+                } else if(selx.selected_statistic === 'max') {
+                  bv = rr.maximum;
+                } else if(selx.selected_statistic === 'nz') {
+                  bv = rr.non_zero_tally;
+                } else if(selx.selected_statistic === 'except') {
+                  bv = rr.exceptions;
+                } else if(selx.selected_statistic === 'last') {
+                  bv = rr.last;
+                }
+                bar_values[i][this.run_index] = bv;
+                minv = Math.min(minv, bv);
+                maxv = Math.max(maxv, bv);
+              }
+            } else {
+              v.computeVector();
+              minv = Math.min(minv, v.lowestValueInVector);
+              maxv = Math.max(maxv, v.highestValueInVector);
+            }
           }
         } else {
           this.run_index = -1;
@@ -9732,8 +9771,9 @@ class Chart {
       }
     }
 
-    // The time step vector is not used when making a histogram. 
-    if(!this.histogram) this.sortLeadTimeVector();
+    // The time step vector is not used when making a histogram or when
+    // plotting run statistics as bar chart. 
+    if(!(this.histogram || stat_bars)) this.sortLeadTimeVector();
 
     // Draw the grid rectangle
     this.addSVG(['<rect id="c_h_a_r_t__a_r_e_a__ID*" x="', rl, '" y="', rt,
@@ -9762,6 +9802,26 @@ class Chart {
         }
         this.addText(x + 5, y, VM.sig2Dig(b), 'black', font_height,
             'text-anchor="end"');
+      } else if(stat_bars && runs.length > 0) {
+        const dx = rw / runs.length;
+        // If multiple bars (`vv` is number of visible variables), draw
+        // ticks to mark horizontal area per run number.
+        if(vv > 1) {
+          this.addSVG(['<line x1="', rl, '" y1="', rt + rh - 3,
+              '" x2="', rl, '" y2="', rt + rh + 3,
+              '" stroke="black" stroke-width="1.5"/>']);
+        }
+        x = rl + dx;
+        for(let i = 0; i < runs.length; i++) {
+          if(vv > 1) {
+            this.addSVG(['<line x1="', x, '" y1="', rt + rh - 3,
+                '" x2="', x, '" y2="', rt + rh + 3,
+                '" stroke="black" stroke-width="1.5"/>']);
+          }
+          // Draw experiment number in middle of its horizontal area.
+          this.addText(x - dx / 2, y, '#' + runs[i]);
+          x += dx;
+        }
       } else {
         // Draw the time labels along the horizontal axis.
         // TO DO: convert to time units if modeler checks this additional option
@@ -9872,6 +9932,7 @@ class Chart {
             '" y2="', y0, '" stroke="black" stroke-width="2"/>']);
         this.addSVG(['<line x1="', x0, '" y1="', rt, '" x2="', x0,
             '" y2="', rt + rh, '" stroke="black" stroke-width="2"/>']);
+
         // Now draw the chart's data elements
         // NOTE: `vv` still is the number of visible chart variables
         if(vv > 0 && this.histogram) {
@@ -9926,6 +9987,32 @@ class Chart {
               vnr++;
             }
           }
+        } else if(vv > 0 && stat_bars) {
+          dx = rw / runs.length;
+          const
+              varsp = dx / vv,
+              barw = 0.85 * varsp,
+              barsp = 0.075 * varsp;
+          let vcnt = 0;
+          for(let vi = 0; vi < this.variables.length; vi++) {
+            const v = this.variables[vi];
+            if(v.visible) {
+              for(let ri = 0; ri < runs.length; ri++) {
+                const
+                    rnr = runs[ri],
+                    bv = bar_values[vi][rnr],
+                    bart = rt + (maxy - bv) * dy,
+                    barh = (bv - miny) * dy;
+                x = rl + ri * dx + barsp + vcnt * varsp;
+                this.addSVG(['<rect x="', x, '" y="', bart,
+                    '" width="', barw, '" height="', barh,
+                    '" stroke="', v.color, '" stroke-width="',
+                    v.line_width, '" fill="', v.color,
+                    '" fill-opacity="0.4" pointer-events="none"></rect>']);
+              }
+              vcnt += 1;
+            }
+          }
         } else if(vv > 0) {
           // Draw areas of stacked variables
           if(runs.length <= 1) {

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

@@ -1960,8 +1960,11 @@ class VirtualMachine {
     // cash flows in the objective function (typically +/- 1)
     this.BASE_PENALTY = 10;
     // Peak variable penalty is added to make solver choose the *smallest*
-    // value that is greater than or equal to X[t] for all t as "peak value"
-    this.PEAK_VAR_PENALTY = 0.01;
+    // value that is greater than or equal to X[t] for all t as "peak value".
+    // NOTE: The penalty is expressed in the currency unit, so it will be
+    // divided by the cash scalar so as not to interfere with the optimal
+    // solution (highest total cash flow).
+    this.PEAK_VAR_PENALTY = 0.1;
   
     // NOTE: the VM uses numbers >> +INF to denote special computation results
     this.EXCEPTION = 1e+36; // to test for any exceptional value
@@ -7445,14 +7448,19 @@ function VMI_set_objective(empty) {
     VM.objective[i] = VM.coefficients[i];
   }
   // NOTE: For peak increase to function properly, the peak variables
-  // must have a small penalty in the objective function
+  // must have a small penalty (about 0.1 currency unit) in the objective
+  // function.
   if(VM.chunk_variables.length > 0) {
     for(let i = 0; i < VM.chunk_variables.length; i++) {
       const vn = VM.chunk_variables[i][0]; 
       if(vn.indexOf('peak') > 0) {
-        // NOTE: chunk offset takes into account that indices are 0-based
-        VM.objective[VM.chunk_offset + i] = -VM.PEAK_VAR_PENALTY;
-        if(vn.startsWith('b')) VM.objective[VM.chunk_offset + i] -= VM.PEAK_VAR_PENALTY;
+        const pvp = VM.PEAK_VAR_PENALTY / VM.cash_scalar;
+        // NOTE: Chunk offset takes into account that indices are 0-based.
+        VM.objective[VM.chunk_offset + i] = -pvp;
+        // Put higher penalty on "block peak" than on "look-ahead peak"
+        // to ensure that block peak will always be the smaller value
+        // of the two peaks.
+        if(vn.startsWith('b')) VM.objective[VM.chunk_offset + i] -= pvp;
       }
     }
   }