isaacscript-common/dist/functions/benchmark.js

Helper functions and features for IsaacScript mods.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.benchmark = benchmark;
const log_1 = require("./log");
/**
 * Helper function to benchmark the performance of a function.
 *
 * This function is variadic, which means that you can supply as many functions as you want to
 * benchmark.
 *
 * This function uses the `Isaac.GetTime` method to record how long the function took to execute.
 * This method only reports time in milliseconds. For this reason, if you are benchmarking smaller
 * functions, then you should provide a very high value for the number of trials.
 *
 * @returns An array containing the average time in milliseconds for each function. (This will also
 *          be printed to the log.)
 */
function benchmark(numTrials, ...functions) {
    (0, log_1.log)(`Benchmarking ${functions.length} function(s) with ${numTrials} trials.`);
    const averages = [];
    for (const [i, func] of functions.entries()) {
        let totalTimeMilliseconds = 0;
        for (let j = 0; j < numTrials; j++) {
            const startTimeMilliseconds = Isaac.GetTime();
            func();
            const endTimeMilliseconds = Isaac.GetTime();
            const elapsedTimeMilliseconds = endTimeMilliseconds - startTimeMilliseconds;
            totalTimeMilliseconds += elapsedTimeMilliseconds;
        }
        const averageTimeMilliseconds = totalTimeMilliseconds / numTrials;
        (0, log_1.log)(`The average time of the function at index ${i} is: ${averageTimeMilliseconds} milliseconds`);
        averages.push(averageTimeMilliseconds);
    }
    return averages;
}