Skip to content

Commit 9d0d497

Browse files
PlaneshifterPlaneshifter
committed
Rename namespace interface and variable names
1 parent 2d9234d commit 9d0d497

File tree

74 files changed

+2528
-2529
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+2528
-2529
lines changed

‎lib/node_modules/@stdlib/stats/base/dists/arcsine/docs/types/index.d.ts‎

Lines changed: 61 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ import variance = require( '@stdlib/stats/base/dists/arcsine/variance' );
3939
/**
4040
* Interface describing the `arcsine` namespace.
4141
*/
42-
interface ARCSINE {
42+
interface Namespace {
4343
/**
4444
* Arcsine distribution cumulative distribution function (CDF).
4545
*
@@ -49,10 +49,10 @@ interface ARCSINE {
4949
* @returns evaluated CDF
5050
*
5151
* @example
52-
* var y = cdf( 5.0, 0.0, 4.0 );
52+
* var y = ns.cdf( 5.0, 0.0, 4.0 );
5353
* // returns 1.0
5454
*
55-
* var mycdf = cdf.factory( 0.0, 10.0 );
55+
* var mycdf = ns.cdf.factory( 0.0, 10.0 );
5656
* y = mycdf( 0.5 );
5757
* // returns ~0.144
5858
*
@@ -78,27 +78,27 @@ interface ARCSINE {
7878
* @returns entropy
7979
*
8080
* @example
81-
* var v = entropy( 0.0, 1.0 );
81+
* var v = ns.entropy( 0.0, 1.0 );
8282
* // returns ~-0.242
8383
*
8484
* @example
85-
* var v = entropy( 4.0, 12.0 );
85+
* var v = ns.entropy( 4.0, 12.0 );
8686
* // returns ~1.838
8787
*
8888
* @example
89-
* var v = entropy( -4.0, 4.0 );
89+
* var v = ns.entropy( -4.0, 4.0 );
9090
* // returns ~1.838
9191
*
9292
* @example
93-
* var v = entropy( 1.0, -0.1 );
93+
* var v = ns.entropy( 1.0, -0.1 );
9494
* // returns NaN
9595
*
9696
* @example
97-
* var v = entropy( 2.0, NaN );
97+
* var v = ns.entropy( 2.0, NaN );
9898
* // returns NaN
9999
*
100100
* @example
101-
* var v = entropy( NaN, 2.0 );
101+
* var v = ns.entropy( NaN, 2.0 );
102102
* // returns NaN
103103
*/
104104
entropy: typeof entropy;
@@ -115,27 +115,27 @@ interface ARCSINE {
115115
* @returns excess kurtosis
116116
*
117117
* @example
118-
* var v = kurtosis( 0.0, 1.0 );
118+
* var v = ns.kurtosis( 0.0, 1.0 );
119119
* // returns -1.5
120120
*
121121
* @example
122-
* var v = kurtosis( 4.0, 12.0 );
122+
* var v = ns.kurtosis( 4.0, 12.0 );
123123
* // returns -1.5
124124
*
125125
* @example
126-
* var v = kurtosis( -4.0, 4.0 );
126+
* var v = ns.kurtosis( -4.0, 4.0 );
127127
* // returns -1.5
128128
*
129129
* @example
130-
* var v = kurtosis( 1.0, -0.1 );
130+
* var v = ns.kurtosis( 1.0, -0.1 );
131131
* // returns NaN
132132
*
133133
* @example
134-
* var v = kurtosis( 2.0, NaN );
134+
* var v = ns.kurtosis( 2.0, NaN );
135135
* // returns NaN
136136
*
137137
* @example
138-
* var v = kurtosis( NaN, 2.0 );
138+
* var v = ns.kurtosis( NaN, 2.0 );
139139
* // returns NaN
140140
*/
141141
kurtosis: typeof kurtosis;
@@ -149,10 +149,10 @@ interface ARCSINE {
149149
* @returns evaluated logCDF
150150
*
151151
* @example
152-
* var y = logcdf( 5.0, 0.0, 4.0 );
152+
* var y = ns.logcdf( 5.0, 0.0, 4.0 );
153153
* // returns 0.0
154154
*
155-
* var mylogcdf = logcdf.factory( 0.0, 10.0 );
155+
* var mylogcdf = ns.logcdf.factory( 0.0, 10.0 );
156156
* y = mylogcdf( 0.5 );
157157
* // returns ~-1.938
158158
*
@@ -170,10 +170,10 @@ interface ARCSINE {
170170
* @returns evaluated logPDF
171171
*
172172
* @example
173-
* var y = logpdf( 3.0, 2.0, 6.0 );
173+
* var y = ns.logpdf( 3.0, 2.0, 6.0 );
174174
* // returns ~-1.694
175175
*
176-
* var mylogpdf = logpdf.factory( 6.0, 7.0 );
176+
* var mylogpdf = ns.logpdf.factory( 6.0, 7.0 );
177177
* y = mylogpdf( 7.0 );
178178
* // returns Infinity
179179
*
@@ -194,27 +194,27 @@ interface ARCSINE {
194194
* @returns expected value
195195
*
196196
* @example
197-
* var v = mean( 0.0, 1.0 );
197+
* var v = ns.mean( 0.0, 1.0 );
198198
* // returns 0.5
199199
*
200200
* @example
201-
* var v = mean( 4.0, 12.0 );
201+
* var v = ns.mean( 4.0, 12.0 );
202202
* // returns 8.0
203203
*
204204
* @example
205-
* var v = mean( -4.0, 4.0 );
205+
* var v = ns.mean( -4.0, 4.0 );
206206
* // returns 0.0
207207
*
208208
* @example
209-
* var v = mean( 1.0, -0.1 );
209+
* var v = ns.mean( 1.0, -0.1 );
210210
* // returns NaN
211211
*
212212
* @example
213-
* var v = mean( 2.0, NaN );
213+
* var v = ns.mean( 2.0, NaN );
214214
* // returns NaN
215215
*
216216
* @example
217-
* var v = mean( NaN, 2.0 );
217+
* var v = ns.mean( NaN, 2.0 );
218218
* // returns NaN
219219
*/
220220
mean: typeof mean;
@@ -231,27 +231,27 @@ interface ARCSINE {
231231
* @returns median
232232
*
233233
* @example
234-
* var v = median( 0.0, 1.0 );
234+
* var v = ns.median( 0.0, 1.0 );
235235
* // returns 0.5
236236
*
237237
* @example
238-
* var v = median( 4.0, 12.0 );
238+
* var v = ns.median( 4.0, 12.0 );
239239
* // returns 8.0
240240
*
241241
* @example
242-
* var v = median( -4.0, 4.0 );
242+
* var v = ns.median( -4.0, 4.0 );
243243
* // returns 0.0
244244
*
245245
* @example
246-
* var v = median( 1.0, -0.1 );
246+
* var v = ns.median( 1.0, -0.1 );
247247
* // returns NaN
248248
*
249249
* @example
250-
* var v = median( 2.0, NaN );
250+
* var v = ns.median( 2.0, NaN );
251251
* // returns NaN
252252
*
253253
* @example
254-
* var v = median( NaN, 2.0 );
254+
* var v = ns.median( NaN, 2.0 );
255255
* // returns NaN
256256
*/
257257
median: typeof median;
@@ -268,27 +268,27 @@ interface ARCSINE {
268268
* @returns mode
269269
*
270270
* @example
271-
* var v = mode( 0.0, 1.0 );
271+
* var v = ns.mode( 0.0, 1.0 );
272272
* // returns 0.0
273273
*
274274
* @example
275-
* var v = mode( 4.0, 12.0 );
275+
* var v = ns.mode( 4.0, 12.0 );
276276
* // returns 4.0
277277
*
278278
* @example
279-
* var v = mode( -4.0, 4.0 );
279+
* var v = ns.mode( -4.0, 4.0 );
280280
* // returns -4.0
281281
*
282282
* @example
283-
* var v = mode( 1.0, -0.1 );
283+
* var v = ns.mode( 1.0, -0.1 );
284284
* // returns NaN
285285
*
286286
* @example
287-
* var v = mode( 2.0, NaN );
287+
* var v = ns.mode( 2.0, NaN );
288288
* // returns NaN
289289
*
290290
* @example
291-
* var v = mode( NaN, 2.0 );
291+
* var v = ns.mode( NaN, 2.0 );
292292
* // returns NaN
293293
*/
294294
mode: typeof mode;
@@ -302,10 +302,10 @@ interface ARCSINE {
302302
* @returns evaluated PDF
303303
*
304304
* @example
305-
* var y = pdf( 3.0, 2.0, 6.0 );
305+
* var y = ns.pdf( 3.0, 2.0, 6.0 );
306306
* // returns ~0.184
307307
*
308-
* var mypdf = pdf.factory( 6.0, 7.0 );
308+
* var mypdf = ns.pdf.factory( 6.0, 7.0 );
309309
* y = mypdf( 7.0 );
310310
* // returns Infinity
311311
*
@@ -323,10 +323,10 @@ interface ARCSINE {
323323
* @returns evaluated quantile function
324324
*
325325
* @example
326-
* var y = quantile( 0.5, 0.0, 10.0 );
326+
* var y = ns.quantile( 0.5, 0.0, 10.0 );
327327
* // returns ~5.0
328328
*
329-
* var myQuantile = quantile.factory( 0.0, 4.0 );
329+
* var myQuantile = ns.quantile.factory( 0.0, 4.0 );
330330
* y = myQuantile( 0.8 );
331331
* // returns ~3.618
332332
*/
@@ -344,27 +344,27 @@ interface ARCSINE {
344344
* @returns skewness
345345
*
346346
* @example
347-
* var v = skewness( 0.0, 1.0 );
347+
* var v = ns.skewness( 0.0, 1.0 );
348348
* // returns 0.0
349349
*
350350
* @example
351-
* var v = skewness( 4.0, 12.0 );
351+
* var v = ns.skewness( 4.0, 12.0 );
352352
* // returns 0.0
353353
*
354354
* @example
355-
* var v = skewness( -4.0, 4.0 );
355+
* var v = ns.skewness( -4.0, 4.0 );
356356
* // returns 0.0
357357
*
358358
* @example
359-
* var v = skewness( 1.0, -0.1 );
359+
* var v = ns.skewness( 1.0, -0.1 );
360360
* // returns NaN
361361
*
362362
* @example
363-
* var v = skewness( 2.0, NaN );
363+
* var v = ns.skewness( 2.0, NaN );
364364
* // returns NaN
365365
*
366366
* @example
367-
* var v = skewness( NaN, 2.0 );
367+
* var v = ns.skewness( NaN, 2.0 );
368368
* // returns NaN
369369
*/
370370
skewness: typeof skewness;
@@ -381,27 +381,27 @@ interface ARCSINE {
381381
* @returns standard deviation
382382
*
383383
* @example
384-
* var v = stdev( 0.0, 1.0 );
384+
* var v = ns.stdev( 0.0, 1.0 );
385385
* // returns ~0.354
386386
*
387387
* @example
388-
* var v = stdev( 4.0, 12.0 );
388+
* var v = ns.stdev( 4.0, 12.0 );
389389
* // returns ~2.828
390390
*
391391
* @example
392-
* var v = stdev( -4.0, 4.0 );
392+
* var v = ns.stdev( -4.0, 4.0 );
393393
* // returns ~2.828
394394
*
395395
* @example
396-
* var v = stdev( 1.0, -0.1 );
396+
* var v = ns.stdev( 1.0, -0.1 );
397397
* // returns NaN
398398
*
399399
* @example
400-
* var v = stdev( 2.0, NaN );
400+
* var v = ns.stdev( 2.0, NaN );
401401
* // returns NaN
402402
*
403403
* @example
404-
* var v = stdev( NaN, 2.0 );
404+
* var v = ns.stdev( NaN, 2.0 );
405405
* // returns NaN
406406
*/
407407
stdev: typeof stdev;
@@ -418,27 +418,27 @@ interface ARCSINE {
418418
* @returns variance
419419
*
420420
* @example
421-
* var v = variance( 0.0, 1.0 );
421+
* var v = ns.variance( 0.0, 1.0 );
422422
* // returns ~0.125
423423
*
424424
* @example
425-
* var v = variance( 4.0, 12.0 );
425+
* var v = ns.variance( 4.0, 12.0 );
426426
* // returns 8.0
427427
*
428428
* @example
429-
* var v = variance( -4.0, 4.0 );
429+
* var v = ns.variance( -4.0, 4.0 );
430430
* // returns 8.0
431431
*
432432
* @example
433-
* var v = variance( 1.0, -0.1 );
433+
* var v = ns.variance( 1.0, -0.1 );
434434
* // returns NaN
435435
*
436436
* @example
437-
* var v = variance( 2.0, NaN );
437+
* var v = ns.variance( 2.0, NaN );
438438
* // returns NaN
439439
*
440440
* @example
441-
* var v = variance( NaN, 2.0 );
441+
* var v = ns.variance( NaN, 2.0 );
442442
* // returns NaN
443443
*/
444444
variance: typeof variance;
@@ -447,9 +447,9 @@ interface ARCSINE {
447447
/**
448448
* Arcsine distribution.
449449
*/
450-
declare var arcsine: ARCSINE;
450+
declare var ns: Namespace;
451451

452452

453453
// EXPORTS //
454454

455-
export = arcsine;
455+
export = ns;

‎lib/node_modules/@stdlib/stats/base/dists/arcsine/docs/types/test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,5 @@ import arcsine = require( './index' );
2525

2626
// The exported value is the expected interface...
2727
{
28-
arcsine; // $ExpectType ARCSINE
28+
arcsine; // $ExpectType Namespace
2929
}

0 commit comments

Comments
 (0)