Skip to content

Commit ebdbd18

Browse files
PlaneshifterPlaneshifter
committed
Fix copy-paste errors and descriptions
1 parent b6605fe commit ebdbd18

File tree

4 files changed

+118
-118
lines changed

4 files changed

+118
-118
lines changed

‎lib/node_modules/@stdlib/random/base/erlang/docs/types/index.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ interface Random extends PRNG {
129129
*
130130
* ## Notes
131131
*
132-
* - If `k` is not a positive integer or `λ <= 0`, the function returns `NaN`.
132+
* - If `k` is not a positive integer or `lambda <= 0`, the function returns `NaN`.
133133
* - If `k` or `lambda` is `NaN`, the function returns `NaN`.
134134
*
135135
* @param k - shape parameter
@@ -210,7 +210,7 @@ interface Random extends PRNG {
210210
*
211211
* ## Notes
212212
*
213-
* - If `k` is not a positive integer or `λ <= 0`, the function returns `NaN`.
213+
* - If `k` is not a positive integer or `lambda <= 0`, the function returns `NaN`.
214214
* - If `k` or `lambda` is `NaN`, the function returns `NaN`.
215215
*
216216
* @param k - shape parameter

‎lib/node_modules/@stdlib/random/base/normal/docs/types/index.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ interface Random extends PRNG {
212212
*
213213
* ## Notes
214214
*
215-
* - `sigma <= 0`, the function returns `NaN`.
215+
* - If `mu` or `sigma` is `NaN` or `sigma <= 0`, the function returns `NaN`.
216216
*
217217
* @param mu - mean
218218
* @param sigma - standard deviation

‎lib/node_modules/@stdlib/random/base/pareto-type1/docs/types/test.ts‎

Lines changed: 112 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -16,60 +16,60 @@
1616
* limitations under the License.
1717
*/
1818

19-
import gamma = require( './index' );
19+
import pareto1 = require( './index' );
2020

2121

2222
// TESTS //
2323

2424
// The function returns a number...
2525
{
26-
gamma( 2, 3 ); // $ExpectType number
27-
gamma( 1, 2 ); // $ExpectType number
26+
pareto1( 2, 3 ); // $ExpectType number
27+
pareto1( 1, 2 ); // $ExpectType number
2828
}
2929

3030
// The compiler throws an error if the function is provided values other than two numbers...
3131
{
32-
gamma( true, 3 ); // $ExpectError
33-
gamma( false, 2 ); // $ExpectError
34-
gamma( '5', 1 ); // $ExpectError
35-
gamma( [], 1 ); // $ExpectError
36-
gamma( {}, 2 ); // $ExpectError
37-
gamma( ( x: number ): number => x, 2 ); // $ExpectError
38-
39-
gamma( 9, true ); // $ExpectError
40-
gamma( 9, false ); // $ExpectError
41-
gamma( 5, '5' ); // $ExpectError
42-
gamma( 8, [] ); // $ExpectError
43-
gamma( 9, {} ); // $ExpectError
44-
gamma( 8, ( x: number ): number => x ); // $ExpectError
32+
pareto1( true, 3 ); // $ExpectError
33+
pareto1( false, 2 ); // $ExpectError
34+
pareto1( '5', 1 ); // $ExpectError
35+
pareto1( [], 1 ); // $ExpectError
36+
pareto1( {}, 2 ); // $ExpectError
37+
pareto1( ( x: number ): number => x, 2 ); // $ExpectError
38+
39+
pareto1( 9, true ); // $ExpectError
40+
pareto1( 9, false ); // $ExpectError
41+
pareto1( 5, '5' ); // $ExpectError
42+
pareto1( 8, [] ); // $ExpectError
43+
pareto1( 9, {} ); // $ExpectError
44+
pareto1( 8, ( x: number ): number => x ); // $ExpectError
4545
}
4646

4747
// The compiler throws an error if the function is provided an unsupported number of arguments...
4848
{
49-
gamma(); // $ExpectError
50-
gamma( 2 ); // $ExpectError
51-
gamma( 2, 2, 4 ); // $ExpectError
49+
pareto1(); // $ExpectError
50+
pareto1( 2 ); // $ExpectError
51+
pareto1( 2, 2, 4 ); // $ExpectError
5252
}
5353

5454
// Attached to main export is a `factory` method which returns a function...
5555
{
56-
gamma.factory( 2, 2 ); // $ExpectType NullaryFunction
57-
gamma.factory(); // $ExpectType BinaryFunction
58-
gamma.factory( { 'copy': false } ); // $ExpectType BinaryFunction
56+
pareto1.factory( 2, 2 ); // $ExpectType NullaryFunction
57+
pareto1.factory(); // $ExpectType BinaryFunction
58+
pareto1.factory( { 'copy': false } ); // $ExpectType BinaryFunction
5959
}
6060

6161
// The `factory` method returns a function which returns a number...
6262
{
63-
const fcn1 = gamma.factory( 2, 2 );
63+
const fcn1 = pareto1.factory( 2, 2 );
6464
fcn1(); // $ExpectType number
6565

66-
const fcn2 = gamma.factory();
66+
const fcn2 = pareto1.factory();
6767
fcn2( 2, 2 ); // $ExpectType number
6868
}
6969

7070
// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments...
7171
{
72-
const fcn1 = gamma.factory( 2, 4 );
72+
const fcn1 = pareto1.factory( 2, 4 );
7373
fcn1( 12 ); // $ExpectError
7474
fcn1( true ); // $ExpectError
7575
fcn1( false ); // $ExpectError
@@ -78,7 +78,7 @@ import gamma = require( './index' );
7878
fcn1( {} ); // $ExpectError
7979
fcn1( ( x: number ): number => x ); // $ExpectError
8080

81-
const fcn2 = gamma.factory();
81+
const fcn2 = pareto1.factory();
8282
fcn2( true, 2 ); // $ExpectError
8383
fcn2( false, 2 ); // $ExpectError
8484
fcn2( '5', 2 ); // $ExpectError
@@ -96,125 +96,125 @@ import gamma = require( './index' );
9696

9797
// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments...
9898
{
99-
const fcn1 = gamma.factory( 2, 2 );
99+
const fcn1 = pareto1.factory( 2, 2 );
100100
fcn1( 1 ); // $ExpectError
101101
fcn1( 2, 1 ); // $ExpectError
102102
fcn1( 2, 1, 1 ); // $ExpectError
103103

104-
const fcn2 = gamma.factory();
104+
const fcn2 = pareto1.factory();
105105
fcn2(); // $ExpectError
106106
fcn2( 1 ); // $ExpectError
107107
fcn2( 2, 1, 1 ); // $ExpectError
108108
}
109109

110110
// The compiler throws an error if the `factory` method is provided values other than two numbers aside from an options object...
111111
{
112-
gamma.factory( true, 3 ); // $ExpectError
113-
gamma.factory( false, 2 ); // $ExpectError
114-
gamma.factory( '5', 1 ); // $ExpectError
115-
gamma.factory( [], 1 ); // $ExpectError
116-
gamma.factory( {}, 2 ); // $ExpectError
117-
gamma.factory( ( x: number ): number => x, 2 ); // $ExpectError
118-
119-
gamma.factory( 9, true ); // $ExpectError
120-
gamma.factory( 9, false ); // $ExpectError
121-
gamma.factory( 5, '5' ); // $ExpectError
122-
gamma.factory( 8, [] ); // $ExpectError
123-
gamma.factory( 9, {} ); // $ExpectError
124-
gamma.factory( 8, ( x: number ): number => x ); // $ExpectError
125-
126-
gamma.factory( true, 3, {} ); // $ExpectError
127-
gamma.factory( false, 2, {} ); // $ExpectError
128-
gamma.factory( '5', 1, {} ); // $ExpectError
129-
gamma.factory( [], 1, {} ); // $ExpectError
130-
gamma.factory( {}, 2, {} ); // $ExpectError
131-
gamma.factory( ( x: number ): number => x, 2, {} ); // $ExpectError
132-
133-
gamma.factory( 9, true, {} ); // $ExpectError
134-
gamma.factory( 9, false, {} ); // $ExpectError
135-
gamma.factory( 5, '5', {} ); // $ExpectError
136-
gamma.factory( 8, [], {} ); // $ExpectError
137-
gamma.factory( 9, {}, {} ); // $ExpectError
138-
gamma.factory( 8, ( x: number ): number => x, {} ); // $ExpectError
112+
pareto1.factory( true, 3 ); // $ExpectError
113+
pareto1.factory( false, 2 ); // $ExpectError
114+
pareto1.factory( '5', 1 ); // $ExpectError
115+
pareto1.factory( [], 1 ); // $ExpectError
116+
pareto1.factory( {}, 2 ); // $ExpectError
117+
pareto1.factory( ( x: number ): number => x, 2 ); // $ExpectError
118+
119+
pareto1.factory( 9, true ); // $ExpectError
120+
pareto1.factory( 9, false ); // $ExpectError
121+
pareto1.factory( 5, '5' ); // $ExpectError
122+
pareto1.factory( 8, [] ); // $ExpectError
123+
pareto1.factory( 9, {} ); // $ExpectError
124+
pareto1.factory( 8, ( x: number ): number => x ); // $ExpectError
125+
126+
pareto1.factory( true, 3, {} ); // $ExpectError
127+
pareto1.factory( false, 2, {} ); // $ExpectError
128+
pareto1.factory( '5', 1, {} ); // $ExpectError
129+
pareto1.factory( [], 1, {} ); // $ExpectError
130+
pareto1.factory( {}, 2, {} ); // $ExpectError
131+
pareto1.factory( ( x: number ): number => x, 2, {} ); // $ExpectError
132+
133+
pareto1.factory( 9, true, {} ); // $ExpectError
134+
pareto1.factory( 9, false, {} ); // $ExpectError
135+
pareto1.factory( 5, '5', {} ); // $ExpectError
136+
pareto1.factory( 8, [], {} ); // $ExpectError
137+
pareto1.factory( 9, {}, {} ); // $ExpectError
138+
pareto1.factory( 8, ( x: number ): number => x, {} ); // $ExpectError
139139
}
140140

141141
// The compiler throws an error if the `factory` method is provided an options argument which is not an object...
142142
{
143-
gamma.factory( null ); // $ExpectError
144-
gamma.factory( 2, 2, null ); // $ExpectError
143+
pareto1.factory( null ); // $ExpectError
144+
pareto1.factory( 2, 2, null ); // $ExpectError
145145
}
146146

147147
// The compiler throws an error if the `factory` method is provided a `prng` option which is not a pseudorandom number generator...
148148
{
149-
gamma.factory( 2, 2, { 'prng': 123 } ); // $ExpectError
150-
gamma.factory( 2, 2, { 'prng': 'abc' } ); // $ExpectError
151-
gamma.factory( 2, 2, { 'prng': null } ); // $ExpectError
152-
gamma.factory( 2, 2, { 'prng': [] } ); // $ExpectError
153-
gamma.factory( 2, 2, { 'prng': {} } ); // $ExpectError
154-
gamma.factory( 2, 2, { 'prng': true ); // $ExpectError
155-
156-
gamma.factory( { 'prng': 123 } ); // $ExpectError
157-
gamma.factory( { 'prng': 'abc' } ); // $ExpectError
158-
gamma.factory( { 'prng': null } ); // $ExpectError
159-
gamma.factory( { 'prng': [] } ); // $ExpectError
160-
gamma.factory( { 'prng': {} } ); // $ExpectError
161-
gamma.factory( { 'prng': true ); // $ExpectError
149+
pareto1.factory( 2, 2, { 'prng': 123 } ); // $ExpectError
150+
pareto1.factory( 2, 2, { 'prng': 'abc' } ); // $ExpectError
151+
pareto1.factory( 2, 2, { 'prng': null } ); // $ExpectError
152+
pareto1.factory( 2, 2, { 'prng': [] } ); // $ExpectError
153+
pareto1.factory( 2, 2, { 'prng': {} } ); // $ExpectError
154+
pareto1.factory( 2, 2, { 'prng': true ); // $ExpectError
155+
156+
pareto1.factory( { 'prng': 123 } ); // $ExpectError
157+
pareto1.factory( { 'prng': 'abc' } ); // $ExpectError
158+
pareto1.factory( { 'prng': null } ); // $ExpectError
159+
pareto1.factory( { 'prng': [] } ); // $ExpectError
160+
pareto1.factory( { 'prng': {} } ); // $ExpectError
161+
pareto1.factory( { 'prng': true ); // $ExpectError
162162
}
163163

164164
// The compiler throws an error if the `factory` method is provided a `seed` option which is not a valid seed...
165165
{
166-
gamma.factory( 2, 2, { 'seed': true } ); // $ExpectError
167-
gamma.factory( 2, 2, { 'seed': 'abc' } ); // $ExpectError
168-
gamma.factory( 2, 2, { 'seed': null } ); // $ExpectError
169-
gamma.factory( 2, 2, { 'seed': [ 'a' ] } ); // $ExpectError
170-
gamma.factory( 2, 2, { 'seed': {} } ); // $ExpectError
171-
gamma.factory( 2, 2, { 'seed': ( x: number ): number => x } ); // $ExpectError
172-
173-
gamma.factory( { 'seed': true } ); // $ExpectError
174-
gamma.factory( { 'seed': 'abc' } ); // $ExpectError
175-
gamma.factory( { 'seed': null } ); // $ExpectError
176-
gamma.factory( { 'seed': [ 'a' ] } ); // $ExpectError
177-
gamma.factory( { 'seed': {} } ); // $ExpectError
178-
gamma.factory( { 'seed': ( x: number ): number => x } ); // $ExpectError
166+
pareto1.factory( 2, 2, { 'seed': true } ); // $ExpectError
167+
pareto1.factory( 2, 2, { 'seed': 'abc' } ); // $ExpectError
168+
pareto1.factory( 2, 2, { 'seed': null } ); // $ExpectError
169+
pareto1.factory( 2, 2, { 'seed': [ 'a' ] } ); // $ExpectError
170+
pareto1.factory( 2, 2, { 'seed': {} } ); // $ExpectError
171+
pareto1.factory( 2, 2, { 'seed': ( x: number ): number => x } ); // $ExpectError
172+
173+
pareto1.factory( { 'seed': true } ); // $ExpectError
174+
pareto1.factory( { 'seed': 'abc' } ); // $ExpectError
175+
pareto1.factory( { 'seed': null } ); // $ExpectError
176+
pareto1.factory( { 'seed': [ 'a' ] } ); // $ExpectError
177+
pareto1.factory( { 'seed': {} } ); // $ExpectError
178+
pareto1.factory( { 'seed': ( x: number ): number => x } ); // $ExpectError
179179
}
180180

181181
// The compiler throws an error if the `factory` method is provided a `state` option which is not a valid state...
182182
{
183-
gamma.factory( 2, 2, { 'state': 123 } ); // $ExpectError
184-
gamma.factory( 2, 2, { 'state': 'abc' } ); // $ExpectError
185-
gamma.factory( 2, 2, { 'state': null } ); // $ExpectError
186-
gamma.factory( 2, 2, { 'state': [] } ); // $ExpectError
187-
gamma.factory( 2, 2, { 'state': {} } ); // $ExpectError
188-
gamma.factory( 2, 2, { 'state': true ); // $ExpectError
189-
gamma.factory( 2, 2, { 'state': ( x: number ): number => x } ); // $ExpectError
190-
191-
gamma.factory( { 'state': 123 } ); // $ExpectError
192-
gamma.factory( { 'state': 'abc' } ); // $ExpectError
193-
gamma.factory( { 'state': null } ); // $ExpectError
194-
gamma.factory( { 'state': [] } ); // $ExpectError
195-
gamma.factory( { 'state': {} } ); // $ExpectError
196-
gamma.factory( { 'state': true ); // $ExpectError
197-
gamma.factory( { 'state': ( x: number ): number => x } ); // $ExpectError
183+
pareto1.factory( 2, 2, { 'state': 123 } ); // $ExpectError
184+
pareto1.factory( 2, 2, { 'state': 'abc' } ); // $ExpectError
185+
pareto1.factory( 2, 2, { 'state': null } ); // $ExpectError
186+
pareto1.factory( 2, 2, { 'state': [] } ); // $ExpectError
187+
pareto1.factory( 2, 2, { 'state': {} } ); // $ExpectError
188+
pareto1.factory( 2, 2, { 'state': true ); // $ExpectError
189+
pareto1.factory( 2, 2, { 'state': ( x: number ): number => x } ); // $ExpectError
190+
191+
pareto1.factory( { 'state': 123 } ); // $ExpectError
192+
pareto1.factory( { 'state': 'abc' } ); // $ExpectError
193+
pareto1.factory( { 'state': null } ); // $ExpectError
194+
pareto1.factory( { 'state': [] } ); // $ExpectError
195+
pareto1.factory( { 'state': {} } ); // $ExpectError
196+
pareto1.factory( { 'state': true ); // $ExpectError
197+
pareto1.factory( { 'state': ( x: number ): number => x } ); // $ExpectError
198198
}
199199

200200
// The compiler throws an error if the `factory` method is provided a `copy` option which is not a boolean...
201201
{
202-
gamma.factory( 2, 2, { 'copy': 123 } ); // $ExpectError
203-
gamma.factory( 2, 2, { 'copy': 'abc' } ); // $ExpectError
204-
gamma.factory( 2, 2, { 'copy': null } ); // $ExpectError
205-
gamma.factory( 2, 2, { 'copy': [] } ); // $ExpectError
206-
gamma.factory( 2, 2, { 'copy': {} } ); // $ExpectError
207-
gamma.factory( 2, 2, { 'copy': ( x: number ): number => x } ); // $ExpectError
208-
209-
gamma.factory( { 'copy': 123 } ); // $ExpectError
210-
gamma.factory( { 'copy': 'abc' } ); // $ExpectError
211-
gamma.factory( { 'copy': null } ); // $ExpectError
212-
gamma.factory( { 'copy': [] } ); // $ExpectError
213-
gamma.factory( { 'copy': {} } ); // $ExpectError
214-
gamma.factory( { 'copy': ( x: number ): number => x } ); // $ExpectError
202+
pareto1.factory( 2, 2, { 'copy': 123 } ); // $ExpectError
203+
pareto1.factory( 2, 2, { 'copy': 'abc' } ); // $ExpectError
204+
pareto1.factory( 2, 2, { 'copy': null } ); // $ExpectError
205+
pareto1.factory( 2, 2, { 'copy': [] } ); // $ExpectError
206+
pareto1.factory( 2, 2, { 'copy': {} } ); // $ExpectError
207+
pareto1.factory( 2, 2, { 'copy': ( x: number ): number => x } ); // $ExpectError
208+
209+
pareto1.factory( { 'copy': 123 } ); // $ExpectError
210+
pareto1.factory( { 'copy': 'abc' } ); // $ExpectError
211+
pareto1.factory( { 'copy': null } ); // $ExpectError
212+
pareto1.factory( { 'copy': [] } ); // $ExpectError
213+
pareto1.factory( { 'copy': {} } ); // $ExpectError
214+
pareto1.factory( { 'copy': ( x: number ): number => x } ); // $ExpectError
215215
}
216216

217217
// The compiler throws an error if the `factory` method is provided more than three arguments...
218218
{
219-
gamma.factory( 2, 4, {}, 2 ); // $ExpectError
219+
pareto1.factory( 2, 4, {}, 2 ); // $ExpectError
220220
}

‎lib/node_modules/@stdlib/random/base/uniform/docs/types/index.d.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ interface NullaryFunction extends PRNG {
111111
*/
112112
interface BinaryFunction extends PRNG {
113113
/**
114-
* Returns an uniform distributed pseudorandom number with minimum support `a` and maximum support `b`.
114+
* Returns a uniform distributed pseudorandom number with minimum support `a` and maximum support `b`.
115115
*
116116
* @param a - minimum support (inclusive)
117117
* @param b - maximum support (exclusive)
@@ -125,7 +125,7 @@ interface BinaryFunction extends PRNG {
125125
*/
126126
interface Random extends PRNG {
127127
/**
128-
* Returns an uniform distributed pseudorandom number with minimum support `a` and maximum support `b`.
128+
* Returns a uniform distributed pseudorandom number with minimum support `a` and maximum support `b`.
129129
*
130130
* ## Notes
131131
*
@@ -207,7 +207,7 @@ interface Random extends PRNG {
207207
}
208208

209209
/**
210-
* Returns an uniform distributed pseudorandom number with minimum support `a` and maximum support `b`.
210+
* Returns a uniform distributed pseudorandom number with minimum support `a` and maximum support `b`.
211211
*
212212
* ## Notes
213213
*

0 commit comments

Comments
 (0)