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
Copy file name to clipboardExpand all lines: README.md
+39Lines changed: 39 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -109,8 +109,10 @@ In addition, the namespace contains the following multidimensional array utility
109
109
- <spanclass="signature">[`at( x[, ...indices] )`][@stdlib/ndarray/at]</span><spanclass="delimiter">: </span><spanclass="description">return an `ndarray` element.</span>
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
+
- <spanclass="signature">[`broadcastScalar( value, shape[, options] )`][@stdlib/ndarray/broadcast-scalar]</span><spanclass="delimiter">: </span><spanclass="description">broadcast a scalar value to an ndarray of a specified shape.</span>
112
113
- <spanclass="signature">[`castingModes()`][@stdlib/ndarray/casting-modes]</span><spanclass="delimiter">: </span><spanclass="description">list of ndarray casting modes.</span>
113
114
- <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>
115
+
- <spanclass="signature">[`concat1d( ...arrays )`][@stdlib/ndarray/concat1d]</span><spanclass="delimiter">: </span><spanclass="description">return a one-dimensional ndarray formed by concatenating provided input arguments.</span>
114
116
- <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
117
- <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
118
- <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>
@@ -130,13 +132,18 @@ In addition, the namespace contains the following multidimensional array utility
130
132
- <spanclass="signature">[`fill( x, value )`][@stdlib/ndarray/fill]</span><spanclass="delimiter">: </span><spanclass="description">fill an input `ndarray` with a specified value.</span>
131
133
- <spanclass="signature">[`filterMap( x[, options], fcn[, thisArg] )`][@stdlib/ndarray/filter-map]</span><spanclass="delimiter">: </span><spanclass="description">filter and map elements in an input ndarray to elements in a new output ndarray according to a callback function.</span>
132
134
- <spanclass="signature">[`filter( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/filter]</span><spanclass="delimiter">: </span><spanclass="description">return a shallow copy of an ndarray containing only those elements which pass a test implemented by a predicate function.</span>
135
+
- <spanclass="signature">[`findLast( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/find-last]</span><spanclass="delimiter">: </span><spanclass="description">return a new ndarray containing the last elements which pass a test implemented by a predicate function along one or more ndarray dimensions.</span>
133
136
- <spanclass="signature">[`find( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/find]</span><spanclass="delimiter">: </span><spanclass="description">return a new ndarray containing the first elements which pass a test implemented by a predicate function along one or more ndarray dimensions.</span>
134
137
- <spanclass="signature">[`flag( x, name )`][@stdlib/ndarray/flag]</span><spanclass="delimiter">: </span><spanclass="description">return a specified flag for a provided ndarray.</span>
135
138
- <spanclass="signature">[`flags( x )`][@stdlib/ndarray/flags]</span><spanclass="delimiter">: </span><spanclass="description">return the flags of a provided ndarray.</span>
136
139
- <spanclass="signature">[`flattenBy( x[, options], fcn[, thisArg] )`][@stdlib/ndarray/flatten-by]</span><spanclass="delimiter">: </span><spanclass="description">flatten an ndarray according to a callback function.</span>
140
+
- <spanclass="signature">[`flattenFromBy( x, dim[, options], fcn[, thisArg] )`][@stdlib/ndarray/flatten-from-by]</span><spanclass="delimiter">: </span><spanclass="description">flatten an ndarray according to a callback function starting from a specified dimension.</span>
137
141
- <spanclass="signature">[`flattenFrom( x, dim[, options] )`][@stdlib/ndarray/flatten-from]</span><spanclass="delimiter">: </span><spanclass="description">return a copy of an input ndarray where all dimensions of the input ndarray are flattened starting from a specified dimension.</span>
138
142
- <spanclass="signature">[`flatten( x[, options] )`][@stdlib/ndarray/flatten]</span><spanclass="delimiter">: </span><spanclass="description">return a flattened copy of an input ndarray.</span>
143
+
- <spanclass="signature">[`fliplr( x )`][@stdlib/ndarray/fliplr]</span><spanclass="delimiter">: </span><spanclass="description">return a **read-only** view of an input `ndarray` in which the order of elements along the last dimension is reversed.</span>
144
+
- <spanclass="signature">[`flipud( x )`][@stdlib/ndarray/flipud]</span><spanclass="delimiter">: </span><spanclass="description">return a **read-only** view of an input `ndarray` in which the order of elements along the second-to-last dimension is reversed.</span>
139
145
- <spanclass="signature">[`forEach( x, fcn[, thisArg] )`][@stdlib/ndarray/for-each]</span><spanclass="delimiter">: </span><spanclass="description">invoke a callback function once for each ndarray element.</span>
146
+
- <spanclass="signature">[`scalar2ndarrayLike( x, value[, options] )`][@stdlib/ndarray/from-scalar-like]</span><spanclass="delimiter">: </span><spanclass="description">convert a scalar value to a zero-dimensional ndarray having the same data-type as a provided ndarray.</span>
140
147
- <spanclass="signature">[`scalar2ndarray( value[, options] )`][@stdlib/ndarray/from-scalar]</span><spanclass="delimiter">: </span><spanclass="description">convert a scalar value to a zero-dimensional ndarray.</span>
141
148
- <spanclass="signature">[`includes( x, searchElement[, options] )`][@stdlib/ndarray/includes]</span><spanclass="delimiter">: </span><spanclass="description">test whether an `ndarray` contains a specified value along one or more dimensions.</span>
142
149
- <spanclass="signature">[`ind2sub( shape, idx[, options] )`][@stdlib/ndarray/ind2sub]</span><spanclass="delimiter">: </span><spanclass="description">convert a linear index to an array of subscripts.</span>
@@ -158,7 +165,9 @@ In addition, the namespace contains the following multidimensional array utility
158
165
- <spanclass="signature">[`orders()`][@stdlib/ndarray/orders]</span><spanclass="delimiter">: </span><spanclass="description">list of ndarray orders.</span>
159
166
- <spanclass="signature">[`outputDataTypePolicies()`][@stdlib/ndarray/output-dtype-policies]</span><spanclass="delimiter">: </span><spanclass="description">list of output ndarray data type policies.</span>
160
167
- <spanclass="signature">[`pop( x[, options] )`][@stdlib/ndarray/pop]</span><spanclass="delimiter">: </span><spanclass="description">return an array containing a read-only truncated view of an input `ndarray` and a read-only view of the last element(s) along a specified dimension.</span>
168
+
- <spanclass="signature">[`prependSingletonDimensions( x, n )`][@stdlib/ndarray/prepend-singleton-dimensions]</span><spanclass="delimiter">: </span><spanclass="description">return a read-only view of an input ndarray with a specified number of prepended singleton dimensions.</span>
161
169
- <spanclass="signature">[`promotionRules( [dtype1, dtype2] )`][@stdlib/ndarray/promotion-rules]</span><spanclass="delimiter">: </span><spanclass="description">return the ndarray data type with the smallest size and closest "kind" to which ndarray data types can be **safely** cast.</span>
170
+
- <spanclass="signature">[`push( x, ...values )`][@stdlib/ndarray/push]</span><spanclass="delimiter">: </span><spanclass="description">return a one-dimensional ndarray formed by appending provided scalar values to a one-dimensional input ndarray.</span>
162
171
- <spanclass="signature">[`reject( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/reject]</span><spanclass="delimiter">: </span><spanclass="description">return a shallow copy of an ndarray containing only those elements which fail a test implemented by a predicate function.</span>
163
172
- <spanclass="signature">[`reverseDimension( x, dim )`][@stdlib/ndarray/reverse-dimension]</span><spanclass="delimiter">: </span><spanclass="description">return a **read-only** view of an input `ndarray` in which the order of elements along a specified dimension is reversed.</span>
164
173
- <spanclass="signature">[`reverse( x )`][@stdlib/ndarray/reverse]</span><spanclass="delimiter">: </span><spanclass="description">return a **read-only** view of an input `ndarray` in which the order of elements along each dimension is reversed.</span>
@@ -174,13 +183,17 @@ In addition, the namespace contains the following multidimensional array utility
174
183
- <spanclass="signature">[`sliceTo( x, ...stop[, options] )`][@stdlib/ndarray/slice-to]</span><spanclass="delimiter">: </span><spanclass="description">return a read-only truncated view of an input ndarray.</span>
175
184
- <spanclass="signature">[`slice( x, ...s[, options] )`][@stdlib/ndarray/slice]</span><spanclass="delimiter">: </span><spanclass="description">return a read-only view of an input `ndarray`.</span>
176
185
- <spanclass="signature">[`someBy( x, n[, options], predicate[, thisArg] )`][@stdlib/ndarray/some-by]</span><spanclass="delimiter">: </span><spanclass="description">test whether at least `n` elements along one or more `ndarray` dimensions pass a test implemented by a predicate function.</span>
186
+
- <spanclass="signature">[`some( x, n[, options] )`][@stdlib/ndarray/some]</span><spanclass="delimiter">: </span><spanclass="description">test whether at least `n` elements along one or more `ndarray` dimensions are truthy.</span>
187
+
- <spanclass="signature">[`spreadDimensions( ndims, x, dims )`][@stdlib/ndarray/spread-dimensions]</span><spanclass="delimiter">: </span><spanclass="description">return a read-only view of an input ndarray where the dimensions of the input ndarray are expanded to a specified dimensionality by spreading dimensions to specified dimension indices and inserting dimensions of size one for the remaining dimensions.</span>
177
188
- <spanclass="signature">[`stride( x, dim )`][@stdlib/ndarray/stride]</span><spanclass="delimiter">: </span><spanclass="description">return the stride along a specified dimension for a provided ndarray.</span>
178
189
- <spanclass="signature">[`strides( x )`][@stdlib/ndarray/strides]</span><spanclass="delimiter">: </span><spanclass="description">return the strides of a provided ndarray.</span>
179
190
- <spanclass="signature">[`sub2ind( shape, ...subscripts[, options] )`][@stdlib/ndarray/sub2ind]</span><spanclass="delimiter">: </span><spanclass="description">convert subscripts to a linear index.</span>
180
191
- <spanclass="signature">[`ndarray2array( x )`][@stdlib/ndarray/to-array]</span><spanclass="delimiter">: </span><spanclass="description">convert an ndarray to a generic array.</span>
181
192
- <spanclass="signature">[`ndarray2fancy( x[, options] )`][@stdlib/ndarray/to-fancy]</span><spanclass="delimiter">: </span><spanclass="description">convert an ndarray to an object supporting fancy indexing.</span>
182
193
- <spanclass="signature">[`ndarray2json( x )`][@stdlib/ndarray/to-json]</span><spanclass="delimiter">: </span><spanclass="description">serialize an ndarray as a JSON object.</span>
194
+
- <spanclass="signature">[`toReversedDimension( x[, options] )`][@stdlib/ndarray/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>
183
195
- <spanclass="signature">[`toReversed( x )`][@stdlib/ndarray/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>
196
+
- <spanclass="signature">[`unshift( x, ...values )`][@stdlib/ndarray/unshift]</span><spanclass="delimiter">: </span><spanclass="description">return a one-dimensional ndarray formed by prepending provided scalar values to a one-dimensional input ndarray.</span>
184
197
- <spanclass="signature">[`vector`][@stdlib/ndarray/vector]</span><spanclass="delimiter">: </span><spanclass="description">vector constructors and associated utilities.</span>
185
198
- <spanclass="signature">[`ndarrayWith( x, indices, value )`][@stdlib/ndarray/with]</span><spanclass="delimiter">: </span><spanclass="description">return a new ndarray with the element at a specified index replaced by a provided value.</span>
186
199
- <spanclass="signature">[`zerosLike( x[, options] )`][@stdlib/ndarray/zeros-like]</span><spanclass="delimiter">: </span><spanclass="description">create a zero-filled ndarray having the same shape and data type as a provided ndarray.</span>
0 commit comments