Skip to content

Commit 8f43afc

Browse files
kgrytekgryte
committed
feat!: rename exported aliases
This commit renames aliases to more naturally map to package names. Previously, exported aliases attempted to match the global REPL namespace aliases. This made more sense when the main distributable artifacts were a "flat" and "tree" bundle and we wanted to have similar naming conventions across both. Times have changed, however, and the use of REPL aliases in the "ndarray" namespace feels awkward and are hard to predict from a user POV, without knowing the conventions of the REPL global namespace. Accordingly, this commit changes aliases to what we'd typically use for a nested namespace. BREAKING CHANGE: rename exported aliases To migrate, users should consult the documentation for the updated aliases. For the most part, updating code should be as simple as dropping an `ndarray` or `nd` prefix. For others, they should more directly match, or be inferrable from, the package name.
1 parent 575c74c commit 8f43afc

File tree

1 file changed

+63
-63
lines changed
  • lib/node_modules/@stdlib/ndarray/lib

1 file changed

+63
-63
lines changed

‎lib/node_modules/@stdlib/ndarray/lib/index.js‎

Lines changed: 63 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ var ns = {};
4646
setReadOnly( ns, 'array', require( '@stdlib/ndarray/array' ) );
4747

4848
/**
49-
* @name ndat
49+
* @name at
5050
* @memberof ns
5151
* @readonly
5252
* @type {Function}
5353
* @see {@link module:@stdlib/ndarray/at}
5454
*/
55-
setReadOnly( ns, 'ndat', require( '@stdlib/ndarray/at' ) );
55+
setReadOnly( ns, 'at', require( '@stdlib/ndarray/at' ) );
5656

5757
/**
5858
* @name base
@@ -82,13 +82,13 @@ setReadOnly( ns, 'broadcastArray', require( '@stdlib/ndarray/broadcast-array' )
8282
setReadOnly( ns, 'broadcastArrays', require( '@stdlib/ndarray/broadcast-arrays' ) );
8383

8484
/**
85-
* @name ndarrayCastingModes
85+
* @name castingModes
8686
* @memberof ns
8787
* @readonly
8888
* @type {Function}
8989
* @see {@link module:@stdlib/ndarray/casting-modes}
9090
*/
91-
setReadOnly( ns, 'ndarrayCastingModes', require( '@stdlib/ndarray/casting-modes' ) );
91+
setReadOnly( ns, 'castingModes', require( '@stdlib/ndarray/casting-modes' ) );
9292

9393
/**
9494
* @name ndarray
@@ -100,13 +100,13 @@ setReadOnly( ns, 'ndarrayCastingModes', require( '@stdlib/ndarray/casting-modes'
100100
setReadOnly( ns, 'ndarray', require( '@stdlib/ndarray/ctor' ) );
101101

102102
/**
103-
* @name ndarrayDataBuffer
103+
* @name dataBuffer
104104
* @memberof ns
105105
* @readonly
106106
* @type {Function}
107107
* @see {@link module:@stdlib/ndarray/data-buffer}
108108
*/
109-
setReadOnly( ns, 'ndarrayDataBuffer', require( '@stdlib/ndarray/data-buffer' ) );
109+
setReadOnly( ns, 'dataBuffer', require( '@stdlib/ndarray/data-buffer' ) );
110110

111111
/**
112112
* @name defaults
@@ -127,40 +127,40 @@ setReadOnly( ns, 'defaults', require( '@stdlib/ndarray/defaults' ) );
127127
setReadOnly( ns, 'dispatch', require( '@stdlib/ndarray/dispatch' ) );
128128

129129
/**
130-
* @name ndarrayDataType
130+
* @name dtype
131131
* @memberof ns
132132
* @readonly
133133
* @type {Function}
134134
* @see {@link module:@stdlib/ndarray/dtype}
135135
*/
136-
setReadOnly( ns, 'ndarrayDataType', require( '@stdlib/ndarray/dtype' ) );
136+
setReadOnly( ns, 'dtype', require( '@stdlib/ndarray/dtype' ) );
137137

