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: lib/node_modules/@stdlib/array/base/README.md
+21-3Lines changed: 21 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -88,10 +88,14 @@ The namespace exports the following:
88
88
- <spanclass="signature">[`cartesianSquare( x )`][@stdlib/array/base/cartesian-square]</span><spanclass="delimiter">: </span><spanclass="description">return the Cartesian square.</span>
89
89
- <spanclass="signature">[`copyIndexed( x )`][@stdlib/array/base/copy-indexed]</span><spanclass="delimiter">: </span><spanclass="description">copy the elements of an indexed array-like object to a new "generic" array.</span>
90
90
- <spanclass="signature">[`copy( x )`][@stdlib/array/base/copy]</span><spanclass="delimiter">: </span><spanclass="description">copy the elements of an array-like object to a new "generic" array.</span>
91
+
- <spanclass="signature">[`countFalsy( x )`][@stdlib/array/base/count-falsy]</span><spanclass="delimiter">: </span><spanclass="description">count the number of falsy elements in an array.</span>
92
+
- <spanclass="signature">[`countTruthy( x )`][@stdlib/array/base/count-truthy]</span><spanclass="delimiter">: </span><spanclass="description">count the number of truthy elements in an array.</span>
- <spanclass="signature">[`everyByRight( x, predicate[, thisArg] )`][@stdlib/array/base/every-by-right]</span><spanclass="delimiter">: </span><spanclass="description">test whether all elements in an array pass a test implemented by a predicate function, iterating from right to left.</span>
93
95
- <spanclass="signature">[`everyBy( x, predicate[, thisArg] )`][@stdlib/array/base/every-by]</span><spanclass="delimiter">: </span><spanclass="description">test whether all elements in an array pass a test implemented by a predicate function.</span>
94
96
- <spanclass="signature">[`every( x )`][@stdlib/array/base/every]</span><spanclass="delimiter">: </span><spanclass="description">test whether all elements in an array are truthy.</span>
97
+
- <spanclass="signature">[`fancySliceAssign( x, y, s, strict )`][@stdlib/array/base/fancy-slice-assign]</span><spanclass="delimiter">: </span><spanclass="description">assign element values from a broadcasted input array to corresponding elements in an output array.</span>
98
+
- <spanclass="signature">[`fancySlice( x, s, strict )`][@stdlib/array/base/fancy-slice]</span><spanclass="delimiter">: </span><spanclass="description">return a shallow copy of a portion of an array.</span>
95
99
- <spanclass="signature">[`filledBy( len, clbk[, thisArg] )`][@stdlib/array/base/filled-by]</span><spanclass="delimiter">: </span><spanclass="description">create a filled "generic" array according to a provided callback function.</span>
96
100
- <spanclass="signature">[`filled( value, len )`][@stdlib/array/base/filled]</span><spanclass="delimiter">: </span><spanclass="description">create a filled "generic" array.</span>
97
101
- <spanclass="signature">[`filled2dBy( shape, clbk[, thisArg] )`][@stdlib/array/base/filled2d-by]</span><spanclass="delimiter">: </span><spanclass="description">create a filled two-dimensional nested array according to a provided callback function.</span>
@@ -142,9 +146,11 @@ The namespace exports the following:
142
146
- <spanclass="signature">[`map3d( x, shape, fcn[, thisArg] )`][@stdlib/array/base/map3d]</span><spanclass="delimiter">: </span><spanclass="description">apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.</span>
143
147
- <spanclass="signature">[`map4d( x, shape, fcn[, thisArg] )`][@stdlib/array/base/map4d]</span><spanclass="delimiter">: </span><spanclass="description">apply a function to elements in a four-dimensional nested input array and assign results to elements in a new four-dimensional nested output array.</span>
144
148
- <spanclass="signature">[`map5d( x, shape, fcn[, thisArg] )`][@stdlib/array/base/map5d]</span><spanclass="delimiter">: </span><spanclass="description">apply a function to elements in a five-dimensional nested input array and assign results to elements in a new five-dimensional nested output array.</span>
149
+
- <spanclass="signature">[`minSignedIntegerDataType( value )`][@stdlib/array/base/min-signed-integer-dtype]</span><spanclass="delimiter">: </span><spanclass="description">determine the minimum array data type for storing a provided signed integer value.</span>
150
+
- <spanclass="signature">[`minUnsignedIntegerDataType( value )`][@stdlib/array/base/min-unsigned-integer-dtype]</span><spanclass="delimiter">: </span><spanclass="description">determine the minimum array data type for storing a provided unsigned integer value.</span>
145
151
- <spanclass="signature">[`mskbinary2d( arrays, shape, fcn )`][@stdlib/array/base/mskbinary2d]</span><spanclass="delimiter">: </span><spanclass="description">apply a binary callback to elements in two two-dimensional nested input arrays according to elements in a two-dimensional nested mask array and assign results to elements in a two-dimensional nested output array.</span>
146
-
- <spanclass="signature">[`mskfilter( x, mask )`][@stdlib/array/base/mskfilter]</span><spanclass="delimiter">: </span><spanclass="description">return a new array by applying a mask to a provided input array.</span>
147
-
- <spanclass="signature">[`mskreject( x, mask )`][@stdlib/array/base/mskreject]</span><spanclass="delimiter">: </span><spanclass="description">return a new array by applying a mask to a provided input array.</span>
152
+
- <spanclass="signature">[`mskfilter( x, mask )`][@stdlib/array/base/mskfilter]</span><spanclass="delimiter">: </span><spanclass="description">apply a mask to a provided input array.</span>
153
+
- <spanclass="signature">[`mskreject( x, mask )`][@stdlib/array/base/mskreject]</span><spanclass="delimiter">: </span><spanclass="description">apply a mask to a provided input array.</span>
148
154
- <spanclass="signature">[`mskunary2d( arrays, shape, fcn )`][@stdlib/array/base/mskunary2d]</span><spanclass="delimiter">: </span><spanclass="description">apply a unary callback to elements in a two-dimensional nested input array according to elements in a two-dimensional nested mask array and assign results to elements in a two-dimensional nested output array.</span>
149
155
- <spanclass="signature">[`mskunary3d( arrays, shape, fcn )`][@stdlib/array/base/mskunary3d]</span><spanclass="delimiter">: </span><spanclass="description">apply a unary callback to elements in a three-dimensional nested input array according to elements in a three-dimensional nested mask array and assign results to elements in a three-dimensional nested output array.</span>
@@ -177,7 +183,7 @@ The namespace exports the following:
177
183
- <spanclass="signature">[`strided2array4d( x, shape, strides, offset )`][@stdlib/array/base/strided2array4d]</span><spanclass="delimiter">: </span><spanclass="description">convert a strided array to a four-dimensional nested array.</span>
178
184
- <spanclass="signature">[`strided2array5d( x, shape, strides, offset )`][@stdlib/array/base/strided2array5d]</span><spanclass="delimiter">: </span><spanclass="description">convert a strided array to a five-dimensional nested array.</span>
179
185
- <spanclass="signature">[`takeIndexed( x, indices )`][@stdlib/array/base/take-indexed]</span><spanclass="delimiter">: </span><spanclass="description">take elements from an indexed array.</span>
180
-
- <spanclass="signature">[`take( x, indices )`][@stdlib/array/base/take]</span><spanclass="delimiter">: </span><spanclass="description">take elements from an array.</span>
186
+
- <spanclass="signature">[`take( x, indices, mode )`][@stdlib/array/base/take]</span><spanclass="delimiter">: </span><spanclass="description">take elements from an array.</span>
181
187
- <spanclass="signature">[`take2d( x, indices, dimension, mode )`][@stdlib/array/base/take2d]</span><spanclass="delimiter">: </span><spanclass="description">take elements from a two-dimensional nested array.</span>
182
188
- <spanclass="signature">[`take3d( x, indices, dimension, mode )`][@stdlib/array/base/take3d]</span><spanclass="delimiter">: </span><spanclass="description">take elements from a three-dimensional nested array.</span>
183
189
- <spanclass="signature">[`ternary2d( arrays, shape, fcn )`][@stdlib/array/base/ternary2d]</span><spanclass="delimiter">: </span><spanclass="description">apply a ternary callback to elements in three two-dimensional nested input arrays and assign results to elements in a two-dimensional nested output array.</span>
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/array/base/assert/README.md
+39Lines changed: 39 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -48,8 +48,21 @@ The namespace exports the following:
48
48
- <spanclass="signature">[`contains( x, value )`][@stdlib/array/base/assert/contains]</span><spanclass="delimiter">: </span><spanclass="description">test if an array contains a provided search value.</span>
49
49
- <spanclass="signature">[`hasSameValues( x, y )`][@stdlib/array/base/assert/has-same-values]</span><spanclass="delimiter">: </span><spanclass="description">test if two arrays have the same values.</span>
50
50
- <spanclass="signature">[`isAccessorArray( value )`][@stdlib/array/base/assert/is-accessor-array]</span><spanclass="delimiter">: </span><spanclass="description">test if an array-like object supports the accessor (get/set) protocol.</span>
51
+
- <spanclass="signature">[`isComplexFloatingPointDataType( value )`][@stdlib/array/base/assert/is-complex-floating-point-data-type]</span><spanclass="delimiter">: </span><spanclass="description">test if an input value is a supported array complex-valued floating-point data type.</span>
52
+
- <spanclass="signature">[`isComplexTypedArray( value )`][@stdlib/array/base/assert/is-complex-typed-array]</span><spanclass="delimiter">: </span><spanclass="description">test if a value is a complex typed array.</span>
51
53
- <spanclass="signature">[`isComplex128Array( value )`][@stdlib/array/base/assert/is-complex128array]</span><spanclass="delimiter">: </span><spanclass="description">test if a value is a `Complex128Array`.</span>
52
54
- <spanclass="signature">[`isComplex64Array( value )`][@stdlib/array/base/assert/is-complex64array]</span><spanclass="delimiter">: </span><spanclass="description">test if a value is a `Complex64Array`.</span>
55
+
- <spanclass="signature">[`isDataType( value )`][@stdlib/array/base/assert/is-data-type]</span><spanclass="delimiter">: </span><spanclass="description">test if an input value is a supported array data type.</span>
56
+
- <spanclass="signature">[`isFloatingPointDataType( value )`][@stdlib/array/base/assert/is-floating-point-data-type]</span><spanclass="delimiter">: </span><spanclass="description">test if an input value is a supported array floating-point data type.</span>
57
+
- <spanclass="signature">[`isIntegerDataType( value )`][@stdlib/array/base/assert/is-integer-data-type]</span><spanclass="delimiter">: </span><spanclass="description">test if an input value is a supported array integer data type.</span>
58
+
- <spanclass="signature">[`isMostlySafeDataTypeCast( from, to )`][@stdlib/array/base/assert/is-mostly-safe-data-type-cast]</span><spanclass="delimiter">: </span><spanclass="description">determine whether an array data type can be safely cast or, for floating-point data types, downcast to another array data type.</span>
59
+
- <spanclass="signature">[`isNumericDataType( value )`][@stdlib/array/base/assert/is-numeric-data-type]</span><spanclass="delimiter">: </span><spanclass="description">test if an input value is a supported array numeric data type.</span>
60
+
- <spanclass="signature">[`isRealDataType( value )`][@stdlib/array/base/assert/is-real-data-type]</span><spanclass="delimiter">: </span><spanclass="description">test if an input value is a supported array real-valued data type.</span>
61
+
- <spanclass="signature">[`isRealFloatingPointDataType( value )`][@stdlib/array/base/assert/is-real-floating-point-data-type]</span><spanclass="delimiter">: </span><spanclass="description">test if an input value is a supported array real-valued floating-point data type.</span>
62
+
- <spanclass="signature">[`isSafeDataTypeCast( from, to )`][@stdlib/array/base/assert/is-safe-data-type-cast]</span><spanclass="delimiter">: </span><spanclass="description">determine whether an array data type can be safely cast to another array data type.</span>
63
+
- <spanclass="signature">[`isSameKindDataTypeCast( from, to )`][@stdlib/array/base/assert/is-same-kind-data-type-cast]</span><spanclass="delimiter">: </span><spanclass="description">determine whether an array data type can be safely cast to, or is of the same "kind" as, another array data type.</span>
64
+
- <spanclass="signature">[`isSignedIntegerDataType( value )`][@stdlib/array/base/assert/is-signed-integer-data-type]</span><spanclass="delimiter">: </span><spanclass="description">test if an input value is a supported array signed integer data type.</span>
65
+
- <spanclass="signature">[`isUnsignedIntegerDataType( value )`][@stdlib/array/base/assert/is-unsigned-integer-data-type]</span><spanclass="delimiter">: </span><spanclass="description">test if an input value is a supported array unsigned integer data type.</span>
0 commit comments