@stdlib/ndarray-base 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/NOTICE +1 -1
- package/README.md +87 -3
- package/SECURITY.md +5 -0
- package/dist/index.js +1 -1
- package/dist/index.js.map +2 -2
- package/docs/types/index.d.ts +1007 -53
- package/lib/index.js +243 -0
- package/package.json +259 -212
- package/CITATION.cff +0 -30
package/lib/index.js
CHANGED
|
@@ -49,6 +49,15 @@ var ns = {};
|
|
|
49
49
|
*/
|
|
50
50
|
setReadOnly( ns, 'assert', require( '@stdlib/ndarray-base-assert' ) );
|
|
51
51
|
|
|
52
|
+
/**
|
|
53
|
+
* @name assign
|
|
54
|
+
* @memberof ns
|
|
55
|
+
* @readonly
|
|
56
|
+
* @type {Function}
|
|
57
|
+
* @see {@link module:@stdlib/ndarray/base/assign}
|
|
58
|
+
*/
|
|
59
|
+
setReadOnly( ns, 'assign', require( '@stdlib/ndarray-base-assign' ) );
|
|
60
|
+
|
|
52
61
|
/**
|
|
53
62
|
* @name binaryLoopOrder
|
|
54
63
|
* @memberof ns
|
|
@@ -85,6 +94,15 @@ setReadOnly( ns, 'bind2vind', require( '@stdlib/ndarray-base-bind2vind' ) );
|
|
|
85
94
|
*/
|
|
86
95
|
setReadOnly( ns, 'broadcastArray', require( '@stdlib/ndarray-base-broadcast-array' ) );
|
|
87
96
|
|
|
97
|
+
/**
|
|
98
|
+
* @name broadcastArrays
|
|
99
|
+
* @memberof ns
|
|
100
|
+
* @readonly
|
|
101
|
+
* @type {Function}
|
|
102
|
+
* @see {@link module:@stdlib/ndarray/base/broadcast-arrays}
|
|
103
|
+
*/
|
|
104
|
+
setReadOnly( ns, 'broadcastArrays', require( '@stdlib/ndarray-base-broadcast-arrays' ) );
|
|
105
|
+
|
|
88
106
|
/**
|
|
89
107
|
* @name broadcastScalar
|
|
90
108
|
* @memberof ns
|
|
@@ -175,6 +193,24 @@ setReadOnly( ns, 'clampIndex', require( '@stdlib/ndarray-base-clamp-index' ) );
|
|
|
175
193
|
*/
|
|
176
194
|
setReadOnly( ns, 'ndarray', require( '@stdlib/ndarray-base-ctor' ) );
|
|
177
195
|
|
|
196
|
+
/**
|
|
197
|
+
* @name data
|
|
198
|
+
* @memberof ns
|
|
199
|
+
* @readonly
|
|
200
|
+
* @type {Function}
|
|
201
|
+
* @see {@link module:@stdlib/ndarray/base/data-buffer}
|
|
202
|
+
*/
|
|
203
|
+
setReadOnly( ns, 'data', require( '@stdlib/ndarray-base-data-buffer' ) );
|
|
204
|
+
|
|
205
|
+
/**
|
|
206
|
+
* @name dtype
|
|
207
|
+
* @memberof ns
|
|
208
|
+
* @readonly
|
|
209
|
+
* @type {Function}
|
|
210
|
+
* @see {@link module:@stdlib/ndarray/base/dtype}
|
|
211
|
+
*/
|
|
212
|
+
setReadOnly( ns, 'dtype', require( '@stdlib/ndarray-base-dtype' ) );
|
|
213
|
+
|
|
178
214
|
/**
|
|
179
215
|
* @name dtypeChar
|
|
180
216
|
* @memberof ns
|
|
@@ -274,6 +310,42 @@ setReadOnly( ns, 'emptyLike', require( '@stdlib/ndarray-base-empty-like' ) );
|
|
|
274
310
|
*/
|
|
275
311
|
setReadOnly( ns, 'expandDimensions', require( '@stdlib/ndarray-base-expand-dimensions' ) );
|
|
276
312
|
|
|
313
|
+
/**
|
|
314
|
+
* @name flag
|
|
315
|
+
* @memberof ns
|
|
316
|
+
* @readonly
|
|
317
|
+
* @type {Function}
|
|
318
|
+
* @see {@link module:@stdlib/ndarray/base/flag}
|
|
319
|
+
*/
|
|
320
|
+
setReadOnly( ns, 'flag', require( '@stdlib/ndarray-base-flag' ) );
|
|
321
|
+
|
|
322
|
+
/**
|
|
323
|
+
* @name flags
|
|
324
|
+
* @memberof ns
|
|
325
|
+
* @readonly
|
|
326
|
+
* @type {Function}
|
|
327
|
+
* @see {@link module:@stdlib/ndarray/base/flags}
|
|
328
|
+
*/
|
|
329
|
+
setReadOnly( ns, 'flags', require( '@stdlib/ndarray-base-flags' ) );
|
|
330
|
+
|
|
331
|
+
/**
|
|
332
|
+
* @name fliplr
|
|
333
|
+
* @memberof ns
|
|
334
|
+
* @readonly
|
|
335
|
+
* @type {Function}
|
|
336
|
+
* @see {@link module:@stdlib/ndarray/base/fliplr}
|
|
337
|
+
*/
|
|
338
|
+
setReadOnly( ns, 'fliplr', require( '@stdlib/ndarray-base-fliplr' ) );
|
|
339
|
+
|
|
340
|
+
/**
|
|
341
|
+
* @name flipud
|
|
342
|
+
* @memberof ns
|
|
343
|
+
* @readonly
|
|
344
|
+
* @type {Function}
|
|
345
|
+
* @see {@link module:@stdlib/ndarray/base/flipud}
|
|
346
|
+
*/
|
|
347
|
+
setReadOnly( ns, 'flipud', require( '@stdlib/ndarray-base-flipud' ) );
|
|
348
|
+
|
|
277
349
|
/**
|
|
278
350
|
* @name scalar2ndarray
|
|
279
351
|
* @memberof ns
|
|
@@ -328,6 +400,15 @@ setReadOnly( ns, 'maxViewBufferIndex', require( '@stdlib/ndarray-base-max-view-b
|
|
|
328
400
|
*/
|
|
329
401
|
setReadOnly( ns, 'maybeBroadcastArray', require( '@stdlib/ndarray-base-maybe-broadcast-array' ) );
|
|
330
402
|
|
|
403
|
+
/**
|
|
404
|
+
* @name maybeBroadcastArrays
|
|
405
|
+
* @memberof ns
|
|
406
|
+
* @readonly
|
|
407
|
+
* @type {Function}
|
|
408
|
+
* @see {@link module:@stdlib/ndarray/base/maybe-broadcast-arrays}
|
|
409
|
+
*/
|
|
410
|
+
setReadOnly( ns, 'maybeBroadcastArrays', require( '@stdlib/ndarray-base-maybe-broadcast-arrays' ) );
|
|
411
|
+
|
|
331
412
|
/**
|
|
332
413
|
* @name metaDataProps
|
|
333
414
|
* @memberof ns
|
|
@@ -364,6 +445,24 @@ setReadOnly( ns, 'minmaxViewBufferIndex', require( '@stdlib/ndarray-base-minmax-
|
|
|
364
445
|
*/
|
|
365
446
|
setReadOnly( ns, 'ndarraylike2object', require( '@stdlib/ndarray-base-ndarraylike2object' ) );
|
|
366
447
|
|
|
448
|
+
/**
|
|
449
|
+
* @name ndims
|
|
450
|
+
* @memberof ns
|
|
451
|
+
* @readonly
|
|
452
|
+
* @type {Function}
|
|
453
|
+
* @see {@link module:@stdlib/ndarray/base/ndims}
|
|
454
|
+
*/
|
|
455
|
+
setReadOnly( ns, 'ndims', require( '@stdlib/ndarray-base-ndims' ) );
|
|
456
|
+
|
|
457
|
+
/**
|
|
458
|
+
* @name nextCartesianIndex
|
|
459
|
+
* @memberof ns
|
|
460
|
+
* @readonly
|
|
461
|
+
* @type {Function}
|
|
462
|
+
* @see {@link module:@stdlib/ndarray/base/next-cartesian-index}
|
|
463
|
+
*/
|
|
464
|
+
setReadOnly( ns, 'nextCartesianIndex', require( '@stdlib/ndarray-base-next-cartesian-index' ) );
|
|
465
|
+
|
|
367
466
|
/**
|
|
368
467
|
* @name nonsingletonDimensions
|
|
369
468
|
* @memberof ns
|
|
@@ -373,6 +472,15 @@ setReadOnly( ns, 'ndarraylike2object', require( '@stdlib/ndarray-base-ndarraylik
|
|
|
373
472
|
*/
|
|
374
473
|
setReadOnly( ns, 'nonsingletonDimensions', require( '@stdlib/ndarray-base-nonsingleton-dimensions' ) );
|
|
375
474
|
|
|
475
|
+
/**
|
|
476
|
+
* @name normalizeIndex
|
|
477
|
+
* @memberof ns
|
|
478
|
+
* @readonly
|
|
479
|
+
* @type {Function}
|
|
480
|
+
* @see {@link module:@stdlib/ndarray/base/normalize-index}
|
|
481
|
+
*/
|
|
482
|
+
setReadOnly( ns, 'normalizeIndex', require( '@stdlib/ndarray-base-normalize-index' ) );
|
|
483
|
+
|
|
376
484
|
/**
|
|
377
485
|
* @name nullary
|
|
378
486
|
* @memberof ns
|
|
@@ -409,6 +517,33 @@ setReadOnly( ns, 'nullaryBlockSize', require( '@stdlib/ndarray-base-nullary-tili
|
|
|
409
517
|
*/
|
|
410
518
|
setReadOnly( ns, 'numel', require( '@stdlib/ndarray-base-numel' ) );
|
|
411
519
|
|
|
520
|
+
/**
|
|
521
|
+
* @name numelDimension
|
|
522
|
+
* @memberof ns
|
|
523
|
+
* @readonly
|
|
524
|
+
* @type {Function}
|
|
525
|
+
* @see {@link module:@stdlib/ndarray/base/numel-dimension}
|
|
526
|
+
*/
|
|
527
|
+
setReadOnly( ns, 'numelDimension', require( '@stdlib/ndarray-base-numel-dimension' ) );
|
|
528
|
+
|
|
529
|
+
/**
|
|
530
|
+
* @name offset
|
|
531
|
+
* @memberof ns
|
|
532
|
+
* @readonly
|
|
533
|
+
* @type {Function}
|
|
534
|
+
* @see {@link module:@stdlib/ndarray/base/offset}
|
|
535
|
+
*/
|
|
536
|
+
setReadOnly( ns, 'offset', require( '@stdlib/ndarray-base-offset' ) );
|
|
537
|
+
|
|
538
|
+
/**
|
|
539
|
+
* @name order
|
|
540
|
+
* @memberof ns
|
|
541
|
+
* @readonly
|
|
542
|
+
* @type {Function}
|
|
543
|
+
* @see {@link module:@stdlib/ndarray/base/order}
|
|
544
|
+
*/
|
|
545
|
+
setReadOnly( ns, 'order', require( '@stdlib/ndarray-base-order' ) );
|
|
546
|
+
|
|
412
547
|
/**
|
|
413
548
|
* @name outputPolicyEnum2Str
|
|
414
549
|
* @memberof ns
|
|
@@ -463,6 +598,24 @@ setReadOnly( ns, 'prependSingletonDimensions', require( '@stdlib/ndarray-base-pr
|
|
|
463
598
|
*/
|
|
464
599
|
setReadOnly( ns, 'removeSingletonDimensions', require( '@stdlib/ndarray-base-remove-singleton-dimensions' ) );
|
|
465
600
|
|
|
601
|
+
/**
|
|
602
|
+
* @name reverse
|
|
603
|
+
* @memberof ns
|
|
604
|
+
* @readonly
|
|
605
|
+
* @type {Function}
|
|
606
|
+
* @see {@link module:@stdlib/ndarray/base/reverse}
|
|
607
|
+
*/
|
|
608
|
+
setReadOnly( ns, 'reverse', require( '@stdlib/ndarray-base-reverse' ) );
|
|
609
|
+
|
|
610
|
+
/**
|
|
611
|
+
* @name reverseDimension
|
|
612
|
+
* @memberof ns
|
|
613
|
+
* @readonly
|
|
614
|
+
* @type {Function}
|
|
615
|
+
* @see {@link module:@stdlib/ndarray/base/reverse-dimension}
|
|
616
|
+
*/
|
|
617
|
+
setReadOnly( ns, 'reverseDimension', require( '@stdlib/ndarray-base-reverse-dimension' ) );
|
|
618
|
+
|
|
466
619
|
/**
|
|
467
620
|
* @name serializeMetaData
|
|
468
621
|
* @memberof ns
|
|
@@ -472,6 +625,15 @@ setReadOnly( ns, 'removeSingletonDimensions', require( '@stdlib/ndarray-base-rem
|
|
|
472
625
|
*/
|
|
473
626
|
setReadOnly( ns, 'serializeMetaData', require( '@stdlib/ndarray-base-serialize-meta-data' ) );
|
|
474
627
|
|
|
628
|
+
/**
|
|
629
|
+
* @name shape
|
|
630
|
+
* @memberof ns
|
|
631
|
+
* @readonly
|
|
632
|
+
* @type {Function}
|
|
633
|
+
* @see {@link module:@stdlib/ndarray/base/shape}
|
|
634
|
+
*/
|
|
635
|
+
setReadOnly( ns, 'shape', require( '@stdlib/ndarray-base-shape' ) );
|
|
636
|
+
|
|
475
637
|
/**
|
|
476
638
|
* @name shape2strides
|
|
477
639
|
* @memberof ns
|
|
@@ -490,6 +652,87 @@ setReadOnly( ns, 'shape2strides', require( '@stdlib/ndarray-base-shape2strides'
|
|
|
490
652
|
*/
|
|
491
653
|
setReadOnly( ns, 'singletonDimensions', require( '@stdlib/ndarray-base-singleton-dimensions' ) );
|
|
492
654
|
|
|
655
|
+
/**
|
|
656
|
+
* @name slice
|
|
657
|
+
* @memberof ns
|
|
658
|
+
* @readonly
|
|
659
|
+
* @type {Function}
|
|
660
|
+
* @see {@link module:@stdlib/ndarray/base/slice}
|
|
661
|
+
*/
|
|
662
|
+
setReadOnly( ns, 'slice', require( '@stdlib/ndarray-base-slice' ) );
|
|
663
|
+
|
|
664
|
+
/**
|
|
665
|
+
* @name sliceAssign
|
|
666
|
+
* @memberof ns
|
|
667
|
+
* @readonly
|
|
668
|
+
* @type {Function}
|
|
669
|
+
* @see {@link module:@stdlib/ndarray/base/slice-assign}
|
|
670
|
+
*/
|
|
671
|
+
setReadOnly( ns, 'sliceAssign', require( '@stdlib/ndarray-base-slice-assign' ) );
|
|
672
|
+
|
|
673
|
+
/**
|
|
674
|
+
* @name sliceDimension
|
|
675
|
+
* @memberof ns
|
|
676
|
+
* @readonly
|
|
677
|
+
* @type {Function}
|
|
678
|
+
* @see {@link module:@stdlib/ndarray/base/slice-dimension}
|
|
679
|
+
*/
|
|
680
|
+
setReadOnly( ns, 'sliceDimension', require( '@stdlib/ndarray-base-slice-dimension' ) );
|
|
681
|
+
|
|
682
|
+
/**
|
|
683
|
+
* @name sliceDimensionFrom
|
|
684
|
+
* @memberof ns
|
|
685
|
+
* @readonly
|
|
686
|
+
* @type {Function}
|
|
687
|
+
* @see {@link module:@stdlib/ndarray/base/slice-dimension-from}
|
|
688
|
+
*/
|
|
689
|
+
setReadOnly( ns, 'sliceDimensionFrom', require( '@stdlib/ndarray-base-slice-dimension-from' ) );
|
|
690
|
+
|
|
691
|
+
/**
|
|
692
|
+
* @name sliceDimensionTo
|
|
693
|
+
* @memberof ns
|
|
694
|
+
* @readonly
|
|
695
|
+
* @type {Function}
|
|
696
|
+
* @see {@link module:@stdlib/ndarray/base/slice-dimension-to}
|
|
697
|
+
*/
|
|
698
|
+
setReadOnly( ns, 'sliceDimensionTo', require( '@stdlib/ndarray-base-slice-dimension-to' ) );
|
|
699
|
+
|
|
700
|
+
/**
|
|
701
|
+
* @name sliceFrom
|
|
702
|
+
* @memberof ns
|
|
703
|
+
* @readonly
|
|
704
|
+
* @type {Function}
|
|
705
|
+
* @see {@link module:@stdlib/ndarray/base/slice-from}
|
|
706
|
+
*/
|
|
707
|
+
setReadOnly( ns, 'sliceFrom', require( '@stdlib/ndarray-base-slice-from' ) );
|
|
708
|
+
|
|
709
|
+
/**
|
|
710
|
+
* @name sliceTo
|
|
711
|
+
* @memberof ns
|
|
712
|
+
* @readonly
|
|
713
|
+
* @type {Function}
|
|
714
|
+
* @see {@link module:@stdlib/ndarray/base/slice-to}
|
|
715
|
+
*/
|
|
716
|
+
setReadOnly( ns, 'sliceTo', require( '@stdlib/ndarray-base-slice-to' ) );
|
|
717
|
+
|
|
718
|
+
/**
|
|
719
|
+
* @name stride
|
|
720
|
+
* @memberof ns
|
|
721
|
+
* @readonly
|
|
722
|
+
* @type {Function}
|
|
723
|
+
* @see {@link module:@stdlib/ndarray/base/stride}
|
|
724
|
+
*/
|
|
725
|
+
setReadOnly( ns, 'stride', require( '@stdlib/ndarray-base-stride' ) );
|
|
726
|
+
|
|
727
|
+
/**
|
|
728
|
+
* @name strides
|
|
729
|
+
* @memberof ns
|
|
730
|
+
* @readonly
|
|
731
|
+
* @type {Function}
|
|
732
|
+
* @see {@link module:@stdlib/ndarray/base/strides}
|
|
733
|
+
*/
|
|
734
|
+
setReadOnly( ns, 'strides', require( '@stdlib/ndarray-base-strides' ) );
|
|
735
|
+
|
|
493
736
|
/**
|
|
494
737
|
* @name strides2offset
|
|
495
738
|
* @memberof ns
|