agentscape/numbers/RandomGenerator.d.ts

Agentscape is a library for creating agent-based simulations. It provides a simple API for defining agents and their behavior, and for defining the environment in which the agents interact. Agentscape is designed to be flexible and extensible, allowing

export default class RandomGenerator {
    private generator;
    seed: number;
    constructor(seed?: number);
    jump(): void;
    /**
     * Returns a uniformly distributed random integer between min and max
     */
    uniformInt(min: number, max: number): number;
    /**
     * Returns an array of uniformly distributed random integers between min and max
     */
    uniformIntArray(min: number, max: number, size: number): number[];
    uniformFloat(min: number, max: number): number;
    /**
     * Returns an array of uniformly distributed random floats between min and max.
     */
    uniformFloatArray(min: number, max: number, size: number): number[];
    /**
     * Returns a normally distributed random number with mean mu and standard deviation sigma.
     */
    normalFloat(mu: number, sigma: number): number;
    /**
     * Returns an array of normally distributed random numbers with mean mu and standard deviation sigma.
     */
    normalFloatArray(mu: number, sigma: number, size: number): number[];
    /**
     * Returns a Poisson distributed random number with mean lambda.
     */
    poissonInt(lambda: number): number;
    /**
     * Returns an array of Poisson distributed random numbers with mean lambda.
     */
    poissonIntArray(lambda: number, size: number): number[];
    /**
     * Picks a single random element from the array.
     * Returns undefined if the array is empty.
     */
    pickRandom<T>(array: T[]): T;
    /**
     * Picks a random subset of the array without replacement.
     * Returns an empty array if the array is empty.
     */
    pickRandomArray<T>(array: T[], size: number): T[];
    shuffle<T>(array: T[]): T[];
}