mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
f0ce987bc1
Note that this *trivially* updates project urls by adding the NPM url to the end, even when the urls are almost identical or the DT one is outdated. I'll clean up the urls in a later commit. This PR is unfinished! Please do not merge it yet.
113 lines
4.4 KiB
TypeScript
113 lines
4.4 KiB
TypeScript
// Type definitions for D3JS d3-random module 1.1
|
||
// Project: https://github.com/d3/d3-random/, https://d3js.org/d3-random
|
||
// Definitions by: Tom Wanzek <https://github.com/tomwanzek>, Alex Ford <https://github.com/gustavderdrache>, Boris Yankov <https://github.com/borisyankov>
|
||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||
|
||
// Last module patch version validated against: 1.1.0
|
||
|
||
export interface RandomNumberGenerationSource {
|
||
/**
|
||
* Returns the same type of function for generating random numbers but where the given random number
|
||
* generator source is used as the source of randomness instead of Math.random.
|
||
* This is useful when a seeded random number generator is preferable to Math.random.
|
||
*
|
||
* @param source Source (pseudo-)random number generator implementing the Math.random interface.
|
||
* The given random number generator must implement the same interface as Math.random and
|
||
* only return values in the range [0, 1).
|
||
*/
|
||
source(source: () => number): this;
|
||
}
|
||
|
||
/**
|
||
* A configurable random number generator for the uniform distribution.
|
||
*/
|
||
export interface RandomUniform extends RandomNumberGenerationSource {
|
||
/**
|
||
* Returns a function for generating random numbers with a uniform distribution).
|
||
* The minimum allowed value of a returned number is min, and the maximum is max.
|
||
* If min is not specified, it defaults to 0; if max is not specified, it defaults to 1.
|
||
*
|
||
* @param min The minimum allowed value of a returned number, defaults to 0.
|
||
* @param max The maximum allowed value of a returned number, defaults to 1.
|
||
*/
|
||
(min?: number, max?: number): () => number;
|
||
}
|
||
|
||
export const randomUniform: RandomUniform;
|
||
|
||
/**
|
||
* A configurable random number generator for the normal (Gaussian) distribution.
|
||
*/
|
||
export interface RandomNormal extends RandomNumberGenerationSource {
|
||
/**
|
||
* Returns a function for generating random numbers with a normal (Gaussian) distribution.
|
||
* The expected value of the generated numbers is mu, with the given standard deviation sigma.
|
||
* If mu is not specified, it defaults to 0; if sigma is not specified, it defaults to 1.
|
||
*
|
||
* @param mu Expected value, defaults to 0.
|
||
* @param sigma Standard deviation, defaults to 1.
|
||
*/
|
||
(mu?: number, sigma?: number): () => number;
|
||
}
|
||
|
||
export const randomNormal: RandomNormal;
|
||
|
||
/**
|
||
* A configurable random number generator for the log-normal distribution.
|
||
*/
|
||
export interface RandomLogNormal extends RandomNumberGenerationSource {
|
||
/**
|
||
* Returns a function for generating random numbers with a log-normal distribution. The expected value of the random variable’s natural logarithm is mu,
|
||
* with the given standard deviation sigma. If mu is not specified, it defaults to 0; if sigma is not specified, it defaults to 1.
|
||
*
|
||
* @param mu Expected value, defaults to 0.
|
||
* @param sigma Standard deviation, defaults to 1.
|
||
*/
|
||
(mu?: number, sigma?: number): () => number;
|
||
}
|
||
|
||
export const randomLogNormal: RandomLogNormal;
|
||
|
||
/**
|
||
* A configurable random number generator for the Bates distribution.
|
||
*/
|
||
export interface RandomBates extends RandomNumberGenerationSource {
|
||
/**
|
||
* Returns a function for generating random numbers with a Bates distribution with n independent variables.
|
||
*
|
||
* @param n Number of independent random variables to use.
|
||
*/
|
||
(n: number): () => number;
|
||
}
|
||
|
||
export const randomBates: RandomBates;
|
||
|
||
/**
|
||
* A configurable random number generator for the Irwin–Hall distribution.
|
||
*/
|
||
export interface RandomIrwinHall extends RandomNumberGenerationSource {
|
||
/**
|
||
* Returns a function for generating random numbers with an Irwin–Hall distribution with n independent variables.
|
||
*
|
||
* @param n Number of independent random variables to use.
|
||
*/
|
||
(n: number): () => number;
|
||
}
|
||
|
||
export const randomIrwinHall: RandomIrwinHall;
|
||
|
||
/**
|
||
* A configurable random number generator for the exponential distribution.
|
||
*/
|
||
export interface RandomExponential extends RandomNumberGenerationSource {
|
||
/**
|
||
* Returns a function for generating random numbers with an exponential distribution with the rate lambda;
|
||
* equivalent to time between events in a Poisson process with a mean of 1 / lambda.
|
||
*
|
||
* @param lambda Expected time between events.
|
||
*/
|
||
(lambda: number): () => number;
|
||
}
|
||
|
||
export const randomExponential: RandomExponential;
|