You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[`eee0e09`](https://github.com/stdlib-js/stdlib/commit/eee0e097b23ead16e0933da53a9a1c40dc5b713e) - **docs:** remove extra empty line [(#9756)](https://github.com/stdlib-js/stdlib/pull/9756)_(by stdlib-bot)_
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -110,7 +110,7 @@ In addition, the namespace contains the following multidimensional array utility
110
110
- <spanclass="signature">[`broadcastArray( x, shape )`][@stdlib/ndarray/broadcast-array]</span><spanclass="delimiter">: </span><spanclass="description">broadcast an ndarray to a specified shape.</span>
111
111
- <spanclass="signature">[`broadcastArrays( ...arrays )`][@stdlib/ndarray/broadcast-arrays]</span><spanclass="delimiter">: </span><spanclass="description">broadcast ndarrays to a common shape.</span>
112
112
- <spanclass="signature">[`castingModes()`][@stdlib/ndarray/casting-modes]</span><spanclass="delimiter">: </span><spanclass="description">list of ndarray casting modes.</span>
113
-
- <spanclass="signature">[`concat( arrays[, dim] )`][@stdlib/ndarray/concat]</span><spanclass="delimiter">: </span><spanclass="description">concatenate a list of ndarrays along a specified ndarray dimension.</span>
113
+
- <spanclass="signature">[`concat( arrays[, options] )`][@stdlib/ndarray/concat]</span><spanclass="delimiter">: </span><spanclass="description">concatenate a list of ndarrays along a specified ndarray dimension.</span>
114
114
- <spanclass="signature">[`copy( x[, options] )`][@stdlib/ndarray/copy]</span><spanclass="delimiter">: </span><spanclass="description">copy an input ndarray to a new ndarray having the same shape and data type.</span>
115
115
- <spanclass="signature">[`countFalsy( x[, options] )`][@stdlib/ndarray/count-falsy]</span><spanclass="delimiter">: </span><spanclass="description">count the number of falsy elements along one or more `ndarray` dimensions.</span>
116
116
- <spanclass="signature">[`countIf( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/count-if]</span><spanclass="delimiter">: </span><spanclass="description">count the number of truthy elements along one or more `ndarray` dimensions.</span>
Copy file name to clipboardExpand all lines: base/README.md
+28-4Lines changed: 28 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,7 @@ var o = ns;
58
58
- <spanclass="signature">[`broadcastArrayExceptDimensions( arr, shape, dims )`][@stdlib/ndarray/base/broadcast-array-except-dimensions]</span><spanclass="delimiter">: </span><spanclass="description">broadcast an input ndarray to a target shape while keeping a list of specified dimensions unchanged.</span>
59
59
- <spanclass="signature">[`broadcastArray( arr, shape )`][@stdlib/ndarray/base/broadcast-array]</span><spanclass="delimiter">: </span><spanclass="description">broadcast an ndarray to a specified shape.</span>
60
60
- <spanclass="signature">[`broadcastArrays( arrays )`][@stdlib/ndarray/base/broadcast-arrays]</span><spanclass="delimiter">: </span><spanclass="description">broadcast ndarrays to a common shape.</span>
61
-
- <spanclass="signature">[`broadcastScalar( value, dtype, shape, order )`][@stdlib/ndarray/base/broadcast-scalar]</span><spanclass="delimiter">: </span><spanclass="description">broadcast a scalar value to an `ndarray` having a specified shape.</span>
61
+
- <spanclass="signature">[`broadcastScalar( value, dtype, shape, order )`][@stdlib/ndarray/base/broadcast-scalar]</span><spanclass="delimiter">: </span><spanclass="description">broadcast a scalar value to an ndarray having a specified shape.</span>
62
62
- <spanclass="signature">[`broadcastShapes( shapes )`][@stdlib/ndarray/base/broadcast-shapes]</span><spanclass="delimiter">: </span><spanclass="description">broadcast array shapes to a single shape.</span>
63
63
- <spanclass="signature">[`bufferCtors( dtype )`][@stdlib/ndarray/base/buffer-ctors]</span><spanclass="delimiter">: </span><spanclass="description">ndarray data buffer constructors.</span>
64
64
- <spanclass="signature">[`bufferDataTypeEnum( buffer )`][@stdlib/ndarray/base/buffer-dtype-enum]</span><spanclass="delimiter">: </span><spanclass="description">return the data type enumeration constant of an ndarray data buffer.</span>
@@ -89,11 +89,12 @@ var o = ns;
89
89
- <spanclass="signature">[`dtype2c( dtype )`][@stdlib/ndarray/base/dtype2c]</span><spanclass="delimiter">: </span><spanclass="description">return the C data type associated with a provided data type value.</span>
90
90
- <spanclass="signature">[`dtypes2enums( dtypes )`][@stdlib/ndarray/base/dtypes2enums]</span><spanclass="delimiter">: </span><spanclass="description">resolve a list of data type enumeration constants.</span>
91
91
- <spanclass="signature">[`dtypes2signatures( dtypes, nin, nout )`][@stdlib/ndarray/base/dtypes2signatures]</span><spanclass="delimiter">: </span><spanclass="description">transform a list of array argument data types into a list of signatures.</span>
92
+
- <spanclass="signature">[`dtypes2strings( dtypes )`][@stdlib/ndarray/base/dtypes2strings]</span><spanclass="delimiter">: </span><spanclass="description">resolve a list of data type strings.</span>
92
93
- <spanclass="signature">[`emptyLike( x )`][@stdlib/ndarray/base/empty-like]</span><spanclass="delimiter">: </span><spanclass="description">create an uninitialized ndarray having the same shape and data type as a provided ndarray.</span>
93
94
- <spanclass="signature">[`empty( dtype, shape, order )`][@stdlib/ndarray/base/empty]</span><spanclass="delimiter">: </span><spanclass="description">create an uninitialized ndarray having a specified shape and data type.</span>
94
95
- <spanclass="signature">[`everyBy( arrays, predicate[, thisArg] )`][@stdlib/ndarray/base/every-by]</span><spanclass="delimiter">: </span><spanclass="description">test whether all elements in an ndarray pass a test implemented by a predicate function.</span>
95
96
- <spanclass="signature">[`every( arrays )`][@stdlib/ndarray/base/every]</span><spanclass="delimiter">: </span><spanclass="description">test whether every element in an ndarray is truthy.</span>
96
-
- <spanclass="signature">[`expandDimensions( x, axis )`][@stdlib/ndarray/base/expand-dimensions]</span><spanclass="delimiter">: </span><spanclass="description">expand the shape of an array by inserting a new dimension of size one at a specified axis.</span>
97
+
- <spanclass="signature">[`expandDimensions( x, dim, writable )`][@stdlib/ndarray/base/expand-dimensions]</span><spanclass="delimiter">: </span><spanclass="description">expand the shape of an array by inserting a new dimension of size one at a specified dimension index.</span>
97
98
- <spanclass="signature">[`fillBy( x, fcn[, thisArg] )`][@stdlib/ndarray/base/fill-by]</span><spanclass="delimiter">: </span><spanclass="description">fill an input ndarray according to a callback function.</span>
98
99
- <spanclass="signature">[`fill( x, value )`][@stdlib/ndarray/base/fill]</span><spanclass="delimiter">: </span><spanclass="description">fill an input ndarray with a specified value.</span>
99
100
- <spanclass="signature">[`find( arrays, predicate[, thisArg] )`][@stdlib/ndarray/base/find]</span><spanclass="delimiter">: </span><spanclass="description">return the first element in an ndarray which passes a test implemented by a predicate function.</span>
@@ -145,7 +146,7 @@ var o = ns;
145
146
- <spanclass="signature">[`outputPolicyResolveStr( dtype )`][@stdlib/ndarray/base/output-policy-resolve-str]</span><spanclass="delimiter">: </span><spanclass="description">return the policy string associated with a supported ndarray data type policy value.</span>
146
147
- <spanclass="signature">[`outputPolicyStr2Enum( policy )`][@stdlib/ndarray/base/output-policy-str2enum]</span><spanclass="delimiter">: </span><spanclass="description">return the enumeration constant associated with an output ndarray data type policy string.</span>
147
148
- <spanclass="signature">[`pop( x, dim, writable )`][@stdlib/ndarray/base/pop]</span><spanclass="delimiter">: </span><spanclass="description">return an array containing a truncated view of an input ndarray and a view of the last element(s) along a specified dimension.</span>
148
-
- <spanclass="signature">[`prependSingletonDimensions( x, n )`][@stdlib/ndarray/base/prepend-singleton-dimensions]</span><spanclass="delimiter">: </span><spanclass="description">prepend singleton dimensions.</span>
149
+
- <spanclass="signature">[`prependSingletonDimensions( x, n, writable )`][@stdlib/ndarray/base/prepend-singleton-dimensions]</span><spanclass="delimiter">: </span><spanclass="description">prepend singleton dimensions.</span>
149
150
- <spanclass="signature">[`promoteDataTypes( dtypes )`][@stdlib/ndarray/base/promote-dtypes]</span><spanclass="delimiter">: </span><spanclass="description">resolve the data type that results from applying promotion rules to a provided list of data types.</span>
150
151
- <spanclass="signature">[`removeSingletonDimensions( x )`][@stdlib/ndarray/base/remove-singleton-dimensions]</span><spanclass="delimiter">: </span><spanclass="description">remove singleton dimensions.</span>
151
152
- <spanclass="signature">[`reverseDimension( x, dim, writable )`][@stdlib/ndarray/base/reverse-dimension]</span><spanclass="delimiter">: </span><spanclass="description">return a view of an input ndarray in which the order of elements along a specified dimension is reversed.</span>
@@ -164,14 +165,21 @@ var o = ns;
164
165
- <spanclass="signature">[`slice( x, slice, strict, writable )`][@stdlib/ndarray/base/slice]</span><spanclass="delimiter">: </span><spanclass="description">return a view of an input ndarray.</span>
165
166
- <spanclass="signature">[`someBy( arrays, predicate[, thisArg ] )`][@stdlib/ndarray/base/some-by]</span><spanclass="delimiter">: </span><spanclass="description">test whether at least `n` elements in an ndarray pass a test implemented by a predicate function.</span>
166
167
- <spanclass="signature">[`some( arrays )`][@stdlib/ndarray/base/some]</span><spanclass="delimiter">: </span><spanclass="description">test whether at least `n` elements in an ndarray are truthy.</span>
167
-
- <spanclass="signature">[`spreadDimensions( ndims, x, dims )`][@stdlib/ndarray/base/spread-dimensions]</span><spanclass="delimiter">: </span><spanclass="description">expand the shape of an array to a specified dimensionality by spreading its dimensions to specified dimension indices and inserting dimensions of size one for the remaining dimensions.</span>
168
+
- <spanclass="signature">[`spreadDimensions( ndims, x, dims, writable )`][@stdlib/ndarray/base/spread-dimensions]</span><spanclass="delimiter">: </span><spanclass="description">expand the shape of an array to a specified dimensionality by spreading its dimensions to specified dimension indices and inserting dimensions of size one for the remaining dimensions.</span>
168
169
- <spanclass="signature">[`stride( x, dim )`][@stdlib/ndarray/base/stride]</span><spanclass="delimiter">: </span><spanclass="description">return the stride along a specified dimension for a provided ndarray.</span>
169
170
- <spanclass="signature">[`strides( x, copy )`][@stdlib/ndarray/base/strides]</span><spanclass="delimiter">: </span><spanclass="description">return the strides of a provided ndarray.</span>
170
171
- <spanclass="signature">[`strides2offset( shape, strides )`][@stdlib/ndarray/base/strides2offset]</span><spanclass="delimiter">: </span><spanclass="description">determine the index offset which specifies the location of the first indexed value in a multidimensional array based on a stride array.</span>
171
172
- <spanclass="signature">[`strides2order( strides )`][@stdlib/ndarray/base/strides2order]</span><spanclass="delimiter">: </span><spanclass="description">determine the order of a multidimensional array based on a provided stride array.</span>
172
173
- <spanclass="signature">[`sub2ind( shape, strides, offset, ...subscripts, mode )`][@stdlib/ndarray/base/sub2ind]</span><spanclass="delimiter">: </span><spanclass="description">convert subscripts to a linear index.</span>
174
+
- <spanclass="signature">[`ternaryLoopOrder( shape, stridesX, stridesY, stridesZ, stridesW )`][@stdlib/ndarray/base/ternary-loop-interchange-order]</span><spanclass="delimiter">: </span><spanclass="description">reorder ndarray dimensions and associated strides for loop interchange.</span>
175
+
- <spanclass="signature">[`ternaryOutputDataType( xdtype, ydtype, zdtype, policy )`][@stdlib/ndarray/base/ternary-output-dtype]</span><spanclass="delimiter">: </span><spanclass="description">resolve the output ndarray data type for a ternary function.</span>
176
+
- <spanclass="signature">[`ternaryBlockSize( dtypeX, dtypeY, dtypeZ, dtypeW )`][@stdlib/ndarray/base/ternary-tiling-block-size]</span><spanclass="delimiter">: </span><spanclass="description">resolve a loop block size for multi-dimensional array tiled loops.</span>
177
+
- <spanclass="signature">[`ternary( arrays, fcn )`][@stdlib/ndarray/base/ternary]</span><spanclass="delimiter">: </span><spanclass="description">apply a ternary callback to elements in input ndarrays and assign results to elements in an output ndarray.</span>
173
178
- <spanclass="signature">[`ndarray2array( buffer, shape, strides, offset, order )`][@stdlib/ndarray/base/to-array]</span><spanclass="delimiter">: </span><spanclass="description">convert an ndarray buffer to a generic array.</span>
179
+
- <spanclass="signature">[`toFlippedlr( x )`][@stdlib/ndarray/base/to-flippedlr]</span><spanclass="delimiter">: </span><spanclass="description">return a new ndarray where the order of elements along the last dimension of an input ndarray is reversed.</span>
180
+
- <spanclass="signature">[`toFlippedud( x )`][@stdlib/ndarray/base/to-flippedud]</span><spanclass="delimiter">: </span><spanclass="description">return a new ndarray where the order of elements along the second-to-last dimension of an input ndarray is reversed.</span>
174
181
- <spanclass="signature">[`toNormalizedIndices( indices, max )`][@stdlib/ndarray/base/to-normalized-indices]</span><spanclass="delimiter">: </span><spanclass="description">normalize a list of indices to the interval `[0,max]`.</span>
182
+
- <spanclass="signature">[`toReversedDimension( x, dim )`][@stdlib/ndarray/base/to-reversed-dimension]</span><spanclass="delimiter">: </span><spanclass="description">return a new ndarray where the order of elements of an input ndarray along a specified dimension is reversed.</span>
175
183
- <spanclass="signature">[`toReversed( x )`][@stdlib/ndarray/base/to-reversed]</span><spanclass="delimiter">: </span><spanclass="description">return a new ndarray where the order of elements of an input ndarray is reversed along each dimension.</span>
176
184
- <spanclass="signature">[`toUniqueNormalizedIndices( indices, max )`][@stdlib/ndarray/base/to-unique-normalized-indices]</span><spanclass="delimiter">: </span><spanclass="description">return a list of unique indices after normalizing to the interval `[0,max]`.</span>
177
185
- <spanclass="signature">[`transpose( x )`][@stdlib/ndarray/base/transpose]</span><spanclass="delimiter">: </span><spanclass="description">transpose a matrix (or a stack of matrices).</span>
0 commit comments