linny-r 1.6.8 → 1.7.1

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

@@ -88,7 +88,6 @@ class LinnyRModel {
     this.selected_round = 0;
     
     // Model settings
-    this.timeout_period = 30; // max. solver time in seconds
     this.block_length = 1;
     this.start_period = 1; // defines starting point in datasets
     this.end_period = 1;
@@ -99,6 +98,12 @@ class LinnyRModel {
     this.report_results = false;
     this.show_block_arrows = true;
     this.last_zoom_factor = 1;
+    
+    // Default solver settings
+    this.timeout_period = 30; // max. solver time in seconds
+    this.preferred_solver = ''; // empty string denotes "use default"
+    this.integer_tolerance = 5e-7; // integer feasibility tolerance
+    this.MIP_gap = 1e-4; // relative MIP gap
 
     // Sensitivity-related properties
     this.base_case_selectors = '';
@@ -140,17 +145,18 @@ class LinnyRModel {
   /* METHODS THAT LOOKUP ENTITIES, OR INFER PROPERTIES */
 
   get simulationTimeStep() {
-    // Returns actual model time step, rather than `t`, which is relative to the
-    // start of the simulation period
+    // Return actual model time step, rather than `t`, which is relative
+    // to the start of the simulation period.
     return this.t + this.start_period - 1;
   }
   
   get timeStepDuration() {
-    // Returns duration of 1 time step in hours
+    // Return duration of 1 time step in hours.
     return this.time_scale * VM.time_unit_values[this.time_unit];
   }
   
   get outcomes() {
+    // Return the list of outcome datasets.
     const olist = [];
     for(let k in this.datasets) if(this.datasets.hasOwnProperty(k)) {
       if(this.datasets[k].outcome) olist.push(this.datasets[k]);
@@ -2631,17 +2637,17 @@ class LinnyRModel {
   }
 
   initFromXML(node) {
-    // Initialize a model from the XML tree with `node` as root
-    // NOTE: do NOT reset and initialize basic model properties when *including*
-    // a module into the current model
-    // NOTE: obsolete XML nodes indicate: legacy Linny-R model
+    // Initialize a model from the XML tree with `node` as root.
+    // NOTE: do NOT reset and initialize basic model properties when
+    // *including* a module into the current model.
+    // NOTE: Obsolete XML nodes indicate: legacy Linny-R model.
     const legacy_model = (nodeParameterValue(node, 'view-options') +
         nodeParameterValue(node, 'autosave') +
         nodeParameterValue(node, 'look-ahead') +
         nodeParameterValue(node, 'save-series') +
         nodeParameterValue(node, 'show-lp') +
         nodeParameterValue(node, 'optional-slack')).length > 0;
-    // Flag to set when legacy time series data are added 
+    // Flag to set when legacy time series data are added.
     this.legacy_datasets = false;
     if(!IO_CONTEXT) {
       this.reset();
@@ -2668,7 +2674,12 @@ class LinnyRModel {
       this.version = xmlDecoded(nodeContentByTag(node, 'version'));
       this.timeout_period = Math.max(0,
           safeStrToInt(nodeContentByTag(node, 'timeout-period')));
-      // Legacy models have tag "optimization-period" instead of "block-length"
+      this.preferred_solver = xmlDecoded(
+          nodeContentByTag(node, 'preferred-solver')); 
+      this.integer_tolerance = safeStrToFloat(
+          nodeContentByTag(node, 'integer-tolerance'), 5e-7);
+      this.MIP_gap = safeStrToFloat(nodeContentByTag(node, 'mip-gap'), 1e-4);
+      // Legacy models have tag "optimization-period" instead of "block-length".
       const bl_str = nodeContentByTag(node, 'block-length') ||
           nodeContentByTag(node, 'optimization-period'); 
       this.block_length = Math.max(1, safeStrToInt(node, bl_str));
@@ -2693,7 +2704,7 @@ class LinnyRModel {
       if(!this.default_unit) this.default_unit = CONFIGURATION.default_scale_unit;
     } // END IF *not* including a model
 
-    // Declare some local variables that will be used a lot
+    // Declare some local variables that will be used a lot.
     let i,
         c,
         name,
@@ -3014,7 +3025,10 @@ class LinnyRModel {
         '</default-scale-unit><currency-unit>', xmlEncoded(this.currency_unit),
         '</currency-unit><grid-pixels>', this.grid_pixels,
         '</grid-pixels><timeout-period>', this.timeout_period,
-        '</timeout-period><block-length>', this.block_length,
+        '</timeout-period><preferred-solver>', xmlEncoded(this.preferred_solver), 
+        '</preferred-solver><integer-tolerance>', this.integer_tolerance,
+        '</integer-tolerance><mip-gap>', this.MIP_gap,
+        '</mip-gap><block-length>', this.block_length,
         '</block-length><start-period>', this.start_period,
         '</start-period><end-period>', this.end_period,
         '</end-period><look-ahead-period>', this.look_ahead,
@@ -7110,24 +7124,24 @@ class Cluster extends NodeBox {
 class Node extends NodeBox {
   constructor(cluster, name, actor) {
     super(cluster, name, actor);
-    // Nodes are assigned a unique code as "shorthand notation"
-    // NOTE: decimal numbers for processes, Excel-style letter codes for
+    // Nodes are assigned a unique code as "shorthand notation".
+    // NOTE: Decimal numbers for processes, Excel-style letter codes for
     // products, i.e., A, ..., Z, AA, AB, etc.
     this.code = null;
-    // By default, nodes are NOT data products (only products can become data!)
+    // By default, nodes are NOT data products (only products can become data).
     this.is_data = false;
-    // By default, node levels are continuous, but may be set to integer
+    // By default, node levels are continuous, but may be set to integer.
     this.integer_level = false;
-    // Processes and products both have input attributes LB, UB and IL, and
-    // result attributes L and CP
+    // Processes and products both have input attributes LB, UB and IL,
+    // and result attributes L and CP.
     this.lower_bound = new Expression(this, 'LB', '');
     this.upper_bound = new Expression(this, 'UB', '');
     this.initial_level = new Expression(this, 'IL', '0');
     this.cost_price = [];
-    // NOTE: for processes, level denotes the production level, for products
-    // the stock level
+    // NOTE: For processes, level denotes the production level, for products
+    // the stock level.
     this.level = [];
-    // `inputs` is array of incoming links, `outputs` is array of outgoing links
+    // `inputs` is array of incoming links, `outputs` is array of outgoing links.
     this.inputs = [];
     this.outputs = [];
     this.predecessors = [];
@@ -7148,13 +7162,13 @@ class Node extends NodeBox {
   }
   
   get hasBounds() {
-    // Returns TRUE if lower or upper bound is defined for this node
+    // Return TRUE if lower or upper bound is defined for this node.
     return this.upper_bound.defined || this.lower_bound.defined;
   }
   
   setConstraintOffsets() {
-    // Sets the offset properties of the constraints that relate to this
-    // node; these properties are used when drawing these constraints.
+    // Set the offset properties of the constraints that relate to this
+    // node. These properties are used when drawing these constraints.
     const tbc = {top: [], bottom: [], thumb: []};
     for(let k in MODEL.constraints) if(MODEL.constraints.hasOwnProperty(k)) {
       const
@@ -7412,14 +7426,14 @@ class Node extends NodeBox {
   }
 
   canConstrain(node) {
-    // Returns TRUE if this node can constrain `node`
-    // NOTE: A node cannot constrain itself, and BOTH nodes must have upper bounds
+    // Return TRUE if this node can constrain `node`.
+    // NOTE: A node cannot constrain itself, and BOTH nodes must have upper bounds.
     return this !== node && this.upper_bound.defined && node.upper_bound.defined;
   }
 
   get costAddingConstraints() {
-    // Returns a (possibly empty) list of composite constraints that can
-    // transfer cost to this node 
+    // Return a (possibly empty) list of composite constraints that can
+    // transfer cost to this node.
     let cac = [];
     for(let k in MODEL.constraints) if(MODEL.constraints.hasOwnProperty(k)) {
       const c = MODEL.constraints[k];
@@ -7434,7 +7448,7 @@ class Node extends NodeBox {
   
   convertLegacyBoundData(lb_data, ub_data) {
     // Convert time series data for LB and UB in legacy models to datasets,
-    // and replace attribute expressions by references to these datasets
+    // and replace attribute expressions by references to these datasets.
     if(!lb_data && !ub_data) return;
     const same = lb_data === ub_data;
     if(lb_data) {

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

@@ -1076,6 +1076,7 @@ if(NODE) module.exports = {
   msecToTime: msecToTime,
   compactClockTime: compactClockTime,
   uniformDecimals: uniformDecimals,
+  capitalized: capitalized,
   ellipsedText: ellipsedText,
   earlierVersion: earlierVersion,
   differences: differences,
@@ -1083,12 +1084,23 @@ if(NODE) module.exports = {
   ciCompare: ciCompare,
   endsWithDigits: endsWithDigits,
   indexOfMatchingBracket: indexOfMatchingBracket,
+  monoSpaced: monoSpaced,
+  monoSpacedVariables: monoSpacedVariables,
   patternList: patternList,
   patternMatch: patternMatch,
-  compareSelectors: compareSelectors,
-  stringToFloatArray: stringToFloatArray,
+  matchingWildcardNumber: matchingWildcardNumber,
   escapeRegex: escapeRegex,
+  wildcardMatchRegex: wildcardMatchRegex,
+  wildcardFormat: wildcardFormat,
+  matchingNumber: matchingNumber,
+  matchingNumberInList: matchingNumberInList,
+  compareWithTailNumbers: compareWithTailNumbers,
+  compareSelectors: compareSelectors,
+  compareCombinations: compareCombinations,
   addDistinct: addDistinct,
+  mergeDistinct: mergeDistinct,
+  iteratorSet: iteratorSet,
+  integerSet: integerSet,
   setString: setString,
   tupelString: tupelString,
   tupelSetString: tupelSetString,
@@ -1097,6 +1109,7 @@ if(NODE) module.exports = {
   complement: complement,
   xmlEncoded: xmlEncoded,
   xmlDecoded: xmlDecoded,
+  customizeXML: customizeXML,
   cleanXML: cleanXML,
   parseXML: parseXML,
   childNodeByTag: childNodeByTag,
@@ -1107,12 +1120,16 @@ if(NODE) module.exports = {
   parseLetterCode: parseLetterCode,
   randomID: randomID,
   escapedSingleQuotes: escapedSingleQuotes,
+  safeDoubleQuotes: safeDoubleQuotes,
   nameToLines: nameToLines,
+  hexToFloat: hexToFloat,
+  stringToFloatArray: stringToFloatArray,
   hexToBytes: hexToBytes,
+  bytesToHex: bytesToHex,
   arrayBufferToBase64: arrayBufferToBase64,
   base64ToArrayBuffer: base64ToArrayBuffer,
   encryptionKey: encryptionKey,
   encryptMessage: encryptMessage,
   decryptMessage: decryptMessage,
-  tryToDecrypt: tryToDecrypt  
+  tryToDecrypt: tryToDecrypt
 }