138138
/**
139-
* @name ndarrayDataTypes
139+
* @name dtypes
140140
* @memberof ns
141141
* @readonly
142142
* @type {Function}
143143
* @see {@link module:@stdlib/ndarray/dtypes}
144144
*/
145-
setReadOnly( ns, 'ndarrayDataTypes', require( '@stdlib/ndarray/dtypes' ) );
145+
setReadOnly( ns, 'dtypes', require( '@stdlib/ndarray/dtypes' ) );
146146

147147
/**
148-
* @name ndempty
148+
* @name empty
149149
* @memberof ns
150150
* @readonly
151151
* @type {Function}
152152
* @see {@link module:@stdlib/ndarray/empty}
153153
*/
154-
setReadOnly( ns, 'ndempty', require( '@stdlib/ndarray/empty' ) );
154+
setReadOnly( ns, 'empty', require( '@stdlib/ndarray/empty' ) );
155155

156156
/**
157-
* @name ndemptyLike
157+
* @name emptyLike
158158
* @memberof ns
159159
* @readonly
160160
* @type {Function}
161161
* @see {@link module:@stdlib/ndarray/empty-like}
162162
*/
163-
setReadOnly( ns, 'ndemptyLike', require( '@stdlib/ndarray/empty-like' ) );
163+
setReadOnly( ns, 'emptyLike', require( '@stdlib/ndarray/empty-like' ) );
164164

165165
/**
166166
* @name FancyArray
@@ -172,22 +172,22 @@ setReadOnly( ns, 'ndemptyLike', require( '@stdlib/ndarray/empty-like' ) );
172172
setReadOnly( ns, 'FancyArray', require( '@stdlib/ndarray/fancy' ) );
173173

174174
/**
175-
* @name ndarrayFlag
175+
* @name flag
176176
* @memberof ns
177177
* @readonly
178178
* @type {Function}
179179
* @see {@link module:@stdlib/ndarray/flag}
180180
*/
181-
setReadOnly( ns, 'ndarrayFlag', require( '@stdlib/ndarray/flag' ) );
181+
setReadOnly( ns, 'flag', require( '@stdlib/ndarray/flag' ) );
182182

183183
/**
184-
* @name ndarrayFlags
184+
* @name flags
185185
* @memberof ns
186186
* @readonly
187187
* @type {Function}
188188
* @see {@link module:@stdlib/ndarray/flags}
189189
*/
190-
setReadOnly( ns, 'ndarrayFlags', require( '@stdlib/ndarray/flags' ) );
190+
setReadOnly( ns, 'flags', require( '@stdlib/ndarray/flags' ) );
191191

192192
/**
193193
* @name scalar2ndarray
@@ -208,13 +208,13 @@ setReadOnly( ns, 'scalar2ndarray', require( '@stdlib/ndarray/from-scalar' ) );
208208
setReadOnly( ns, 'ind2sub', require( '@stdlib/ndarray/ind2sub' ) );
209209

210210
/**
211-
* @name ndarrayIndexModes
211+
* @name indexModes
212212
* @memberof ns
213213
* @readonly
214214
* @type {Function}
215215
* @see {@link module:@stdlib/ndarray/index-modes}
216216
*/
217-
setReadOnly( ns, 'ndarrayIndexModes', require( '@stdlib/ndarray/index-modes' ) );
217+
setReadOnly( ns, 'indexModes', require( '@stdlib/ndarray/index-modes' ) );
218218

