UNPKG

935 BTypeScriptView Raw
1/** @module random */
2/**
3 * Random generator for double values.
4 *
5 * ### Example ###
6 *
7 * let value1 = RandomDouble.nextDouble(5, 10); // Possible result: 7.3
8 * let value2 = RandomDouble.nextDouble(10); // Possible result: 3.7
9 * let value3 = RandomDouble.updateDouble(10, 3); // Possible result: 9.2
10 */
11export declare class RandomDouble {
12 /**
13 * Generates a random double value in the range ['minYear', 'maxYear'].
14 *
15 * @param min (optional) minimum range value
16 * @param max max range value
17 * @returns a random double value.
18 */
19 static nextDouble(min: number, max?: number): number;
20 /**
21 * Updates (drifts) a double value within specified range defined
22 *
23 * @param value a double value to drift.
24 * @param range (optional) a range. Default: 10% of the value
25 */
26 static updateDouble(value: number, range?: number): number;
27}