feat: Add general simulator

.github/workflows/build-and-test.yml

@@ -49,3 +49,6 @@ jobs:
           npm run montehall -- --games 3 --random advanced --wise --verbose
           npm run montehall -- --games 100 --table-file vendor/numbers.txt
           npm run montehall -- --games 100 --table-file vendor/numbers.txt --wise
+          npm run montehall -- --doors 100 --games 100
+          npm run montehall -- --doors 100 --games 100 --wise
+          npm run montehall -- --doors 100 --games 3 --wise --verbose

package.json

@@ -1,6 +1,6 @@
 {
   "name": "montehall",
-  "version": "0.12.2",
+  "version": "1.0.0",
   "description": "A Monte Carlo machine for the Monty Hall Problem",
   "author": "Omar Boukli-Hacene",
   "license": "MIT",
@@ -36,7 +36,7 @@
     "@types/node": "^18.11.18",
     "@typescript-eslint/eslint-plugin": "^5.47.1",
     "@typescript-eslint/parser": "^5.47.1",
-    "eslint": "^8.30.0",
+    "eslint": "^8.31.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.2.1",
     "jasmine": "^4.5.0",

src/cli.ts

@@ -50,16 +50,15 @@ function buildCliCommand(
     .option(
       "-g, --games <number>",
       `Number of games to simulate`,
-      (x) => {
-        const n = Number(x);
-        if (typeof n !== "number" || !Number.isSafeInteger(n) || n < 0) {
-          throw new InvalidArgumentError("Not a valid number of simulations.");
-        }
-
-        return n;
-      },
+      argToN("Not a valid number of simulations."),
       defaultNumGames
     )
+    .option(
+      "-s, --doors <number>",
+      `Number of doors to simulate`,
+      argToN("Not a valid number of doors."),
+      3
+    )
     .addOption(
       new Option("-r, --random [type]", "Random number generator type")
         .default("basic")
@@ -75,6 +74,19 @@ function buildCliCommand(
     .option("-v, --verbose", "Show a summary for each game", false)
     .option("-w, --wise", "Wise player", false)
     .parse();
+
+  function argToN(
+    validationErrMsg: string
+  ): (value: string, previous: number) => number {
+    return (x) => {
+      const n = Number(x);
+      if (typeof n !== "number" || !Number.isSafeInteger(n) || n < 0) {
+        throw new InvalidArgumentError(validationErrMsg);
+      }
+
+      return n;
+    };
+  }
 }
 
 /**
@@ -136,7 +148,7 @@ async function main() {
 
   const setupOptions: SetupOptions = {
     isNaivePlayer: !isPrudentPlayer,
-    numSlots: 3,
+    numSlots: options.doors as number,
   };
 
   const mcm = monteCarloMachine(
@@ -155,9 +167,13 @@ async function main() {
         EOL
       );
       process.stdout.write(`${formattedSimulationSummary}${EOL}`);
+
+      if (simulationSummary.error) {
+        process.stderr.write(`${toErrString(simulationSummary.error)}${EOL}`);
+      }
     })
     .catch((e) => {
-      process.stdout.write(`${toErrString(e)}${EOL}`);
+      process.stderr.write(`${toErrString(e)}${EOL}`);
     });
 
   return 0;

src/util.spec.ts

@@ -103,4 +103,22 @@ describe("Function gameSimulatorFactory", () => {
 
     expect(gameSimulator.simulateGame()).toBeInstanceOf(Object);
   });
+
+  it("should return valid object", () => {
+    const gameSimulator = gameSimulatorFactory(
+      {
+        isNaivePlayer: true,
+        numSlots: 5,
+      },
+      rngFactory("basic")
+    );
+
+    expect(gameSimulator).toBeInstanceOf(Object);
+
+    expect(gameSimulator.simulateGame.bind(gameSimulator)).toBeInstanceOf(
+      Function
+    );
+
+    expect(gameSimulator.simulateGame()).toBeInstanceOf(Object);
+  });
 });

src/util.ts

@@ -9,6 +9,7 @@ import { readFile } from "node:fs/promises";
 
 import {
   GameSimulator,
+  generalSimulator,
   RandomNumberGenerator,
   SetupOptions,
   standardSimulator,
@@ -67,7 +68,12 @@ export function gameSimulatorFactory(
   setupOptions: SetupOptions,
   rng: RandomNumberGenerator
 ): GameSimulator {
-  return standardSimulator(setupOptions, rng);
+  switch (setupOptions.numSlots) {
+    case 3:
+      return standardSimulator(setupOptions, rng);
+    default:
+      return generalSimulator(setupOptions, rng);
+  }
 }
 
 /**