219219
/**
220220
* @name iter
@@ -244,22 +244,22 @@ setReadOnly( ns, 'maybeBroadcastArray', require( '@stdlib/ndarray/maybe-broadcas
244244
setReadOnly( ns, 'maybeBroadcastArrays', require( '@stdlib/ndarray/maybe-broadcast-arrays' ) );
245245

246246
/**
247-
* @name ndarrayMinDataType
247+
* @name minDataType
248248
* @memberof ns
249249
* @readonly
250250
* @type {Function}
251251
* @see {@link module:@stdlib/ndarray/min-dtype}
252252
*/
253-
setReadOnly( ns, 'ndarrayMinDataType', require( '@stdlib/ndarray/min-dtype' ) );
253+
setReadOnly( ns, 'minDataType', require( '@stdlib/ndarray/min-dtype' ) );
254254

255255
/**
256-
* @name ndarrayMostlySafeCasts
256+
* @name mostlySafeCasts
257257
* @memberof ns
258258
* @readonly
259259
* @type {Function}
260260
* @see {@link module:@stdlib/ndarray/mostly-safe-casts}
261261
*/
262-
setReadOnly( ns, 'ndarrayMostlySafeCasts', require( '@stdlib/ndarray/mostly-safe-casts' ) );
262+
setReadOnly( ns, 'mostlySafeCasts', require( '@stdlib/ndarray/mostly-safe-casts' ) );
263263

264264
/**
265265
* @name ndims
@@ -271,13 +271,13 @@ setReadOnly( ns, 'ndarrayMostlySafeCasts', require( '@stdlib/ndarray/mostly-safe
271271
setReadOnly( ns, 'ndims', require( '@stdlib/ndarray/ndims' ) );
272272

273273
/**
274-
* @name ndarrayNextDataType
274+
* @name nextDataType
275275
* @memberof ns
276276
* @readonly
277277
* @type {Function}
278278
* @see {@link module:@stdlib/ndarray/next-dtype}
279279
*/
280-
setReadOnly( ns, 'ndarrayNextDataType', require( '@stdlib/ndarray/next-dtype' ) );
280+
setReadOnly( ns, 'nextDataType', require( '@stdlib/ndarray/next-dtype' ) );
281281

282282
/**
283283
* @name numel
@@ -298,88 +298,88 @@ setReadOnly( ns, 'numel', require( '@stdlib/ndarray/numel' ) );
298298
setReadOnly( ns, 'numelDimension', require( '@stdlib/ndarray/numel-dimension' ) );
299299

300300
/**
301-
* @name ndarrayOffset
301+
* @name offset
302302
* @memberof ns
303303
* @readonly
304304
* @type {Function}
305305
* @see {@link module:@stdlib/ndarray/offset}
306306
*/
307-
setReadOnly( ns, 'ndarrayOffset', require( '@stdlib/ndarray/offset' ) );
307+
setReadOnly( ns, 'offset', require( '@stdlib/ndarray/offset' ) );
308308

309309
/**
310-
* @name ndarrayOrder
310+
* @name order
311311
* @memberof ns
312312
* @readonly
313313
* @type {Function}
314314
* @see {@link module:@stdlib/ndarray/order}
315315
*/
316-
setReadOnly( ns, 'ndarrayOrder', require( '@stdlib/ndarray/order' ) );
316+
setReadOnly( ns, 'order', require( '@stdlib/ndarray/order' ) );
317317

318318
/**
319-
* @name ndarrayOrders
319+
* @name orders
320320
* @memberof ns
321321
* @readonly
322322
* @type {Function}
323323
* @see {@link module:@stdlib/ndarray/orders}
324324
*/
325-
setReadOnly( ns, 'ndarrayOrders', require( '@stdlib/ndarray/orders' ) );
325+
setReadOnly( ns, 'orders', require( '@stdlib/ndarray/orders' ) );
326326

327327
/**
328-
* @name ndarrayOutputDataTypePolicies
328+
* @name outputDataTypePolicies
329329
* @memberof ns
330330
* @readonly
331331
* @type {Function}
332332
* @see {@link module:@stdlib/ndarray/output-dtype-policies}
333333
*/
334-
setReadOnly( ns, 'ndarrayOutputDataTypePolicies', require( '@stdlib/ndarray/output-dtype-policies' ) );
334+
setReadOnly( ns, 'outputDataTypePolicies', require( '@stdlib/ndarray/output-dtype-policies' ) );
335335

