linny-r 1.6.0 → 1.6.2

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

@@ -1561,13 +1561,21 @@ class LinnyRModel {
   //
 
   alignToGrid() {
-    // Move all positioned model elements to the nearest grid point
+    // Move all positioned model elements to the nearest grid point.
     if(!this.align_to_grid) return;
     let move = false;
     const fc = this.focal_cluster;
     // NOTE: Do not align notes to the grid. This will permit more
     // precise positioning, while aligning will not improve the layout
     // of the diagram because notes are not connected to arrows.
+    // However, when notes relate to nearby nodes, preserve their relative
+    // position to this node.
+    for(let i = 0; i < fc.notes.length; i++) {
+      const
+          note = fc.notes[i],
+          nbn = note.nearbyNode;
+      note.nearby_pos = (nbn ? {node: nbn, oldx: nbn.x, oldy: nbn.y} : null);
+    }
     for(let i = 0; i < fc.processes.length; i++) {
       move = fc.processes[i].alignToGrid() || move;
     }
@@ -1577,11 +1585,25 @@ class LinnyRModel {
     for(let i = 0; i < fc.sub_clusters.length; i++) {
       move = fc.sub_clusters[i].alignToGrid() || move;
     }
-    if(move) UI.drawDiagram(this);
+    if(move) {
+      // Reposition "associated" notes.
+      for(let i = 0; i < fc.notes.length; i++) {
+        const
+            note = fc.notes[i],
+            nbp = note.nearby_pos;
+        if(nbp) {
+          // Adjust (x, y) so as to retain the relative position.
+          note.x += nbp.node.x - npb.oldx;
+          note.y += nbp.node.y - npb.oldy;
+          note.nearby_pos = null;
+        }
+      }
+      UI.drawDiagram(this);
+    }
   }
   
   translateGraph(dx, dy) {
-    // Move all entities in the focal cluster by (dx, dy) pixels
+    // Move all entities in the focal cluster by (dx, dy) pixels.
     if(!dx && !dy) return;
     const fc = this.focal_cluster;
     for(let i = 0; i < fc.processes.length; i++) {
@@ -1600,9 +1622,9 @@ class LinnyRModel {
       fc.notes[i].x += dx;
       fc.notes[i].y += dy;
     }
-    // NOTE: force drawing, because SVG must immediately be downloadable
+    // NOTE: force drawing, because SVG must immediately be downloadable.
     UI.drawDiagram(this);
-    // If dragging, add (dx, dy) to the properties of the top "move" UndoEdit
+    // If dragging, add (dx, dy) to the properties of the top "move" UndoEdit.
     if(UI.dragged_node) UNDO_STACK.addOffset(dx, dy);
   }
 
@@ -1748,8 +1770,8 @@ class LinnyRModel {
         miny = Math.min(miny, obj.y - obj.height / 2);
       }
     }
-    // Translate entire graph if some elements are above and/or left of the
-    // paper edge
+    // Translate entire graph if some elements are above and/or left of
+    // the paper edge.
     if(minx < 0 || miny < 0) {
       // NOTE: limit translation to 5 pixels to prevent "run-away effect"
       this.translateGraph(Math.min(5, -minx), Math.min(5, -miny));
@@ -2186,8 +2208,8 @@ class LinnyRModel {
   }
   
   deleteSelection() {
-    // Removes all selected nodes (with their associated links and constraints)
-    // and selected links
+    // Remove all selected nodes (with their associated links and constraints)
+    // and selected links.
     // NOTE: This method implements the DELETE action, and hence should be
     // undoable. The UndoEdit is created by the calling routine; the methods
     // that actually delete model elements append their XML to the XML attribute
@@ -2195,7 +2217,7 @@ class LinnyRModel {
     let obj,
         fc = this.focal_cluster;
     // Update the documentation manager (GUI only) if selection contains the
-    // current entity
+    // current entity.
     if(DOCUMENTATION_MANAGER) DOCUMENTATION_MANAGER.clearEntity(this.selection);
     // First delete links and constraints.
     for(let i = this.selection.length - 1; i >= 0; i--) {
@@ -3222,6 +3244,29 @@ class LinnyRModel {
         sl.push(this.datasets[obj].displayName, this.datasets[obj].comments);
       }
     }
+    const keys = Object.keys(this.equations_dataset.modifiers); 
+    sl.push('_____Equations');
+    for(let i = 0; i < keys.length; i++) {
+      const m = this.equations_dataset.modifiers[keys[i]];
+      if(!m.selector.startsWith(':')) {
+        sl.push(m.displayName, '`' + m.expression.text + '`\n');
+      }
+    }
+    sl.push('_____Methods');
+    for(let i = 0; i < keys.length; i++) {
+      const m = this.equations_dataset.modifiers[keys[i]];
+      if(m.selector.startsWith(':')) {
+        let markup = '\n\nDoes not apply to any entity.';
+        if(m.expression.eligible_prefixes) {
+          const el = Object.keys(m.expression.eligible_prefixes)
+              .sort(compareSelectors);
+          if(el.length > 0) markup = '\n\nApplies to ' +
+              pluralS(el.length, 'prefixed entity group') +
+              ':\n- ' + el.join('\n- ');
+        }
+        sl.push(m.displayName, '`' + m.expression.text + '`' + markup);
+      }
+    }
     sl.push('_____Charts');
     for(let i = 0; i < this.charts.length; i++) {
       sl.push(this.charts[i].title, this.charts[i].comments);
@@ -4817,7 +4862,7 @@ class ObjectWithXYWH {
 
   alignToGrid() {
     // Align this object to the grid, and return TRUE if this involved
-    // a move
+    // a move.
     const
         ox = this.x,
         oy = this.y,
@@ -5113,7 +5158,7 @@ class Note extends ObjectWithXYWH {
           // If attribute omitted, use default attribute of entity type.
           const attr = (ena.length > 1 ? ena[1].trim() : obj.defaultAttribute);
           let val = null;
-          // NOTE: for datasets, use the active modifier if no attribute.
+          // NOTE: For datasets, use the active modifier if no attribute.
           if(!attr && obj instanceof Dataset) {
             val = obj.activeModifierExpression;
           } else {
@@ -6139,8 +6184,8 @@ class Cluster extends NodeBox {
   }
 
   addProductPosition(p, x=null, y=null) {
-    // Add a product position for product `p` to this cluster unless such pp
-    // already exists; then return this (new) product position
+    // Add a product position for product `p` to this cluster unless such
+    // "pp" already exists, and then return this (new) product position.
     let pp = this.indexOfProduct(p);
     if(pp >= 0) {
       pp = this.product_positions[pp];
@@ -6158,7 +6203,8 @@ class Cluster extends NodeBox {
   }
 
   containsProduct(p) {
-    // Return the subcluster of this cluster that contains product `p`, or null
+    // Return the subcluster of this cluster that contains product `p`,
+    // or NULL if `p` does not occur in this cluster.
     if(this.indexOfProduct(p) >= 0) return this;
     for(let i = 0; i < this.sub_clusters.length; i++) {
       if(this.sub_clusters[i].containsProduct(p)) {
@@ -7848,13 +7894,11 @@ class Product extends Node {
   }
   
   get isConstant() {
-    // Return TRUE if this product is data, has no links to processes,
-    // is not an actor cash flow, and has set LB = UB
+    // Return TRUE if this product is data, is not an actor cash flow,
+    // has no ingoing links, has outgoing links ONLY to data objects,
+    // and has set LB = UB.
     if(!this.is_data || this.name.startsWith('$') ||
-        !this.allOutputsAreData) return false;
-    for(let i = 0; i < this.inputs.length; i++) {
-      if(this.inputs[i].from_node instanceof Process) return false;
-    }
+        this.inputs.length || !this.allOutputsAreData) return false;
     return (this.equal_bounds && this.lower_bound.defined);
   }
 
@@ -8712,8 +8756,8 @@ class Dataset {
     return d.join(';');
   }
   
-  // Returns a string denoting the properties of this dataset.
   get propertiesString() {
+    // Return a string denoting the properties of this dataset.
     if(this.data.length === 0) return '';
     let time_prop;
     if(this.array) {
@@ -8724,12 +8768,12 @@ class Dataset {
         DATASET_MANAGER.method_symbols[
             DATASET_MANAGER.methods.indexOf(this.method)]].join('');
     }
-    // Circular arrow symbolizes "repeating"
+    // Circular arrow symbolizes "repeating".
     return '&nbsp;(' + time_prop + (this.periodic ? '&nbsp;\u21BB' : '') + ')'; 
   }
   
   unpackDataString(str) {
-    // Converts semicolon-separated data to a numeric array.
+    // Convert semicolon-separated data to a numeric array.
     this.data.length = 0;
     if(str) {
       const numbers = str.split(';');
@@ -8742,12 +8786,12 @@ class Dataset {
   }
 
   computeVector() {
-    // Converts data to a vector on the model's time scale, i.e., 1 time step
-    // lasting one unit on the model time scale
+    // Convert data to a vector on the time scale of the model, i.e.,
+    // 1 time step lasting one unit on the model time scale.
     
-    // NOTE: since 9 October 2021, a dataset can also be defined as an "array",
-    // which differs from a time series in that the vector is filled with the
-    // data values "as is" to permit accessing a specific value at index # 
+    // NOTE: A dataset can also be defined as an "array", which differs
+    // from a time series in that the vector is filled with the data values
+    // "as is" to permit accessing a specific value at index #. 
     if(this.array) {
       this.vector = this.data.slice();
       return;
@@ -8755,16 +8799,16 @@ class Dataset {
     // Like all vectors, vector[0] corresponds to initial value, and vector[1]
     // to the model setting "Optimize from step t=..."
     // NOTES:
-    // (1) the first number of a datasets time series is ALWAYS assumed to
+    // (1) The first number of a datasets time series is ALWAYS assumed to
     //     correspond to t=1, whereas the simulation may be set to start later!
-    // (2) model run length includes 1 look-ahead period
+    // (2) Model run length includes 1 look-ahead period.
     VM.scaleDataToVector(this.data, this.vector, this.timeStepDuration,
         MODEL.timeStepDuration, MODEL.runLength, MODEL.start_period,
         this.defaultValue, this.periodic, this.method);
   }
 
   computeStatistics() {
-    // Computes descriptive statistics for data (NOT vector!).
+    // Compute descriptive statistics for data (NOT vector!).
     if(this.data.length === 0) {
       this.min = VM.UNDEFINED;
       this.max = VM.UNDEFINED;
@@ -8789,29 +8833,48 @@ class Dataset {
   }
   
   get statisticsAsString() {
-    // Returns descriptive statistics in human-readable form
+    // Return descriptive statistics in human-readable form.
     let s = 'N = ' + this.data.length;
     if(N > 0) {
-      s += ', range = [' + VM.sig4Dig(this.min) + ', ' + VM.sig4Dig(this.max) +
-          ', mean = ' + VM.sig4Dig(this.mean) + ', s.d. = ' +
-          VM.sig4Dig(this.standard_deviation);
+      s += [', range = [', VM.sig4Dig(this.min), ', ', VM.sig4Dig(this.max),
+          '], mean = ', VM.sig4Dig(this.mean), ', s.d. = ',
+          VM.sig4Dig(this.standard_deviation)].join('');
     }
     return s;
   }
   
   attributeValue(a) {
-    // Returns the computed result for attribute `a`.
-    // NOTE: Datasets have ONE attribute (their vector) denoted by the empty
-    // string; all other "attributes" should be modifier selectors, and
-    // their value should be obtained using attributeExpression (see below).
-    if(a === '') return this.vector;
-    return null;
+    // Return the computed result for attribute `a`.
+    // NOTE: Datasets have ONE attribute (their vector) denoted by the
+    // dot ".". All other "attributes" should be modifier selectors,
+    // and their value should be obtained using `attributeExpression(a)`.
+    // The empty string denotes "use default", which may have been set
+    // by the modeler, or may follow from the active combination of a
+    // running experiment.
+    if(a === '') {
+      const x = this.activeModifierExpression;
+      if(x instanceof Expression) {
+        x.compute(0);
+        // Ensure that for dynamic modifier expressions the vector is
+        // fully computed.
+        if(!x.isStatic) {
+          const nt = MODEL.end_period - MODEL.start_period + 1;
+          for(let t = 1; t <= nt; t++) x.result(t);
+        }
+        return x.vector;
+      }
+      // No modifier expression? Then return the dataset vector.
+      return this.vector;
+    }
+    if(a === '.') return this.vector;
+    // Fall-through: return the default value of this dataset.
+    return this.defaultValue;
   }
 
   attributeExpression(a) {
-    // Returns expression for selector `a` (also considering wildcard
+    // Return the expression for selector `a` (also considering wildcard
     // modifiers), or NULL if no such selector exists.
-    // NOTE: selectors no longer are case-sensitive.
+    // NOTE: Selectors no longer are case-sensitive.
     if(a) {
       const mm = this.matchingModifiers([a]);
       if(mm.length > 0) return mm[0].expression;
@@ -8822,29 +8885,29 @@ class Dataset {
   get activeModifierExpression() { 
     if(MODEL.running_experiment) {
       // If an experiment is running, check if dataset modifiers match the
-      // combination of selectors for the active run
+      // combination of selectors for the active run.
       const mm = this.matchingModifiers(MODEL.running_experiment.activeCombination);
-      // If so, use the first match
+      // If so, use the first match.
       if(mm.length > 0) return mm[0].expression;
     }
     if(this.default_selector) {
-      // If no experiment (so "normal" run), use default selector if specified
+      // If no experiment (so "normal" run), use default selector if specified.
       const dm = this.modifiers[UI.nameToID(this.default_selector)];
       if(dm) return dm.expression;
-      // Exception should never occur, but check anyway and log it 
+      // Exception should never occur, but check anyway and log it.
       console.log('WARNING: Dataset "' + this.name +
           `" has no default selector "${this.default_selector}"`, this.modifiers);
     }
-    // Fall-through: return vector instead of expression
+    // Fall-through: return the dataset vector.
     return this.vector;
   }
   
   addModifier(selector, node=null, ioc=null) {
     let s = selector;
-    // Firstly, sanitize the selector
+    // First sanitize the selector.
     if(this === MODEL.equations_dataset) {
       // Equation identifiers cannot contain characters that have special
-      // meaning in a variable identifier
+      // meaning in a variable identifier.
       s = s.replace(/[\*\|\[\]\{\}\@\#]/g, '');
       if(s !== selector) {
         UI.warn('Equation name cannot contain [, ], {, }, |, @, # or *');
@@ -8868,26 +8931,26 @@ class Dataset {
           return null;
         }
       } else {
-        // Prefix it when the IO context argument is defined 
+        // Prefix it when the IO context argument is defined.
         if(ioc) s = ioc.actualName(s);
       }
-      // If equation already exists, return its modifier
+      // If equation already exists, return its modifier.
       const id = UI.nameToID(s);
       if(this.modifiers.hasOwnProperty(id)) return this.modifiers[id];
-      // New equation identifier must not equal some entity ID
+      // New equation identifier must not equal some entity ID.
       const obj = MODEL.objectByName(s);
       if(obj) {
-        // NOTE: also pass selector, or warning will display dataset name
+        // NOTE: Also pass selector, or warning will display dataset name.
         UI.warningEntityExists(obj);
         return null;
       }
     } else {
       // Standard dataset modifier selectors are much more restricted, but
-      // to be user-friendly, special chars are removed automatically
+      // to be user-friendly, special chars are removed automatically.
       s = s.replace(/[^a-zA-Z0-9\+\-\%\_\*\?]/g, '');
       let msg = '';
       if(s !== selector) msg = UI.WARNING.SELECTOR_SYNTAX;
-      // A selector can only contain 1 star
+      // A selector can only contain 1 star.
       if(s.indexOf('*') !== s.lastIndexOf('*')) msg = UI.WARNING.SINGLE_WILDCARD;
       if(msg) {
         UI.warn(msg);
@@ -8898,12 +8961,12 @@ class Dataset {
       UI.warn(UI.WARNING.INVALID_SELECTOR);
       return null;
     }
-    // Then add a dataset modifier to this dataset
+    // Then add a dataset modifier to this dataset.
     const id = UI.nameToID(s);
     if(!this.modifiers.hasOwnProperty(id)) {
       this.modifiers[id] = new DatasetModifier(this, s);
     }
-    // Finally, initialize it when the XML node argument is defined
+    // Finally, initialize it when the XML node argument is defined.
     if(node) this.modifiers[id].initFromXML(node);
     return this.modifiers[id];
   }
@@ -8927,7 +8990,7 @@ class Dataset {
     for(let i = 0; i < sl.length; i++) {
       ml.push(this.modifiers[sl[i]].asXML);
     }
-    // NOTE: "black-boxed" datasets are stored anonymously without comments
+    // NOTE: "black-boxed" datasets are stored anonymously without comments.
     const id = UI.nameToID(n);
     if(MODEL.black_box_entities.hasOwnProperty(id)) {
       n = MODEL.black_box_entities[id];
@@ -8959,7 +9022,7 @@ class Dataset {
     this.periodic = nodeParameterValue(node, 'periodic') === '1';
     this.array = nodeParameterValue(node, 'array') === '1';
     this.black_box = nodeParameterValue(node, 'black-box') === '1';
-    // NOTE: array-type datasets are by definition input => not an outcome
+    // NOTE: Array-type datasets are by definition input => not an outcome.
     if(!this.array) this.outcome = nodeParameterValue(node, 'outcome') === '1';
     this.url = xmlDecoded(nodeContentByTag(node, 'url'));
     if(this.url) {
@@ -8985,10 +9048,10 @@ class Dataset {
   }
   
   rename(name, notify=true) {
-    // Change the name of this dataset
+    // Change the name of this dataset.
     // When `notify` is FALSE, notifications are suppressed while the
-    // number of affected datasets and expressions are counted
-    // NOTE: prevent renaming the equations dataset (just in case...)
+    // number of affected datasets and expressions are counted.
+    // NOTE: Prevent renaming the equations dataset (just in case).
     if(this === MODEL.equations_dataset) return;
     name = UI.cleanName(name);
     if(!UI.validName(name)) {
@@ -9012,31 +9075,31 @@ class Dataset {
   }
   
   resetExpressions() {
-    // Recalculate vector to adjust to model time scale and run length
+    // Recalculate vector to adjust to model time scale and run length.
     this.computeVector();
-    // Reset all modifier expressions
+    // Reset all modifier expressions.
     for(let m in this.modifiers) if(this.modifiers.hasOwnProperty(m)) {
-      // NOTE: "empty" expressions for modifiers default to dataset default
+      // NOTE: "empty" expressions for modifiers default to dataset default.
       this.modifiers[m].expression.reset(this.defaultValue);
       this.modifiers[m].expression_cache = {};
     }
   }
 
   compileExpressions() {
-    // Recompile all modifier expressions
+    // Recompile all modifier expressions.
     for(let m in this.modifiers) if(this.modifiers.hasOwnProperty(m)) {
       this.modifiers[m].expression.compile();
     }
   }
 
   differences(ds) {
-    // Return "dictionary" of differences, or NULL if none
+    // Return "dictionary" of differences, or NULL if none.
     const d = differences(this, ds, UI.MC.DATASET_PROPS);
-    // Check for differences in data
+    // Check for differences in data.
     if(this.dataString !== ds.dataString) {
       d.data = {A: this.statisticsAsString, B: ds.statisticsAsString};
     }
-    // Check for differences in modifiers
+    // Check for differences in modifiers.
     const mdiff = {};
     for(let m in this.modifiers) if(this.modifiers.hasOwnProperty(m)) {
       const
@@ -9055,7 +9118,7 @@ class Dataset {
         mdiff[m] = [UI.MC.DELETED, dsm.selector, dsm.expression.text];
       }
     }
-    // Only add modifiers property if differences were detected
+    // Only add modifiers property if differences were detected.
     if(Object.keys(mdiff).length > 0) d.modifiers = mdiff; 
     if(Object.keys(d).length > 0) return d;
     return null;
@@ -9064,7 +9127,7 @@ class Dataset {
 } // END of class Dataset
 
 
-// CLASS ChartVariable defines properties of chart time series
+// CLASS ChartVariable defines properties of chart time series.
 class ChartVariable {
   constructor(c) {
     this.chart = c;
@@ -9244,23 +9307,11 @@ class ChartVariable {
       t_end = tsteps;
     } else {
       // Get the variable's own value (number, vector or expression)
-      // Special case: when an experiment is running, variables that
-      // depict a dataset with no explicit modifier must recompute the
-      // vector using the current experiment run combination.
-      if(MODEL.running_experiment &&
-          this.object instanceof Dataset && !this.attribute) {
-        // Check if dataset modifiers match the combination of selectors
-        // for the active run.
-        const mm = this.object.matchingModifiers(
-            MODEL.running_experiment.activeCombination);
-        // If so, use the first (the list should contain at most 1 selector)
-        // to select the modifier expression; otherwise, use the unmodified
-        // vector of the dataset
-        if(mm.length > 0) {
-          av = mm[0].expression;
-        } else {
-          av = this.object.vector;
-        }
+      if(this.object instanceof Dataset && !this.attribute) {
+        // Special case: Variables that depict a dataset with no explicit
+        // modifier selector must recompute the vector using the current
+        // experiment run combination or the default selector.
+        av = this.object.activeModifierExpression;
       } else if(this.object instanceof DatasetModifier) {
         av = this.object.expression;
       } else {
@@ -11029,7 +11080,8 @@ class ExperimentRun {
       bm.messages = VM.messages[i];
       this.block_messages.push(bm);
       this.warning_count += bm.warningCount;
-      this.solver_seconds += bm.solver_secs;
+      // NOTE: When set by the VM, `solver_secs` is a string.
+      this.solver_seconds += parseFloat(bm.solver_secs);
     }
   }
   

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

@@ -491,7 +491,9 @@ function matchingNumber(m, s) {
   // Returns an integer value if string `m` matches selector pattern `s`
   // (where asterisks match 0 or more characters, and question marks 1
   // character) and the matching parts jointly denote an integer.
-  let raw = s.replace(/\*/g, '(.*)').replace(/\?/g, '(.)'),
+  // NOTE: A "+" must be escaped, "*" and "?" must become groups.
+  let raw = s.replaceAll('+', '\+')
+          .replace(/\*/g, '(.*)').replace(/\?/g, '(.)'),
       match = m.match(new RegExp(`^${raw}$`)),
       n = '';
   if(match) {
@@ -601,6 +603,18 @@ function compareSelectors(s1, s2) {
   return 0;
 }
 
+function compareCombinations(c1, c2) {
+  // Compare two selector lists.
+  const n = Math.min(c1.length, c2.length);
+  for(let i = 0; i < n; i++) {
+    const cs = compareSelectors(c1[i], c2[i]);
+    if(cs) return cs;
+  }
+  if(c1.length > l) return 1;
+  if(c2.length > l) return -1;
+  return 0;
+}
+
 //
 // Functions that perform set-like operations on lists of string
 //
@@ -743,17 +757,28 @@ function xmlDecoded(str) {
 }
 
 function customizeXML(str) {
-  // NOTE: this function can be customized to pre-process a model file,
+  // NOTE: This function can be customized to pre-process a model file,
   // for example to rename entities in one go -- USE WITH CARE!
-  // First modify `str` -- by default, do nothing
-  
+  // To prevent unintended customization, check whether the model name
+  // ends with "!!CUSTOMIZE". This check ensures that the modeler must
+  // first save the model with this text as the (end of the) model name
+  // and then load it again for the customization to be performed.
+  if(str.indexOf('!!CUSTOMIZE</name><author>') >= 0) {
+    // Modify `str` -- by default, do nothing, but typical modifications
+    // will replace RexEx patterns by other strings.
+    
 /*
-  if(str.indexOf('<version>1.4.') >= 0) {
-    str = str.replace(/<url>NL\/(\w+)\.csv<\/url>/g, '<url></url>');
-  }
+    const
+        re = /xyz/gi,
+        r = 'abc';
 */
 
-  // Finally, return the modified string
+    // Trace the changes to the console.
+    console.log('Customizing:', re, r);
+    console.log('Matches:', str.match(re));
+    str = str.replace(re, r);
+  }
+  // Finally, return the modified string.
   return str;
 }