@stdlib/ndarray-base 0.0.3 → 0.0.7
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 +92 -26
- package/docs/types/index.d.ts +198 -8
- package/lib/index.js +162 -0
- package/package.json +31 -2
- package/CHANGELOG.md +0 -5
package/NOTICE
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
Copyright (c) 2016-
|
|
1
|
+
Copyright (c) 2016-2022 The Stdlib Authors.
|
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ limitations under the License.
|
|
|
20
20
|
|
|
21
21
|
# Base
|
|
22
22
|
|
|
23
|
-
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
|
|
23
|
+
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
|
|
24
24
|
|
|
25
25
|
> Base ndarray.
|
|
26
26
|
|
|
@@ -56,21 +56,36 @@ var o = ns;
|
|
|
56
56
|
<div class="namespace-toc">
|
|
57
57
|
|
|
58
58
|
- <span class="signature">[`bind2vind( shape, strides, offset, order, idx, mode )`][@stdlib/ndarray/base/bind2vind]</span><span class="delimiter">: </span><span class="description">convert a linear index in an underlying data buffer to a linear index in an array view.</span>
|
|
59
|
+
- <span class="signature">[`broadcastArray( arr, shape )`][@stdlib/ndarray/base/broadcast-array]</span><span class="delimiter">: </span><span class="description">broadcast an ndarray to a specified shape.</span>
|
|
60
|
+
- <span class="signature">[`broadcastShapes( shapes )`][@stdlib/ndarray/base/broadcast-shapes]</span><span class="delimiter">: </span><span class="description">broadcast array shapes to a single shape.</span>
|
|
59
61
|
- <span class="signature">[`bufferCtors( dtype )`][@stdlib/ndarray/base/buffer-ctors]</span><span class="delimiter">: </span><span class="description">ndarray data buffer constructors.</span>
|
|
62
|
+
- <span class="signature">[`bufferDataTypeEnum( buffer )`][@stdlib/ndarray/base/buffer-dtype-enum]</span><span class="delimiter">: </span><span class="description">return the data type enumeration constant of an ndarray data buffer.</span>
|
|
60
63
|
- <span class="signature">[`bufferDataType( buffer )`][@stdlib/ndarray/base/buffer-dtype]</span><span class="delimiter">: </span><span class="description">return the data type of an ndarray data buffer.</span>
|
|
61
64
|
- <span class="signature">[`buffer( dtype, size )`][@stdlib/ndarray/base/buffer]</span><span class="delimiter">: </span><span class="description">create a zero-filled contiguous linear ndarray data buffer.</span>
|
|
62
65
|
- <span class="signature">[`bytesPerElement( dtype )`][@stdlib/ndarray/base/bytes-per-element]</span><span class="delimiter">: </span><span class="description">return the number of bytes per element provided an underlying array data type.</span>
|
|
66
|
+
- <span class="signature">[`char2dtype( [ch] )`][@stdlib/ndarray/base/char2dtype]</span><span class="delimiter">: </span><span class="description">return the data type string associated with a provided single letter character abbreviation.</span>
|
|
63
67
|
- <span class="signature">[`clampIndex( idx, max )`][@stdlib/ndarray/base/clamp-index]</span><span class="delimiter">: </span><span class="description">restrict an index to the interval `[0,max]`.</span>
|
|
64
68
|
- <span class="signature">[`ndarray( dtype, buffer, shape, strides, offset, order )`][@stdlib/ndarray/base/ctor]</span><span class="delimiter">: </span><span class="description">create a multidimensional array.</span>
|
|
65
|
-
- <span class="signature">[`dtypeChar( dtype )`][@stdlib/ndarray/base/dtype-char]</span><span class="delimiter">: </span><span class="description">return the single letter abbreviation for an underlying array data type.</span>
|
|
69
|
+
- <span class="signature">[`dtypeChar( [dtype] )`][@stdlib/ndarray/base/dtype-char]</span><span class="delimiter">: </span><span class="description">return the single letter abbreviation for an underlying array data type.</span>
|
|
70
|
+
- <span class="signature">[`dtypeDesc( [dtype] )`][@stdlib/ndarray/base/dtype-desc]</span><span class="delimiter">: </span><span class="description">return the description for a specified data type.</span>
|
|
71
|
+
- <span class="signature">[`dtypeEnum2Str( dtype )`][@stdlib/ndarray/base/dtype-enum2str]</span><span class="delimiter">: </span><span class="description">return the data type string associated with an ndarray data type enumeration constant.</span>
|
|
72
|
+
- <span class="signature">[`dtypeResolveEnum( dtype )`][@stdlib/ndarray/base/dtype-resolve-enum]</span><span class="delimiter">: </span><span class="description">return the enumeration constant associated with a supported ndarray data type value.</span>
|
|
73
|
+
- <span class="signature">[`dtypeResolveStr( dtype )`][@stdlib/ndarray/base/dtype-resolve-str]</span><span class="delimiter">: </span><span class="description">return the data type string associated with a supported ndarray data type value.</span>
|
|
74
|
+
- <span class="signature">[`dtypeStr2Enum( dtype )`][@stdlib/ndarray/base/dtype-str2enum]</span><span class="delimiter">: </span><span class="description">return the enumeration constant associated with an ndarray data type string.</span>
|
|
75
|
+
- <span class="signature">[`dtype2c( dtype )`][@stdlib/ndarray/base/dtype2c]</span><span class="delimiter">: </span><span class="description">return the C data type associated with a provided data type string.</span>
|
|
76
|
+
- <span class="signature">[`dtypes2signatures( dtypes, nin, nout )`][@stdlib/ndarray/base/dtypes2signatures]</span><span class="delimiter">: </span><span class="description">transform a list of array argument data types into a list of signatures.</span>
|
|
66
77
|
- <span class="signature">[`ind( idx, max, mode )`][@stdlib/ndarray/base/ind]</span><span class="delimiter">: </span><span class="description">return an index given an index mode.</span>
|
|
67
78
|
- <span class="signature">[`ind2sub( shape, strides, offset, order, idx, mode )`][@stdlib/ndarray/base/ind2sub]</span><span class="delimiter">: </span><span class="description">convert a linear index to an array of subscripts.</span>
|
|
68
79
|
- <span class="signature">[`iterationOrder( strides )`][@stdlib/ndarray/base/iteration-order]</span><span class="delimiter">: </span><span class="description">given a stride array, determine array iteration order.</span>
|
|
69
80
|
- <span class="signature">[`maxViewBufferIndex( shape, strides, offset )`][@stdlib/ndarray/base/max-view-buffer-index]</span><span class="delimiter">: </span><span class="description">compute the maximum linear index in an underlying data buffer accessible to an array view.</span>
|
|
81
|
+
- <span class="signature">[`metaDataProps( meta, dtypes, obj )`][@stdlib/ndarray/base/meta-data-props]</span><span class="delimiter">: </span><span class="description">define non-enumerable read-only properties which expose ndarray function meta data.</span>
|
|
70
82
|
- <span class="signature">[`minViewBufferIndex( shape, strides, offset )`][@stdlib/ndarray/base/min-view-buffer-index]</span><span class="delimiter">: </span><span class="description">compute the minimum linear index in an underlying data buffer accessible to an array view.</span>
|
|
71
83
|
- <span class="signature">[`minmaxViewBufferIndex( shape, strides, offset )`][@stdlib/ndarray/base/minmax-view-buffer-index]</span><span class="delimiter">: </span><span class="description">compute the minimum and maximum linear indices in an underlying data buffer which are accessible to an array view.</span>
|
|
84
|
+
- <span class="signature">[`nonsingletonDimensions( shape )`][@stdlib/ndarray/base/nonsingleton-dimensions]</span><span class="delimiter">: </span><span class="description">return the number of non-singleton dimensions.</span>
|
|
72
85
|
- <span class="signature">[`numel( shape )`][@stdlib/ndarray/base/numel]</span><span class="delimiter">: </span><span class="description">return the number of elements in an array.</span>
|
|
86
|
+
- <span class="signature">[`serializeMetaData( x )`][@stdlib/ndarray/base/serialize-meta-data]</span><span class="delimiter">: </span><span class="description">serialize ndarray meta data.</span>
|
|
73
87
|
- <span class="signature">[`shape2strides( shape, order )`][@stdlib/ndarray/base/shape2strides]</span><span class="delimiter">: </span><span class="description">generate a stride array from an array shape.</span>
|
|
88
|
+
- <span class="signature">[`singletonDimensions( shape )`][@stdlib/ndarray/base/singleton-dimensions]</span><span class="delimiter">: </span><span class="description">return the number of singleton dimensions.</span>
|
|
74
89
|
- <span class="signature">[`strides2offset( shape, strides )`][@stdlib/ndarray/base/strides2offset]</span><span class="delimiter">: </span><span class="description">determine the index offset which specifies the location of the first indexed value in a multidimensional array based on a stride array.</span>
|
|
75
90
|
- <span class="signature">[`strides2order( strides )`][@stdlib/ndarray/base/strides2order]</span><span class="delimiter">: </span><span class="description">determine the order of a multidimensional array based on a provided stride array.</span>
|
|
76
91
|
- <span class="signature">[`sub2ind( shape, strides, offset, ...subscripts, mode )`][@stdlib/ndarray/base/sub2ind]</span><span class="delimiter">: </span><span class="description">convert subscripts to a linear index.</span>
|
|
@@ -117,6 +132,16 @@ console.log( objectKeys( ns ) );
|
|
|
117
132
|
|
|
118
133
|
<!-- /.examples -->
|
|
119
134
|
|
|
135
|
+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
|
|
136
|
+
|
|
137
|
+
<section class="related">
|
|
138
|
+
|
|
139
|
+
</section>
|
|
140
|
+
|
|
141
|
+
<!-- /.related -->
|
|
142
|
+
|
|
143
|
+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
144
|
+
|
|
120
145
|
|
|
121
146
|
<section class="main-repo" >
|
|
122
147
|
|
|
@@ -141,7 +166,7 @@ See [LICENSE][stdlib-license].
|
|
|
141
166
|
|
|
142
167
|
## Copyright
|
|
143
168
|
|
|
144
|
-
Copyright © 2016-
|
|
169
|
+
Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
145
170
|
|
|
146
171
|
</section>
|
|
147
172
|
|
|
@@ -160,9 +185,20 @@ Copyright © 2016-2021. The Stdlib [Authors][stdlib-authors].
|
|
|
160
185
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base/main.svg
|
|
161
186
|
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base?branch=main
|
|
162
187
|
|
|
188
|
+
<!--
|
|
189
|
+
|
|
163
190
|
[dependencies-image]: https://img.shields.io/david/stdlib-js/ndarray-base.svg
|
|
164
191
|
[dependencies-url]: https://david-dm.org/stdlib-js/ndarray-base/main
|
|
165
192
|
|
|
193
|
+
-->
|
|
194
|
+
|
|
195
|
+
[umd]: https://github.com/umdjs/umd
|
|
196
|
+
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
|
|
197
|
+
|
|
198
|
+
[deno-url]: https://github.com/stdlib-js/ndarray-base/tree/deno
|
|
199
|
+
[umd-url]: https://github.com/stdlib-js/ndarray-base/tree/umd
|
|
200
|
+
[esm-url]: https://github.com/stdlib-js/ndarray-base/tree/esm
|
|
201
|
+
|
|
166
202
|
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
167
203
|
[chat-url]: https://gitter.im/stdlib-js/stdlib/
|
|
168
204
|
|
|
@@ -174,51 +210,81 @@ Copyright © 2016-2021. The Stdlib [Authors][stdlib-authors].
|
|
|
174
210
|
|
|
175
211
|
<!-- <toc-links> -->
|
|
176
212
|
|
|
177
|
-
[@stdlib/ndarray/base/assert]: https://
|
|
213
|
+
[@stdlib/ndarray/base/assert]: https://www.npmjs.com/package/@stdlib/ndarray-base-assert
|
|
214
|
+
|
|
215
|
+
[@stdlib/ndarray/base/bind2vind]: https://www.npmjs.com/package/@stdlib/ndarray-base-bind2vind
|
|
216
|
+
|
|
217
|
+
[@stdlib/ndarray/base/broadcast-array]: https://www.npmjs.com/package/@stdlib/ndarray-base-broadcast-array
|
|
218
|
+
|
|
219
|
+
[@stdlib/ndarray/base/broadcast-shapes]: https://www.npmjs.com/package/@stdlib/ndarray-base-broadcast-shapes
|
|
220
|
+
|
|
221
|
+
[@stdlib/ndarray/base/buffer-ctors]: https://www.npmjs.com/package/@stdlib/ndarray-base-buffer-ctors
|
|
222
|
+
|
|
223
|
+
[@stdlib/ndarray/base/buffer-dtype-enum]: https://www.npmjs.com/package/@stdlib/ndarray-base-buffer-dtype-enum
|
|
224
|
+
|
|
225
|
+
[@stdlib/ndarray/base/buffer-dtype]: https://www.npmjs.com/package/@stdlib/ndarray-base-buffer-dtype
|
|
226
|
+
|
|
227
|
+
[@stdlib/ndarray/base/buffer]: https://www.npmjs.com/package/@stdlib/ndarray-base-buffer
|
|
228
|
+
|
|
229
|
+
[@stdlib/ndarray/base/bytes-per-element]: https://www.npmjs.com/package/@stdlib/ndarray-base-bytes-per-element
|
|
230
|
+
|
|
231
|
+
[@stdlib/ndarray/base/char2dtype]: https://www.npmjs.com/package/@stdlib/ndarray-base-char2dtype
|
|
232
|
+
|
|
233
|
+
[@stdlib/ndarray/base/clamp-index]: https://www.npmjs.com/package/@stdlib/ndarray-base-clamp-index
|
|
234
|
+
|
|
235
|
+
[@stdlib/ndarray/base/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-base-ctor
|
|
236
|
+
|
|
237
|
+
[@stdlib/ndarray/base/dtype-char]: https://www.npmjs.com/package/@stdlib/ndarray-base-dtype-char
|
|
238
|
+
|
|
239
|
+
[@stdlib/ndarray/base/dtype-desc]: https://www.npmjs.com/package/@stdlib/ndarray-base-dtype-desc
|
|
240
|
+
|
|
241
|
+
[@stdlib/ndarray/base/dtype-enum2str]: https://www.npmjs.com/package/@stdlib/ndarray-base-dtype-enum2str
|
|
242
|
+
|
|
243
|
+
[@stdlib/ndarray/base/dtype-resolve-enum]: https://www.npmjs.com/package/@stdlib/ndarray-base-dtype-resolve-enum
|
|
178
244
|
|
|
179
|
-
[@stdlib/ndarray/base/
|
|
245
|
+
[@stdlib/ndarray/base/dtype-resolve-str]: https://www.npmjs.com/package/@stdlib/ndarray-base-dtype-resolve-str
|
|
180
246
|
|
|
181
|
-
[@stdlib/ndarray/base/
|
|
247
|
+
[@stdlib/ndarray/base/dtype-str2enum]: https://www.npmjs.com/package/@stdlib/ndarray-base-dtype-str2enum
|
|
182
248
|
|
|
183
|
-
[@stdlib/ndarray/base/
|
|
249
|
+
[@stdlib/ndarray/base/dtype2c]: https://www.npmjs.com/package/@stdlib/ndarray-base-dtype2c
|
|
184
250
|
|
|
185
|
-
[@stdlib/ndarray/base/
|
|
251
|
+
[@stdlib/ndarray/base/dtypes2signatures]: https://www.npmjs.com/package/@stdlib/ndarray-base-dtypes2signatures
|
|
186
252
|
|
|
187
|
-
[@stdlib/ndarray/base/
|
|
253
|
+
[@stdlib/ndarray/base/ind]: https://www.npmjs.com/package/@stdlib/ndarray-base-ind
|
|
188
254
|
|
|
189
|
-
[@stdlib/ndarray/base/
|
|
255
|
+
[@stdlib/ndarray/base/ind2sub]: https://www.npmjs.com/package/@stdlib/ndarray-base-ind2sub
|
|
190
256
|
|
|
191
|
-
[@stdlib/ndarray/base/
|
|
257
|
+
[@stdlib/ndarray/base/iteration-order]: https://www.npmjs.com/package/@stdlib/ndarray-base-iteration-order
|
|
192
258
|
|
|
193
|
-
[@stdlib/ndarray/base/
|
|
259
|
+
[@stdlib/ndarray/base/max-view-buffer-index]: https://www.npmjs.com/package/@stdlib/ndarray-base-max-view-buffer-index
|
|
194
260
|
|
|
195
|
-
[@stdlib/ndarray/base/
|
|
261
|
+
[@stdlib/ndarray/base/meta-data-props]: https://www.npmjs.com/package/@stdlib/ndarray-base-meta-data-props
|
|
196
262
|
|
|
197
|
-
[@stdlib/ndarray/base/
|
|
263
|
+
[@stdlib/ndarray/base/min-view-buffer-index]: https://www.npmjs.com/package/@stdlib/ndarray-base-min-view-buffer-index
|
|
198
264
|
|
|
199
|
-
[@stdlib/ndarray/base/
|
|
265
|
+
[@stdlib/ndarray/base/minmax-view-buffer-index]: https://www.npmjs.com/package/@stdlib/ndarray-base-minmax-view-buffer-index
|
|
200
266
|
|
|
201
|
-
[@stdlib/ndarray/base/
|
|
267
|
+
[@stdlib/ndarray/base/nonsingleton-dimensions]: https://www.npmjs.com/package/@stdlib/ndarray-base-nonsingleton-dimensions
|
|
202
268
|
|
|
203
|
-
[@stdlib/ndarray/base/
|
|
269
|
+
[@stdlib/ndarray/base/numel]: https://www.npmjs.com/package/@stdlib/ndarray-base-numel
|
|
204
270
|
|
|
205
|
-
[@stdlib/ndarray/base/
|
|
271
|
+
[@stdlib/ndarray/base/serialize-meta-data]: https://www.npmjs.com/package/@stdlib/ndarray-base-serialize-meta-data
|
|
206
272
|
|
|
207
|
-
[@stdlib/ndarray/base/
|
|
273
|
+
[@stdlib/ndarray/base/shape2strides]: https://www.npmjs.com/package/@stdlib/ndarray-base-shape2strides
|
|
208
274
|
|
|
209
|
-
[@stdlib/ndarray/base/
|
|
275
|
+
[@stdlib/ndarray/base/singleton-dimensions]: https://www.npmjs.com/package/@stdlib/ndarray-base-singleton-dimensions
|
|
210
276
|
|
|
211
|
-
[@stdlib/ndarray/base/strides2offset]: https://
|
|
277
|
+
[@stdlib/ndarray/base/strides2offset]: https://www.npmjs.com/package/@stdlib/ndarray-base-strides2offset
|
|
212
278
|
|
|
213
|
-
[@stdlib/ndarray/base/strides2order]: https://
|
|
279
|
+
[@stdlib/ndarray/base/strides2order]: https://www.npmjs.com/package/@stdlib/ndarray-base-strides2order
|
|
214
280
|
|
|
215
|
-
[@stdlib/ndarray/base/sub2ind]: https://
|
|
281
|
+
[@stdlib/ndarray/base/sub2ind]: https://www.npmjs.com/package/@stdlib/ndarray-base-sub2ind
|
|
216
282
|
|
|
217
|
-
[@stdlib/ndarray/base/to-array]: https://
|
|
283
|
+
[@stdlib/ndarray/base/to-array]: https://www.npmjs.com/package/@stdlib/ndarray-base-to-array
|
|
218
284
|
|
|
219
|
-
[@stdlib/ndarray/base/vind2bind]: https://
|
|
285
|
+
[@stdlib/ndarray/base/vind2bind]: https://www.npmjs.com/package/@stdlib/ndarray-base-vind2bind
|
|
220
286
|
|
|
221
|
-
[@stdlib/ndarray/base/wrap-index]: https://
|
|
287
|
+
[@stdlib/ndarray/base/wrap-index]: https://www.npmjs.com/package/@stdlib/ndarray-base-wrap-index
|
|
222
288
|
|
|
223
289
|
<!-- </toc-links> -->
|
|
224
290
|
|
package/docs/types/index.d.ts
CHANGED
|
@@ -23,20 +23,29 @@
|
|
|
23
23
|
|
|
24
24
|
import assert = require( '@stdlib/ndarray-base-assert' );
|
|
25
25
|
import bind2vind = require( '@stdlib/ndarray-base-bind2vind' );
|
|
26
|
+
import broadcastArray = require( '@stdlib/ndarray-base-broadcast-array' );
|
|
26
27
|
import broadcastShapes = require( '@stdlib/ndarray-base-broadcast-shapes' );
|
|
27
28
|
import buffer = require( '@stdlib/ndarray-base-buffer' );
|
|
28
29
|
import bufferCtors = require( '@stdlib/ndarray-base-buffer-ctors' );
|
|
29
30
|
import bufferDataType = require( '@stdlib/ndarray-base-buffer-dtype' );
|
|
30
31
|
import bufferDataTypeEnum = require( '@stdlib/ndarray-base-buffer-dtype-enum' );
|
|
31
32
|
import bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' );
|
|
33
|
+
import char2dtype = require( '@stdlib/ndarray-base-char2dtype' );
|
|
32
34
|
import clampIndex = require( '@stdlib/ndarray-base-clamp-index' );
|
|
33
35
|
import ndarray = require( '@stdlib/ndarray-base-ctor' );
|
|
34
36
|
import dtypeChar = require( '@stdlib/ndarray-base-dtype-char' );
|
|
37
|
+
import dtypeDesc = require( '@stdlib/ndarray-base-dtype-desc' );
|
|
38
|
+
import dtypeEnum2Str = require( '@stdlib/ndarray-base-dtype-enum2str' );
|
|
39
|
+
import dtypeResolveEnum = require( '@stdlib/ndarray-base-dtype-resolve-enum' );
|
|
40
|
+
import dtypeResolveStr = require( '@stdlib/ndarray-base-dtype-resolve-str' );
|
|
41
|
+
import dtypeStr2Enum = require( '@stdlib/ndarray-base-dtype-str2enum' );
|
|
42
|
+
import dtype2c = require( '@stdlib/ndarray-base-dtype2c' );
|
|
35
43
|
import dtypes2signatures = require( '@stdlib/ndarray-base-dtypes2signatures' );
|
|
36
44
|
import ind = require( '@stdlib/ndarray-base-ind' );
|
|
37
45
|
import ind2sub = require( '@stdlib/ndarray-base-ind2sub' );
|
|
38
46
|
import iterationOrder = require( '@stdlib/ndarray-base-iteration-order' );
|
|
39
47
|
import maxViewBufferIndex = require( '@stdlib/ndarray-base-max-view-buffer-index' );
|
|
48
|
+
import metaDataProps = require( '@stdlib/ndarray-base-meta-data-props' );
|
|
40
49
|
import minViewBufferIndex = require( '@stdlib/ndarray-base-min-view-buffer-index' );
|
|
41
50
|
import minmaxViewBufferIndex = require( '@stdlib/ndarray-base-minmax-view-buffer-index' );
|
|
42
51
|
import nonsingletonDimensions = require( '@stdlib/ndarray-base-nonsingleton-dimensions' );
|
|
@@ -84,6 +93,57 @@ interface Namespace {
|
|
|
84
93
|
*/
|
|
85
94
|
bind2vind: typeof bind2vind;
|
|
86
95
|
|
|
96
|
+
/**
|
|
97
|
+
* Broadcasts an ndarray to a specified shape.
|
|
98
|
+
*
|
|
99
|
+
* ## Notes
|
|
100
|
+
*
|
|
101
|
+
* - The function throws an error if a provided ndarray is incompatible with a provided shape.
|
|
102
|
+
* - The returned array is a view on the input array data buffer. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the view may affect multiple elements. If you need to write to the returned array, copy the array before performing operations which may mutate elements.
|
|
103
|
+
* - The returned array is a "base" ndarray, and, thus, the returned array does not perform bounds checking or afford any of the guarantees of the non-base ndarray constructor. The primary intent of this function is to broadcast an ndarray-like object within internal implementations and to do so with minimal overhead.
|
|
104
|
+
* - The function always returns a new ndarray instance even if the input ndarray shape and the desired shape are the same.
|
|
105
|
+
*
|
|
106
|
+
* @param arr - input array
|
|
107
|
+
* @param shape - desired shape
|
|
108
|
+
* @throws input array cannot have more dimensions than the desired shape
|
|
109
|
+
* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape
|
|
110
|
+
* @returns broadcasted array
|
|
111
|
+
*
|
|
112
|
+
* @example
|
|
113
|
+
* var array = require( `@stdlib/ndarray/array` );
|
|
114
|
+
*
|
|
115
|
+
* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
|
|
116
|
+
* // returns <ndarray>
|
|
117
|
+
*
|
|
118
|
+
* var shx = x.shape;
|
|
119
|
+
* // returns [ 2, 2 ]
|
|
120
|
+
*
|
|
121
|
+
* var y = ns.broadcastArray( x, [ 3, 2, 2 ] );
|
|
122
|
+
* // returns <ndarray>
|
|
123
|
+
*
|
|
124
|
+
* var shy = y.shape;
|
|
125
|
+
* // returns [ 3, 2, 2 ]
|
|
126
|
+
*
|
|
127
|
+
* var v = y.get( 0, 0, 0 );
|
|
128
|
+
* // returns 1
|
|
129
|
+
*
|
|
130
|
+
* v = y.get( 0, 0, 1 );
|
|
131
|
+
* // returns 2
|
|
132
|
+
*
|
|
133
|
+
* v = y.get( 1, 0, 0 );
|
|
134
|
+
* // returns 1
|
|
135
|
+
*
|
|
136
|
+
* v = y.get( 1, 1, 0 );
|
|
137
|
+
* // returns 3
|
|
138
|
+
*
|
|
139
|
+
* v = y.get( 2, 0, 0 );
|
|
140
|
+
* // returns 1
|
|
141
|
+
*
|
|
142
|
+
* v = y.get( 2, 1, 1 );
|
|
143
|
+
* // returns 4
|
|
144
|
+
*/
|
|
145
|
+
broadcastArray: typeof broadcastArray;
|
|
146
|
+
|
|
87
147
|
/**
|
|
88
148
|
* Broadcasts array shapes to a single shape.
|
|
89
149
|
*
|
|
@@ -308,6 +368,17 @@ interface Namespace {
|
|
|
308
368
|
*/
|
|
309
369
|
bytesPerElement: typeof bytesPerElement;
|
|
310
370
|
|
|
371
|
+
/**
|
|
372
|
+
* Returns an object mapping single letter character abbreviations to data type strings.
|
|
373
|
+
*
|
|
374
|
+
* @returns object mapping single letter character abbreviations to data type strings
|
|
375
|
+
*
|
|
376
|
+
* @example
|
|
377
|
+
* var out = ns.char2dtype();
|
|
378
|
+
* // returns {...}
|
|
379
|
+
*/
|
|
380
|
+
char2dtype: typeof char2dtype;
|
|
381
|
+
|
|
311
382
|
/**
|
|
312
383
|
* Restricts an index to the interval `[0,max]`.
|
|
313
384
|
*
|
|
@@ -362,19 +433,104 @@ interface Namespace {
|
|
|
362
433
|
ndarray: typeof ndarray;
|
|
363
434
|
|
|
364
435
|
/**
|
|
365
|
-
* Returns
|
|
436
|
+
* Returns an object mapping data type strings to single letter character abbreviations.
|
|
437
|
+
*
|
|
438
|
+
* @returns object mapping data type strings to single letter character abbreviations
|
|
439
|
+
*
|
|
440
|
+
* @example
|
|
441
|
+
* var obj = ns.dtypeChar();
|
|
442
|
+
* // returns {...}
|
|
443
|
+
*/
|
|
444
|
+
dtypeChar: typeof dtypeChar;
|
|
445
|
+
|
|
446
|
+
/**
|
|
447
|
+
* Returns an object mapping data type strings to descriptions.
|
|
448
|
+
*
|
|
449
|
+
* @returns object mapping data type strings to descriptions
|
|
450
|
+
*
|
|
451
|
+
* @example
|
|
452
|
+
* var obj = ns.dtypeDesc();
|
|
453
|
+
* // returns {...}
|
|
454
|
+
*/
|
|
455
|
+
dtypeDesc: typeof dtypeDesc;
|
|
456
|
+
|
|
457
|
+
/**
|
|
458
|
+
* Returns the data type string associated with an ndarray data type enumeration constant.
|
|
459
|
+
*
|
|
460
|
+
* @param dtype - data type enumeration constant
|
|
461
|
+
* @returns data type string
|
|
462
|
+
*
|
|
463
|
+
* @example
|
|
464
|
+
* var str2enum = require( `@stdlib/ndarray/base/dtype-str2enum` );
|
|
465
|
+
*
|
|
466
|
+
* var v = str2enum( 'float64' );
|
|
467
|
+
* // returns <number>
|
|
468
|
+
*
|
|
469
|
+
* var dt = ns.dtypeEnum2Str( v );
|
|
470
|
+
* // returns 'float64'
|
|
471
|
+
*/
|
|
472
|
+
dtypeEnum2Str: typeof dtypeEnum2Str;
|
|
473
|
+
|
|
474
|
+
/**
|
|
475
|
+
* Returns the enumeration constant associated with an ndarray data type value.
|
|
476
|
+
*
|
|
477
|
+
* ## Notes
|
|
478
|
+
*
|
|
479
|
+
* - Downstream consumers of this function should **not** rely on specific integer values (e.g., `INT8 == 0`). Instead, the function should be used in an opaque manner.
|
|
480
|
+
*
|
|
481
|
+
* @param dtype - data type value
|
|
482
|
+
* @returns enumeration constant
|
|
483
|
+
*
|
|
484
|
+
* @example
|
|
485
|
+
* var v = ns.dtypeResolveEnum( 'float64' );
|
|
486
|
+
* // returns <number>
|
|
487
|
+
*/
|
|
488
|
+
dtypeResolveEnum: typeof dtypeResolveEnum;
|
|
489
|
+
|
|
490
|
+
/**
|
|
491
|
+
* Returns the data type string associated with an ndarray data type value.
|
|
492
|
+
*
|
|
493
|
+
* @param dtype - data type value
|
|
494
|
+
* @returns data type string
|
|
495
|
+
*
|
|
496
|
+
* @example
|
|
497
|
+
* var str2enum = require( `@stdlib/ndarray/base/dtype-str2enum` );
|
|
498
|
+
*
|
|
499
|
+
* var v = ns.dtypeResolveStr( str2enum( 'float64' ) );
|
|
500
|
+
* // returns 'float64'
|
|
501
|
+
*/
|
|
502
|
+
dtypeResolveStr: typeof dtypeResolveStr;
|
|
503
|
+
|
|
504
|
+
/**
|
|
505
|
+
* Returns the enumeration constant associated with a ndarray data type string.
|
|
506
|
+
*
|
|
507
|
+
* ## Notes
|
|
508
|
+
*
|
|
509
|
+
* - Downstream consumers of this function should **not** rely on specific integer values (e.g., `INT8 == 0`). Instead, the function should be used in an opaque manner.
|
|
510
|
+
*
|
|
511
|
+
* @param dtype - data type string
|
|
512
|
+
* @returns enumeration constant
|
|
513
|
+
*
|
|
514
|
+
* @example
|
|
515
|
+
* var v = ns.dtypeStr2Enum( 'float64' );
|
|
516
|
+
* // returns <number>
|
|
517
|
+
*/
|
|
518
|
+
dtypeStr2Enum: typeof dtypeStr2Enum;
|
|
519
|
+
|
|
520
|
+
/**
|
|
521
|
+
* Returns the C data type associated with a provided data type string.
|
|
366
522
|
*
|
|
367
523
|
* @param dtype - data type
|
|
368
|
-
* @returns
|
|
524
|
+
* @returns C data type (or null)
|
|
369
525
|
*
|
|
370
526
|
* @example
|
|
371
|
-
* var
|
|
372
|
-
* // returns '
|
|
527
|
+
* var out = ns.dtype2c( 'float64' );
|
|
528
|
+
* // returns 'double'
|
|
373
529
|
*
|
|
374
|
-
*
|
|
375
|
-
* // returns
|
|
530
|
+
* out = ns.dtype2c( 'generic' );
|
|
531
|
+
* // returns null
|
|
376
532
|
*/
|
|
377
|
-
|
|
533
|
+
dtype2c: typeof dtype2c;
|
|
378
534
|
|
|
379
535
|
/**
|
|
380
536
|
* Transforms a list of array argument data types into a list of signatures.
|
|
@@ -382,7 +538,7 @@ interface Namespace {
|
|
|
382
538
|
* @param dtypes - list of array argument data types
|
|
383
539
|
* @param nin - number of input array arguments
|
|
384
540
|
* @param nout - number of output array arguments
|
|
385
|
-
* @throws first argument must be an array-like object
|
|
541
|
+
* @throws first argument must be an array-like object
|
|
386
542
|
* @throws second argument must be a nonnegative integer
|
|
387
543
|
* @throws third argument must be a nonnegative integer
|
|
388
544
|
* @throws first argument must have at least one element
|
|
@@ -611,6 +767,40 @@ interface Namespace {
|
|
|
611
767
|
*/
|
|
612
768
|
maxViewBufferIndex: typeof maxViewBufferIndex;
|
|
613
769
|
|
|
770
|
+
/**
|
|
771
|
+
* Defines non-enumerable read-only properties which expose ndarray function meta data.
|
|
772
|
+
*
|
|
773
|
+
* @param meta - function meta data
|
|
774
|
+
* @param meta.nargs - total number of arguments
|
|
775
|
+
* @param meta.nin - total number of input arrays
|
|
776
|
+
* @param meta.nout - total number of output arrays
|
|
777
|
+
* @param dtypes - list of ndarray data types
|
|
778
|
+
* @param obj - object on which to define properties
|
|
779
|
+
* @returns object on which properties were defined
|
|
780
|
+
*
|
|
781
|
+
* @example
|
|
782
|
+
* // Define ndarray function meta data:
|
|
783
|
+
* var meta = {
|
|
784
|
+
* 'nargs': 2,
|
|
785
|
+
* 'nin': 1,
|
|
786
|
+
* 'nout': 1
|
|
787
|
+
* };
|
|
788
|
+
*
|
|
789
|
+
* // Define the list of ndarray data types:
|
|
790
|
+
* var dtypes = [
|
|
791
|
+
* 'float64', 'float64',
|
|
792
|
+
* 'float32', 'float32',
|
|
793
|
+
* 'generic', 'generic'
|
|
794
|
+
* ];
|
|
795
|
+
*
|
|
796
|
+
* // Define an object/function on which to set the properties:
|
|
797
|
+
* var obj = {};
|
|
798
|
+
*
|
|
799
|
+
* // Set the properties:
|
|
800
|
+
* ns.metaDataProps( meta, dtypes, obj );
|
|
801
|
+
*/
|
|
802
|
+
metaDataProps: typeof metaDataProps;
|
|
803
|
+
|
|
614
804
|
/**
|
|
615
805
|
* Computes the minimum linear index in an underlying data buffer accessible to an array view.
|
|
616
806
|
*
|
package/lib/index.js
CHANGED
|
@@ -54,6 +54,15 @@ setReadOnly( ns, 'assert', require( '@stdlib/ndarray-base-assert' ) );
|
|
|
54
54
|
*/
|
|
55
55
|
setReadOnly( ns, 'bind2vind', require( '@stdlib/ndarray-base-bind2vind' ) );
|
|
56
56
|
|
|
57
|
+
/**
|
|
58
|
+
* @name broadcastArray
|
|
59
|
+
* @memberof ns
|
|
60
|
+
* @readonly
|
|
61
|
+
* @type {Function}
|
|
62
|
+
* @see {@link module:@stdlib/ndarray/base/broadcast-array}
|
|
63
|
+
*/
|
|
64
|
+
setReadOnly( ns, 'broadcastArray', require( '@stdlib/ndarray-base-broadcast-array' ) );
|
|
65
|
+
|
|
57
66
|
/**
|
|
58
67
|
* @name broadcastShapes
|
|
59
68
|
* @memberof ns
|
|
@@ -108,6 +117,15 @@ setReadOnly( ns, 'bufferDataTypeEnum', require( '@stdlib/ndarray-base-buffer-dty
|
|
|
108
117
|
*/
|
|
109
118
|
setReadOnly( ns, 'bytesPerElement', require( '@stdlib/ndarray-base-bytes-per-element' ) );
|
|
110
119
|
|
|
120
|
+
/**
|
|
121
|
+
* @name char2dtype
|
|
122
|
+
* @memberof ns
|
|
123
|
+
* @readonly
|
|
124
|
+
* @type {Function}
|
|
125
|
+
* @see {@link module:@stdlib/ndarray/base/char2dtype}
|
|
126
|
+
*/
|
|
127
|
+
setReadOnly( ns, 'char2dtype', require( '@stdlib/ndarray-base-char2dtype' ) );
|
|
128
|
+
|
|
111
129
|
/**
|
|
112
130
|
* @name clampIndex
|
|
113
131
|
* @memberof ns
|
|
@@ -135,6 +153,60 @@ setReadOnly( ns, 'ndarray', require( '@stdlib/ndarray-base-ctor' ) );
|
|
|
135
153
|
*/
|
|
136
154
|
setReadOnly( ns, 'dtypeChar', require( '@stdlib/ndarray-base-dtype-char' ) );
|
|
137
155
|
|
|
156
|
+
/**
|
|
157
|
+
* @name dtypeDesc
|
|
158
|
+
* @memberof ns
|
|
159
|
+
* @readonly
|
|
160
|
+
* @type {Function}
|
|
161
|
+
* @see {@link module:@stdlib/ndarray/base/dtype-desc}
|
|
162
|
+
*/
|
|
163
|
+
setReadOnly( ns, 'dtypeDesc', require( '@stdlib/ndarray-base-dtype-desc' ) );
|
|
164
|
+
|
|
165
|
+
/**
|
|
166
|
+
* @name dtypeEnum2Str
|
|
167
|
+
* @memberof ns
|
|
168
|
+
* @readonly
|
|
169
|
+
* @type {Function}
|
|
170
|
+
* @see {@link module:@stdlib/ndarray/base/dtype-enum2str}
|
|
171
|
+
*/
|
|
172
|
+
setReadOnly( ns, 'dtypeEnum2Str', require( '@stdlib/ndarray-base-dtype-enum2str' ) );
|
|
173
|
+
|
|
174
|
+
/**
|
|
175
|
+
* @name dtypeResolveEnum
|
|
176
|
+
* @memberof ns
|
|
177
|
+
* @readonly
|
|
178
|
+
* @type {Function}
|
|
179
|
+
* @see {@link module:@stdlib/ndarray/base/dtype-resolve-enum}
|
|
180
|
+
*/
|
|
181
|
+
setReadOnly( ns, 'dtypeResolveEnum', require( '@stdlib/ndarray-base-dtype-resolve-enum' ) );
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* @name dtypeResolveStr
|
|
185
|
+
* @memberof ns
|
|
186
|
+
* @readonly
|
|
187
|
+
* @type {Function}
|
|
188
|
+
* @see {@link module:@stdlib/ndarray/base/dtype-resolve-str}
|
|
189
|
+
*/
|
|
190
|
+
setReadOnly( ns, 'dtypeResolveStr', require( '@stdlib/ndarray-base-dtype-resolve-str' ) );
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
* @name dtypeStr2Enum
|
|
194
|
+
* @memberof ns
|
|
195
|
+
* @readonly
|
|
196
|
+
* @type {Function}
|
|
197
|
+
* @see {@link module:@stdlib/ndarray/base/dtype-str2enum}
|
|
198
|
+
*/
|
|
199
|
+
setReadOnly( ns, 'dtypeStr2Enum', require( '@stdlib/ndarray-base-dtype-str2enum' ) );
|
|
200
|
+
|
|
201
|
+
/**
|
|
202
|
+
* @name dtype2c
|
|
203
|
+
* @memberof ns
|
|
204
|
+
* @readonly
|
|
205
|
+
* @type {Function}
|
|
206
|
+
* @see {@link module:@stdlib/ndarray/base/dtype2c}
|
|
207
|
+
*/
|
|
208
|
+
setReadOnly( ns, 'dtype2c', require( '@stdlib/ndarray-base-dtype2c' ) );
|
|
209
|
+
|
|
138
210
|
/**
|
|
139
211
|
* @name dtypes2signatures
|
|
140
212
|
* @memberof ns
|
|
@@ -144,6 +216,24 @@ setReadOnly( ns, 'dtypeChar', require( '@stdlib/ndarray-base-dtype-char' ) );
|
|
|
144
216
|
*/
|
|
145
217
|
setReadOnly( ns, 'dtypes2signatures', require( '@stdlib/ndarray-base-dtypes2signatures' ) );
|
|
146
218
|
|
|
219
|
+
/**
|
|
220
|
+
* @name expandDimensions
|
|
221
|
+
* @memberof ns
|
|
222
|
+
* @readonly
|
|
223
|
+
* @type {Function}
|
|
224
|
+
* @see {@link module:@stdlib/ndarray/base/expand-dimensions}
|
|
225
|
+
*/
|
|
226
|
+
setReadOnly( ns, 'expandDimensions', require( '@stdlib/ndarray-base-expand-dimensions' ) );
|
|
227
|
+
|
|
228
|
+
/**
|
|
229
|
+
* @name scalar2ndarray
|
|
230
|
+
* @memberof ns
|
|
231
|
+
* @readonly
|
|
232
|
+
* @type {Function}
|
|
233
|
+
* @see {@link module:@stdlib/ndarray/base/from-scalar}
|
|
234
|
+
*/
|
|
235
|
+
setReadOnly( ns, 'scalar2ndarray', require( '@stdlib/ndarray-base-from-scalar' ) );
|
|
236
|
+
|
|
147
237
|
/**
|
|
148
238
|
* @name ind
|
|
149
239
|
* @memberof ns
|
|
@@ -180,6 +270,24 @@ setReadOnly( ns, 'iterationOrder', require( '@stdlib/ndarray-base-iteration-orde
|
|
|
180
270
|
*/
|
|
181
271
|
setReadOnly( ns, 'maxViewBufferIndex', require( '@stdlib/ndarray-base-max-view-buffer-index' ) );
|
|
182
272
|
|
|
273
|
+
/**
|
|
274
|
+
* @name maybeBroadcastArray
|
|
275
|
+
* @memberof ns
|
|
276
|
+
* @readonly
|
|
277
|
+
* @type {Function}
|
|
278
|
+
* @see {@link module:@stdlib/ndarray/base/maybe-broadcast-array}
|
|
279
|
+
*/
|
|
280
|
+
setReadOnly( ns, 'maybeBroadcastArray', require( '@stdlib/ndarray-base-maybe-broadcast-array' ) );
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* @name metaDataProps
|
|
284
|
+
* @memberof ns
|
|
285
|
+
* @readonly
|
|
286
|
+
* @type {Function}
|
|
287
|
+
* @see {@link module:@stdlib/ndarray/base/meta-data-props}
|
|
288
|
+
*/
|
|
289
|
+
setReadOnly( ns, 'metaDataProps', require( '@stdlib/ndarray-base-meta-data-props' ) );
|
|
290
|
+
|
|
183
291
|
/**
|
|
184
292
|
* @name minViewBufferIndex
|
|
185
293
|
* @memberof ns
|
|
@@ -198,6 +306,15 @@ setReadOnly( ns, 'minViewBufferIndex', require( '@stdlib/ndarray-base-min-view-b
|
|
|
198
306
|
*/
|
|
199
307
|
setReadOnly( ns, 'minmaxViewBufferIndex', require( '@stdlib/ndarray-base-minmax-view-buffer-index' ) );
|
|
200
308
|
|
|
309
|
+
/**
|
|
310
|
+
* @name ndarraylike2object
|
|
311
|
+
* @memberof ns
|
|
312
|
+
* @readonly
|
|
313
|
+
* @type {Function}
|
|
314
|
+
* @see {@link module:@stdlib/ndarray/base/ndarraylike2object}
|
|
315
|
+
*/
|
|
316
|
+
setReadOnly( ns, 'ndarraylike2object', require( '@stdlib/ndarray-base-ndarraylike2object' ) );
|
|
317
|
+
|
|
201
318
|
/**
|
|
202
319
|
* @name nonsingletonDimensions
|
|
203
320
|
* @memberof ns
|
|
@@ -216,6 +333,24 @@ setReadOnly( ns, 'nonsingletonDimensions', require( '@stdlib/ndarray-base-nonsin
|
|
|
216
333
|
*/
|
|
217
334
|
setReadOnly( ns, 'numel', require( '@stdlib/ndarray-base-numel' ) );
|
|
218
335
|
|
|
336
|
+
/**
|
|
337
|
+
* @name prependSingletonDimensions
|
|
338
|
+
* @memberof ns
|
|
339
|
+
* @readonly
|
|
340
|
+
* @type {Function}
|
|
341
|
+
* @see {@link module:@stdlib/ndarray/base/prepend-singleton-dimensions}
|
|
342
|
+
*/
|
|
343
|
+
setReadOnly( ns, 'prependSingletonDimensions', require( '@stdlib/ndarray-base-prepend-singleton-dimensions' ) );
|
|
344
|
+
|
|
345
|
+
/**
|
|
346
|
+
* @name removeSingletonDimensions
|
|
347
|
+
* @memberof ns
|
|
348
|
+
* @readonly
|
|
349
|
+
* @type {Function}
|
|
350
|
+
* @see {@link module:@stdlib/ndarray/base/remove-singleton-dimensions}
|
|
351
|
+
*/
|
|
352
|
+
setReadOnly( ns, 'removeSingletonDimensions', require( '@stdlib/ndarray-base-remove-singleton-dimensions' ) );
|
|
353
|
+
|
|
219
354
|
/**
|
|
220
355
|
* @name serializeMetaData
|
|
221
356
|
* @memberof ns
|
|
@@ -279,6 +414,15 @@ setReadOnly( ns, 'sub2ind', require( '@stdlib/ndarray-base-sub2ind' ) );
|
|
|
279
414
|
*/
|
|
280
415
|
setReadOnly( ns, 'ndarray2array', require( '@stdlib/ndarray-base-to-array' ) );
|
|
281
416
|
|
|
417
|
+
/**
|
|
418
|
+
* @name transpose
|
|
419
|
+
* @memberof ns
|
|
420
|
+
* @readonly
|
|
421
|
+
* @type {Function}
|
|
422
|
+
* @see {@link module:@stdlib/ndarray/base/transpose}
|
|
423
|
+
*/
|
|
424
|
+
setReadOnly( ns, 'transpose', require( '@stdlib/ndarray-base-transpose' ) );
|
|
425
|
+
|
|
282
426
|
/**
|
|
283
427
|
* @name vind2bind
|
|
284
428
|
* @memberof ns
|
|
@@ -297,6 +441,24 @@ setReadOnly( ns, 'vind2bind', require( '@stdlib/ndarray-base-vind2bind' ) );
|
|
|
297
441
|
*/
|
|
298
442
|
setReadOnly( ns, 'wrapIndex', require( '@stdlib/ndarray-base-wrap-index' ) );
|
|
299
443
|
|
|
444
|
+
/**
|
|
445
|
+
* @name zeros
|
|
446
|
+
* @memberof ns
|
|
447
|
+
* @readonly
|
|
448
|
+
* @type {Function}
|
|
449
|
+
* @see {@link module:@stdlib/ndarray/base/zeros}
|
|
450
|
+
*/
|
|
451
|
+
setReadOnly( ns, 'zeros', require( '@stdlib/ndarray-base-zeros' ) );
|
|
452
|
+
|
|
453
|
+
/**
|
|
454
|
+
* @name zerosLike
|
|
455
|
+
* @memberof ns
|
|
456
|
+
* @readonly
|
|
457
|
+
* @type {Function}
|
|
458
|
+
* @see {@link module:@stdlib/ndarray/base/zeros-like}
|
|
459
|
+
*/
|
|
460
|
+
setReadOnly( ns, 'zerosLike', require( '@stdlib/ndarray-base-zeros-like' ) );
|
|
461
|
+
|
|
300
462
|
|
|
301
463
|
// EXPORTS //
|
|
302
464
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stdlib/ndarray-base",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.7",
|
|
4
4
|
"description": "Base ndarray.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": {
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
],
|
|
16
16
|
"main": "lib/index.js",
|
|
17
17
|
"directories": {
|
|
18
|
+
"doc": "./docs",
|
|
18
19
|
"example": "./examples",
|
|
19
20
|
"lib": "./lib",
|
|
20
21
|
"test": "./test"
|
|
@@ -37,24 +38,39 @@
|
|
|
37
38
|
"dependencies": {
|
|
38
39
|
"@stdlib/ndarray-base-assert": "^0.0.x",
|
|
39
40
|
"@stdlib/ndarray-base-bind2vind": "^0.0.x",
|
|
41
|
+
"@stdlib/ndarray-base-broadcast-array": "^0.0.x",
|
|
40
42
|
"@stdlib/ndarray-base-broadcast-shapes": "^0.0.x",
|
|
41
43
|
"@stdlib/ndarray-base-buffer": "^0.0.x",
|
|
42
44
|
"@stdlib/ndarray-base-buffer-ctors": "^0.0.x",
|
|
43
45
|
"@stdlib/ndarray-base-buffer-dtype": "^0.0.x",
|
|
44
46
|
"@stdlib/ndarray-base-buffer-dtype-enum": "^0.0.x",
|
|
45
47
|
"@stdlib/ndarray-base-bytes-per-element": "^0.0.x",
|
|
48
|
+
"@stdlib/ndarray-base-char2dtype": "^0.0.x",
|
|
46
49
|
"@stdlib/ndarray-base-clamp-index": "^0.0.x",
|
|
47
50
|
"@stdlib/ndarray-base-ctor": "^0.0.x",
|
|
48
51
|
"@stdlib/ndarray-base-dtype-char": "^0.0.x",
|
|
52
|
+
"@stdlib/ndarray-base-dtype-desc": "^0.0.x",
|
|
53
|
+
"@stdlib/ndarray-base-dtype-enum2str": "^0.0.x",
|
|
54
|
+
"@stdlib/ndarray-base-dtype-resolve-enum": "^0.0.x",
|
|
55
|
+
"@stdlib/ndarray-base-dtype-resolve-str": "^0.0.x",
|
|
56
|
+
"@stdlib/ndarray-base-dtype-str2enum": "^0.0.x",
|
|
57
|
+
"@stdlib/ndarray-base-dtype2c": "^0.0.x",
|
|
49
58
|
"@stdlib/ndarray-base-dtypes2signatures": "^0.0.x",
|
|
59
|
+
"@stdlib/ndarray-base-expand-dimensions": "^0.0.x",
|
|
60
|
+
"@stdlib/ndarray-base-from-scalar": "^0.0.x",
|
|
50
61
|
"@stdlib/ndarray-base-ind": "^0.0.x",
|
|
51
62
|
"@stdlib/ndarray-base-ind2sub": "^0.0.x",
|
|
52
63
|
"@stdlib/ndarray-base-iteration-order": "^0.0.x",
|
|
53
64
|
"@stdlib/ndarray-base-max-view-buffer-index": "^0.0.x",
|
|
65
|
+
"@stdlib/ndarray-base-maybe-broadcast-array": "^0.0.x",
|
|
66
|
+
"@stdlib/ndarray-base-meta-data-props": "^0.0.x",
|
|
54
67
|
"@stdlib/ndarray-base-min-view-buffer-index": "^0.0.x",
|
|
55
68
|
"@stdlib/ndarray-base-minmax-view-buffer-index": "^0.0.x",
|
|
69
|
+
"@stdlib/ndarray-base-ndarraylike2object": "^0.0.x",
|
|
56
70
|
"@stdlib/ndarray-base-nonsingleton-dimensions": "^0.0.x",
|
|
57
71
|
"@stdlib/ndarray-base-numel": "^0.0.x",
|
|
72
|
+
"@stdlib/ndarray-base-prepend-singleton-dimensions": "^0.0.x",
|
|
73
|
+
"@stdlib/ndarray-base-remove-singleton-dimensions": "^0.0.x",
|
|
58
74
|
"@stdlib/ndarray-base-serialize-meta-data": "^0.0.x",
|
|
59
75
|
"@stdlib/ndarray-base-shape2strides": "^0.0.x",
|
|
60
76
|
"@stdlib/ndarray-base-singleton-dimensions": "^0.0.x",
|
|
@@ -62,16 +78,21 @@
|
|
|
62
78
|
"@stdlib/ndarray-base-strides2order": "^0.0.x",
|
|
63
79
|
"@stdlib/ndarray-base-sub2ind": "^0.0.x",
|
|
64
80
|
"@stdlib/ndarray-base-to-array": "^0.0.x",
|
|
81
|
+
"@stdlib/ndarray-base-transpose": "^0.0.x",
|
|
65
82
|
"@stdlib/ndarray-base-vind2bind": "^0.0.x",
|
|
66
83
|
"@stdlib/ndarray-base-wrap-index": "^0.0.x",
|
|
84
|
+
"@stdlib/ndarray-base-zeros": "^0.0.x",
|
|
85
|
+
"@stdlib/ndarray-base-zeros-like": "^0.0.x",
|
|
67
86
|
"@stdlib/utils-define-read-only-property": "^0.0.x"
|
|
68
87
|
},
|
|
69
88
|
"devDependencies": {
|
|
89
|
+
"@stdlib/array-base-arraylike2object": "^0.0.x",
|
|
70
90
|
"@stdlib/array-buffer": "^0.0.x",
|
|
71
91
|
"@stdlib/array-complex128": "^0.0.x",
|
|
72
92
|
"@stdlib/array-complex64": "^0.0.x",
|
|
73
93
|
"@stdlib/array-dataview": "^0.0.x",
|
|
74
94
|
"@stdlib/array-filled": "^0.0.x",
|
|
95
|
+
"@stdlib/array-filled-by": "^0.0.x",
|
|
75
96
|
"@stdlib/array-float32": "^0.0.x",
|
|
76
97
|
"@stdlib/array-float64": "^0.0.x",
|
|
77
98
|
"@stdlib/array-int16": "^0.0.x",
|
|
@@ -104,6 +125,7 @@
|
|
|
104
125
|
"@stdlib/assert-is-int8array": "^0.0.x",
|
|
105
126
|
"@stdlib/assert-is-integer": "^0.0.x",
|
|
106
127
|
"@stdlib/assert-is-little-endian": "^0.0.x",
|
|
128
|
+
"@stdlib/assert-is-ndarray-like": "^0.0.x",
|
|
107
129
|
"@stdlib/assert-is-nonnegative-integer": "^0.0.x",
|
|
108
130
|
"@stdlib/assert-is-nonnegative-integer-array": "^0.0.x",
|
|
109
131
|
"@stdlib/assert-is-number": "^0.0.x",
|
|
@@ -117,14 +139,15 @@
|
|
|
117
139
|
"@stdlib/assert-is-uint8clampedarray": "^0.0.x",
|
|
118
140
|
"@stdlib/bench": "^0.0.x",
|
|
119
141
|
"@stdlib/bigint-ctor": "^0.0.x",
|
|
120
|
-
"@stdlib/blas-ext-base-gfill-by": "^0.0.x",
|
|
121
142
|
"@stdlib/buffer-alloc-unsafe": "^0.0.x",
|
|
122
143
|
"@stdlib/buffer-ctor": "^0.0.x",
|
|
123
144
|
"@stdlib/buffer-from-array": "^0.0.x",
|
|
124
145
|
"@stdlib/complex-float32": "^0.0.x",
|
|
125
146
|
"@stdlib/complex-float64": "^0.0.x",
|
|
126
147
|
"@stdlib/complex-imag": "^0.0.x",
|
|
148
|
+
"@stdlib/complex-imagf": "^0.0.x",
|
|
127
149
|
"@stdlib/complex-real": "^0.0.x",
|
|
150
|
+
"@stdlib/complex-realf": "^0.0.x",
|
|
128
151
|
"@stdlib/math-base-assert-is-nan": "^0.0.x",
|
|
129
152
|
"@stdlib/math-base-special-abs": "^0.0.x",
|
|
130
153
|
"@stdlib/math-base-special-cbrt": "^0.0.x",
|
|
@@ -145,6 +168,7 @@
|
|
|
145
168
|
"@stdlib/ndarray-base-assert-is-data-type": "^0.0.x",
|
|
146
169
|
"@stdlib/ndarray-base-assert-is-index-mode": "^0.0.x",
|
|
147
170
|
"@stdlib/ndarray-base-assert-is-order": "^0.0.x",
|
|
171
|
+
"@stdlib/ndarray-base-assert-is-read-only": "^0.0.x",
|
|
148
172
|
"@stdlib/ndarray-base-assert-is-row-major": "^0.0.x",
|
|
149
173
|
"@stdlib/ndarray-base-assert-is-row-major-contiguous": "^0.0.x",
|
|
150
174
|
"@stdlib/ndarray-base-assert-is-safe-data-type-cast": "^0.0.x",
|
|
@@ -162,12 +186,17 @@
|
|
|
162
186
|
"@stdlib/number-float64-base-to-int64-bytes": "^0.0.x",
|
|
163
187
|
"@stdlib/random-base-discrete-uniform": "^0.0.x",
|
|
164
188
|
"@stdlib/random-base-randu": "^0.0.x",
|
|
189
|
+
"@stdlib/strided-base-reinterpret-complex128": "^0.0.x",
|
|
190
|
+
"@stdlib/strided-base-reinterpret-complex64": "^0.0.x",
|
|
191
|
+
"@stdlib/strided-dtypes": "^0.0.x",
|
|
165
192
|
"@stdlib/string-left-pad": "^0.0.x",
|
|
166
193
|
"@stdlib/string-replace": "^0.0.x",
|
|
194
|
+
"@stdlib/string-right-pad": "^0.0.x",
|
|
167
195
|
"@stdlib/utils-constructor-name": "^0.0.x",
|
|
168
196
|
"@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.x",
|
|
169
197
|
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x",
|
|
170
198
|
"@stdlib/utils-keys": "^0.0.x",
|
|
199
|
+
"@stdlib/utils-object-inverse": "^0.0.x",
|
|
171
200
|
"@stdlib/utils-try-require": "^0.0.x",
|
|
172
201
|
"proxyquire": "^2.0.0",
|
|
173
202
|
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
|