mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-04-23 04:49:15 +08:00
ccf82851b7
* d3-format * [chore](d3-format): Finalized JSDoc comments * [Enhancement](d3-format): Use string literals to refine interface FormatSpecifier for properties with specified encoding of choices. (In accordance with D3 API docs) * d3-timer * [Fix](d3-timer): Removed brackets from @param statements for optional parameters. Otherwise they did not appear in IDE (VSCode) * d3-random * [chore](d3-random): Complete JSDoc comments.
56 lines
2.5 KiB
TypeScript
56 lines
2.5 KiB
TypeScript
// Type definitions for D3JS d3-random module v1.0.1
|
||
// Project: https://github.com/d3/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
|
||
|
||
/**
|
||
* 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.
|
||
*/
|
||
export function randomUniform(min?: number, max?: number): () => number;
|
||
|
||
/**
|
||
* 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.
|
||
*/
|
||
export function randomNormal(mu?: number, sigma?: number): () => number;
|
||
|
||
/**
|
||
* Returns a function for generating random numbers with a log-normal distribution. The expected value of the random variable’s natural logrithm 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.
|
||
*/
|
||
export function randomLogNormal(mu?: number, sigma?: number): () => number;
|
||
|
||
/**
|
||
* Returns a function for generating random numbers with a Bates distribution with n independent variables.
|
||
*
|
||
* @param n Number of independent random variables to use.
|
||
*/
|
||
export function randomBates(n: number): () => number;
|
||
|
||
/**
|
||
* 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.
|
||
*/
|
||
export function randomIrwinHall(n: number): () => number;
|
||
|
||
/**
|
||
* 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.
|
||
*/
|
||
export function randomExponential(lambda: number): () => number;
|