Merge pull request #58 from Itangalo/1.1

1.1

Author: Itangalo

000-simulation.gs

@@ -11,42 +11,16 @@
  */
 
 // Initiate some global variables.
-var global = {
-  defaults: {
-    module: 'example1',
-    deck: {
-      shuffleWhenCreated: true,
-      addDiscardWhenShuffling: true,
-      displaySize: 0,
-      autoFillDisplay: true,
-    },
-    track: {
-      assumePresent: true,
-      startSpaceId: false,
-      loop: false,
-      gridMovement: false,
-      symmetricConnections: true,
-    },
-    market: {
-      restockOnlyIncreases: true,
-    },
-    goods: {
-      quantity: Number.POSITIVE_INFINITY,
-      maxQuantity: Number.POSITIVE_INFINITY,
-    },
-    diceRoll: {
-      quantity: 3,
-      numberOfSides: 6,
-      customSides: false,
-    },
-  },
-}; // Further populated by buildInitialData().
+var global = {}; // Further populated by buildInitialData().
 var modules = {}; // Populated by custom code.
-var module = global.defaults.module;
+var module;
 var gameState = {};
 global.startTime = Date.now();
 
 function simulate(iterations = false, mod = false) {
+  // Set global default values.
+  setInitialDefaults();
+
   // Set which module (game simulation) to run.
   if (mod !== false)
     module = mod;
@@ -55,18 +29,18 @@ function simulate(iterations = false, mod = false) {
   let gameStateSeed = modules[module].buildInitialData();
   log('Initial data complete.', 'system');
 
-  // Variable used to save data from each game iteration.
-  let results = [];
-  // Start iterating game plays.
+  /**
+   * Start iterating game plays.
+   */
+  let results = []; // Variable used to save data from each game iteration.
   if (!iterations)
     iterations = global.defaults.iterations;
   for (let iteration = 1; iteration <= iterations; iteration++) {
-    log('Starting iteration ' + iteration, 'system');
-    gameState = copy(gameStateSeed);
-
     /**
      * Set up each game.
      */
+    log('Starting iteration ' + iteration, 'system');
+    gameState = copy(gameStateSeed);
     // Set up agents, if any. Note that these are stored in an array,
     // not keyed by id, to allow setting and changing order.
     if (gameState.agents) {
@@ -85,7 +59,7 @@ function simulate(iterations = false, mod = false) {
     if (gameState.tracks) {
       delete (gameState.tracks);
       for (let o of gameStateSeed.tracks) {
-        new Track(o.track, o.spaces);
+        new Track(o.track, o.spaces, o.pawns);
       }
     }
     if (gameState.markets) {
@@ -98,7 +72,9 @@ function simulate(iterations = false, mod = false) {
     // Make any customized additional processing of the game state.
     modules[module].preIteration();
 
-    // Play the game until it is over.
+    /**
+     * Play the game until it is over.
+     */
     gameState.round = 0;
     log('Starting first round in iteration ' + iteration, 'system');
     while (!modules[module].gameOver()) {
@@ -113,5 +89,8 @@ function simulate(iterations = false, mod = false) {
     results.push(modules[module].buildStatistics());
   }
 
+  /**
+   * Display the processed results.
+   */
   return processResults(results);
 }

003-defaults.gs

@@ -0,0 +1,55 @@
+/**
+ * @file: Contains default settings, as well as a function for applying the default settings.
+ */
+
+function setInitialDefaults() {
+  global.defaults = {
+    module: 'example1',
+    iterations: 100,
+    logging : {
+      categories: {
+        rounds: true,
+        notice: true,
+        example: true,
+        statistics: true,
+        tests: true,
+        system: true,
+        errors: true,
+      },
+      showTimestamps: true,
+    },
+    statistics: {
+      percentiles: [0, .05, .15, .50, .85, .95, 1],
+    },
+    deck: {
+      shuffleWhenCreated: true,
+      addDiscardWhenShuffling: true,
+      displaySize: 0,
+      autoFillDisplay: true,
+    },
+    track: {
+      assumePresent: true,
+      startSpaceId: false,
+      loop: false,
+      gridMovement: false,
+      symmetricConnections: true,
+      lineOfSightStepFraction: .1,
+    },
+    market: {
+      restockOnlyIncreases: true,
+    },
+    goods: {
+      quantity: Number.POSITIVE_INFINITY,
+      maxQuantity: Number.POSITIVE_INFINITY,
+    },
+    diceRoll: {
+      quantity: 3,
+      numberOfSides: 6,
+      customSides: false,
+    },
+  };
+  // Apply some defaults right away.
+  module = global.defaults.module;
+  for (let i of ['logging', 'statistics'])
+    global[i] = global.defaults[i];
+}

200-helpersGeneral.gs

@@ -477,6 +477,20 @@ function getHighestProperty(obj) {
   return selectRandom(properties);
 }
 
+// Returns the cartesian distance between point A and B, using the coordinates provided
+// in the 'coordinates' array. If B is false, distance to the origin (0) will be returned.
+function getDistance(pointA, pointB = false, coordinates) {
+  if (!pointB) {
+    pointB = {};
+    for (let c in coordinates)
+      pointB[c] = 0;
+  }
+  let a = 0;
+  for (let c of coordinates)
+    a += Math.pow(pointA[c] - pointB[c], 2);
+  return Math.sqrt(a);
+}
+
 /**
  * Internally used helper functions.
  */

210-processResults.gs

@@ -31,7 +31,7 @@ function processResults(results) {
   // Header row
   let message = 'DISTRIBUTION: average (percentile ';
   let values = [];
-  for (let p of global.percentilesForStatistics) {
+  for (let p of global.statistics.percentiles) {
     values.push(p);
   }
   message += values.join(' | ') + ')\r\n---\r\n';
@@ -40,7 +40,7 @@ function processResults(results) {
     message += i + ': ';
     message += average(sortedResults[i]).toFixed(2) + ' (';
     values = [];
-    for (let p of global.percentilesForStatistics) {
+    for (let p of global.statistics.percentiles) {
       values.push(percentile(sortedResults[i], p).toFixed(2));
     }
     message += values.join(' | ') + ') Non-zero at ';
@@ -67,7 +67,7 @@ function processResults(results) {
     output[2].push(getNonZeroThreshold(sortedResults[i]));
   }
   // Percentiles
-  for (let p of global.percentilesForStatistics) {
+  for (let p of global.statistics.percentiles) {
     let line = ['percentile ' + p];
     for (let i in sortedResults) {
       line.push(percentile(sortedResults[i], p));

220-logging.gs

@@ -9,8 +9,8 @@
  * @param {string} type: The type of log message, used for restricting actual output.
  */
 function log(message, type) {
-  if (!global.logging || global.logging.categories[type]) {
-    if (!global.logging || global.logging.showTimestamps)
+  if (global.logging.categories[type]) {
+    if (global.logging.showTimestamps)
       message += ' (time: ' + (Date.now() - global.startTime) + ')';
     Logger.log(message);
   }