336336
/**
337-
* @name ndarrayPromotionRules
337+
* @name promotionRules
338338
* @memberof ns
339339
* @readonly
340340
* @type {Function}
341341
* @see {@link module:@stdlib/ndarray/promotion-rules}
342342
*/
343-
setReadOnly( ns, 'ndarrayPromotionRules', require( '@stdlib/ndarray/promotion-rules' ) );
343+
setReadOnly( ns, 'promotionRules', require( '@stdlib/ndarray/promotion-rules' ) );
344344

345345
/**
346-
* @name ndarraySafeCasts
346+
* @name safeCasts
347347
* @memberof ns
348348
* @readonly
349349
* @type {Function}
350350
* @see {@link module:@stdlib/ndarray/safe-casts}
351351
*/
352-
setReadOnly( ns, 'ndarraySafeCasts', require( '@stdlib/ndarray/safe-casts' ) );
352+
setReadOnly( ns, 'safeCasts', require( '@stdlib/ndarray/safe-casts' ) );
353353

354354
/**
355-
* @name ndarraySameKindCasts
355+
* @name sameKindCasts
356356
* @memberof ns
357357
* @readonly
358358
* @type {Function}
359359
* @see {@link module:@stdlib/ndarray/same-kind-casts}
360360
*/
361-
setReadOnly( ns, 'ndarraySameKindCasts', require( '@stdlib/ndarray/same-kind-casts' ) );
361+
setReadOnly( ns, 'sameKindCasts', require( '@stdlib/ndarray/same-kind-casts' ) );
362362

363363
/**
364-
* @name ndarrayShape
364+
* @name shape
365365
* @memberof ns
366366
* @readonly
367367
* @type {Function}
368368
* @see {@link module:@stdlib/ndarray/shape}
369369
*/
370-
setReadOnly( ns, 'ndarrayShape', require( '@stdlib/ndarray/shape' ) );
370+
setReadOnly( ns, 'shape', require( '@stdlib/ndarray/shape' ) );
371371

372372
/**
373-
* @name ndslice
373+
* @name slice
374374
* @memberof ns
375375
* @readonly
376376
* @type {Function}
377377
* @see {@link module:@stdlib/ndarray/slice}
378378
*/
379-
setReadOnly( ns, 'ndslice', require( '@stdlib/ndarray/slice' ) );
379+
setReadOnly( ns, 'slice', require( '@stdlib/ndarray/slice' ) );
380380

381381
/**
382-
* @name ndsliceAssign
382+
* @name sliceAssign
383383
* @memberof ns
384384
* @readonly
385385
* @type {Function}
@@ -388,67 +388,67 @@ setReadOnly( ns, 'ndslice', require( '@stdlib/ndarray/slice' ) );
388388
setReadOnly( ns, 'ndsliceAssign', require( '@stdlib/ndarray/slice-assign' ) );
389389

390390
/**
391-
* @name ndsliceDimension
391+
* @name sliceDimension
392392
* @memberof ns
393393
* @readonly
394394
* @type {Function}
395395
* @see {@link module:@stdlib/ndarray/slice-dimension}
396396
*/
397-
setReadOnly( ns, 'ndsliceDimension', require( '@stdlib/ndarray/slice-dimension' ) );
397+
setReadOnly( ns, 'sliceDimension', require( '@stdlib/ndarray/slice-dimension' ) );
398398

399399
/**
400-
* @name ndsliceDimensionFrom
400+
* @name sliceDimensionFrom
401401
* @memberof ns
402402
* @readonly
403403
* @type {Function}
404404
* @see {@link module:@stdlib/ndarray/slice-dimension-from}
405405
*/
406-
setReadOnly( ns, 'ndsliceDimensionFrom', require( '@stdlib/ndarray/slice-dimension-from' ) );
406+
setReadOnly( ns, 'sliceDimensionFrom', require( '@stdlib/ndarray/slice-dimension-from' ) );
407407

