-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
172 lines (150 loc) · 3.58 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/*
* @license Apache-2.0
*
* Copyright (c) 2019 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 2.0
/// <reference types="@stdlib/types"/>
import * as random from '@stdlib/types/random';
/**
* Interface defining `factory` options.
*/
interface Options {
/**
* Pseudorandom number generator which generates uniformly distributed pseudorandom numbers.
*/
prng?: random.PRNG;
/**
* Pseudorandom number generator seed.
*/
seed?: random.PRNGSeedMT19937;
/**
* Pseudorandom number generator state.
*/
state?: random.PRNGStateMT19937;
/**
* Specifies whether to copy a provided pseudorandom number generator state.
*/
copy?: boolean;
}
/**
* Interface for PRNG properties and methods.
*/
interface PRNG {
/**
* Generator name.
*/
readonly NAME: string;
/**
* Underlying pseudorandom number generator.
*/
readonly PRNG: random.PRNG;
/**
* PRNG seed.
*/
readonly seed: random.PRNGSeedMT19937;
/**
* PRNG seed length.
*/
readonly seedLength: number;
/**
* PRNG state.
*/
state: random.PRNGStateMT19937;
/**
* PRNG state length.
*/
readonly stateLength: number;
/**
* PRNG state size (in bytes).
*/
readonly byteLength: number;
/**
* Serializes the pseudorandom number generator as a JSON object.
*
* @returns JSON representation
*/
toJSON(): string;
}
/**
* Interface for generating standard normally distributed pseudorandom numbers.
*/
interface NullaryFunction extends PRNG {
/**
* Returns a pseudorandom number drawn from a standard normal distribution.
*
* @returns pseudorandom number
*/
(): number;
}
/**
* Interface for generating pseudorandom numbers drawn from a standard normal distribution.
*/
interface Random extends PRNG {
/**
* Returns a pseudorandom number drawn from a standard normal distribution.
*
* @returns pseudorandom number
*
* @example
* var v = randn();
* // returns <number>
*/
(): number;
/**
* Returns a pseudorandom number generator which implements the Box-Muller transform to generate standard normally distributed pseudorandom numbers.
*
* @param options - function options
* @param options.prng - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
* @param options.seed - pseudorandom number generator seed
* @param options.state - pseudorandom number generator state
* @param options.copy - boolean indicating whether to copy a provided pseudorandom number generator state (default: true)
* @throws must provide a valid state
* @returns pseudorandom number generator
*
* @example
* var rand = randn.factory();
*
* var v = rand();
* // returns <number>
*
* @example
* var rand = randn.factory({
* 'seed': 12345
* });
* var v = rand();
* // returns <number>
*/
factory( options?: Options ): NullaryFunction;
}
/**
* Returns a pseudorandom number drawn from a standard normal distribution.
*
* @returns pseudorandom number
*
* @example
* var v = randn();
* // returns <number>
*
* @example
* var rand = randn.factory({
* 'seed': 12345
* });
* var v = rand();
* // returns <number>
*/
declare var randn: Random;
// EXPORTS //
export = randn;