408408
/**
409-
* @name ndsliceDimensionTo
409+
* @name sliceDimensionTo
410410
* @memberof ns
411411
* @readonly
412412
* @type {Function}
413413
* @see {@link module:@stdlib/ndarray/slice-dimension-to}
414414
*/
415-
setReadOnly( ns, 'ndsliceDimensionTo', require( '@stdlib/ndarray/slice-dimension-to' ) );
415+
setReadOnly( ns, 'sliceDimensionTo', require( '@stdlib/ndarray/slice-dimension-to' ) );
416416

417417
/**
418-
* @name ndsliceFrom
418+
* @name sliceFrom
419419
* @memberof ns
420420
* @readonly
421421
* @type {Function}
422422
* @see {@link module:@stdlib/ndarray/slice-from}
423423
*/
424-
setReadOnly( ns, 'ndsliceFrom', require( '@stdlib/ndarray/slice-from' ) );
424+
setReadOnly( ns, 'sliceFrom', require( '@stdlib/ndarray/slice-from' ) );
425425

426426
/**
427-
* @name ndsliceTo
427+
* @name sliceTo
428428
* @memberof ns
429429
* @readonly
430430
* @type {Function}
431431
* @see {@link module:@stdlib/ndarray/slice-to}
432432
*/
433-
setReadOnly( ns, 'ndsliceTo', require( '@stdlib/ndarray/slice-to' ) );
433+
setReadOnly( ns, 'sliceTo', require( '@stdlib/ndarray/slice-to' ) );
434434

435435
/**
436-
* @name ndarrayStride
436+
* @name stride
437437
* @memberof ns
438438
* @readonly
439439
* @type {Function}
440440
* @see {@link module:@stdlib/ndarray/stride}
441441
*/
442-
setReadOnly( ns, 'ndarrayStride', require( '@stdlib/ndarray/stride' ) );
442+
setReadOnly( ns, 'stride', require( '@stdlib/ndarray/stride' ) );
443443

444444
/**
445-
* @name ndarrayStrides
445+
* @name strides
446446
* @memberof ns
447447
* @readonly
448448
* @type {Function}
449449
* @see {@link module:@stdlib/ndarray/strides}
450450
*/
451-
setReadOnly( ns, 'ndarrayStrides', require( '@stdlib/ndarray/strides' ) );
451+
setReadOnly( ns, 'strides', require( '@stdlib/ndarray/strides' ) );
452452

453453
/**
454454
* @name sub2ind
@@ -469,22 +469,22 @@ setReadOnly( ns, 'sub2ind', require( '@stdlib/ndarray/sub2ind' ) );
469469
setReadOnly( ns, 'ndarray2array', require( '@stdlib/ndarray/to-array' ) );
470470

471471
/**
472-
* @name ndzeros
472+
* @name zeros
473473
* @memberof ns
474474
* @readonly
475475
* @type {Function}
476476
* @see {@link module:@stdlib/ndarray/zeros}
477477
*/
478-
setReadOnly( ns, 'ndzeros', require( '@stdlib/ndarray/zeros' ) );
478+
setReadOnly( ns, 'zeros', require( '@stdlib/ndarray/zeros' ) );
479479

480480
/**
481-
* @name ndzerosLike
481+
* @name zerosLike
482482
* @memberof ns
483483
* @readonly
484484
* @type {Function}
485485
* @see {@link module:@stdlib/ndarray/zeros-like}
486486
*/
487-
setReadOnly( ns, 'ndzerosLike', require( '@stdlib/ndarray/zeros-like' ) );
487+
setReadOnly( ns, 'zerosLike', require( '@stdlib/ndarray/zeros-like' ) );
488488

489489

490490
// EXPORTS //

0 commit comments

Comments
 (0)