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/assert/README.md
+13-10Lines changed: 13 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -196,6 +196,7 @@ The namespace includes utilities for validating `ndarray`s (n-dimensional arrays
196
196
- <spanclass="signature">[`isFloat64ndarrayLike( value )`][@stdlib/assert/is-float64ndarray-like]</span><spanclass="delimiter">: </span><spanclass="description">test if a value is an ndarray-like object containing double-precision floating-point numbers.</span>
197
197
- <spanclass="signature">[`isFloat64VectorLike( value )`][@stdlib/assert/is-float64vector-like]</span><spanclass="delimiter">: </span><spanclass="description">test if a value is a 1-dimensional ndarray-like object containing double-precision floating-point numbers.</span>
198
198
- <spanclass="signature">[`isMatrixLike( value )`][@stdlib/assert/is-matrix-like]</span><spanclass="delimiter">: </span><spanclass="description">test if a value is 2-dimensional ndarray-like object.</span>
199
+
- <spanclass="signature">[`isndarrayDescriptor( value )`][@stdlib/assert/is-ndarray-descriptor]</span><spanclass="delimiter">: </span><spanclass="description">test if a value is an ndarray descriptor.</span>
199
200
- <spanclass="signature">[`isndarrayLikeWithDataType( value, dtype )`][@stdlib/assert/is-ndarray-like-with-data-type]</span><spanclass="delimiter">: </span><spanclass="description">test if a value is an ndarray-like object having a specified data type.</span>
200
201
- <spanclass="signature">[`isndarrayLike( value )`][@stdlib/assert/is-ndarray-like]</span><spanclass="delimiter">: </span><spanclass="description">test if a value is ndarray-like.</span>
201
202
- <spanclass="signature">[`isNonSymmetricMatrix( value )`][@stdlib/assert/is-nonsymmetric-matrix]</span><spanclass="delimiter">: </span><spanclass="description">test if a value is a non-symmetric matrix.</span>
@@ -242,11 +243,11 @@ The namespace includes utilities for validating other special arrays or buffers:
242
243
- <spanclass="signature">[`isAlmostEqualComplex64array( v1, v2, maxULP )`][@stdlib/assert/is-almost-equal-complex64array]</span><spanclass="delimiter">: </span><spanclass="description">test if two arguments are both Complex64Arrays and contain respective elements which are approximately equal within a specified number of ULPs (units in the last place).</span>
243
244
- <spanclass="signature">[`isAlmostEqualFloat32array( v1, v2, maxULP )`][@stdlib/assert/is-almost-equal-float32array]</span><spanclass="delimiter">: </span><spanclass="description">test if two arguments are both Float32Arrays and contain respective elements which are approximately equal within a specified number of ULPs (units in the last place).</span>
244
245
- <spanclass="signature">[`isAlmostEqualFloat64Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-equal-float64array]</span><spanclass="delimiter">: </span><spanclass="description">test if two arguments are both Float64Arrays and contain respective elements which are approximately equal within a specified number of ULPs (units in the last place).</span>
245
-
- <spanclass="signature">[`isAlmostSameValueArray( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-value-array]</span><spanclass="delimiter">: </span><spanclass="description">test if two arguments are both generic arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
246
-
- <spanclass="signature">[`isAlmostSameValueComplex128Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-value-complex128array]</span><spanclass="delimiter">: </span><spanclass="description">test if two arguments are both Complex128Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
247
-
- <spanclass="signature">[`isAlmostSameValueComplex64Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-value-complex64array]</span><spanclass="delimiter">: </span><spanclass="description">test if two arguments are both Complex64Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
248
-
- <spanclass="signature">[`isAlmostSameValueFloat32Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-value-float32array]</span><spanclass="delimiter">: </span><spanclass="description">test if two arguments are both Float32Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
249
-
- <spanclass="signature">[`isAlmostSameValueFloat64Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-value-float64array]</span><spanclass="delimiter">: </span><spanclass="description">test if two arguments are both Float64Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
246
+
- <spanclass="signature">[`isAlmostSameArray( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-array]</span><spanclass="delimiter">: </span><spanclass="description">test if two arguments are both generic arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
247
+
- <spanclass="signature">[`isAlmostSameComplex128Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-complex128array]</span><spanclass="delimiter">: </span><spanclass="description">test if two arguments are both Complex128Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
248
+
- <spanclass="signature">[`isAlmostSameComplex64Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-complex64array]</span><spanclass="delimiter">: </span><spanclass="description">test if two arguments are both Complex64Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
249
+
- <spanclass="signature">[`isAlmostSameFloat32Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-float32array]</span><spanclass="delimiter">: </span><spanclass="description">test if two arguments are both Float32Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
250
+
- <spanclass="signature">[`isAlmostSameFloat64Array( v1, v2, maxULP )`][@stdlib/assert/is-almost-same-float64array]</span><spanclass="delimiter">: </span><spanclass="description">test if two arguments are both Float64Arrays and contain respective elements which are approximately the same value within a specified number of ULPs (units in the last place).</span>
250
251
- <spanclass="signature">[`isArrayLength( value )`][@stdlib/assert/is-array-length]</span><spanclass="delimiter">: </span><spanclass="description">test if a value is a valid array length.</span>
251
252
- <spanclass="signature">[`isArrayLikeObject( value )`][@stdlib/assert/is-array-like-object]</span><spanclass="delimiter">: </span><spanclass="description">test if a value is an array-like object.</span>
252
253
- <spanclass="signature">[`isArrayLike( value )`][@stdlib/assert/is-array-like]</span><spanclass="delimiter">: </span><spanclass="description">test if a value is array-like.</span>
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/blas/ext/base/README.md
+9Lines changed: 9 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,6 +71,7 @@ var o = ns;
71
71
- <spanclass="signature">[`dcusumors( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dcusumors]</span><spanclass="delimiter">: </span><spanclass="description">calculate the cumulative sum of double-precision floating-point strided array elements using ordinary recursive summation.</span>
72
72
- <spanclass="signature">[`dcusumpw( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dcusumpw]</span><spanclass="delimiter">: </span><spanclass="description">calculate the cumulative sum of double-precision floating-point strided array elements using pairwise summation.</span>
73
73
- <spanclass="signature">[`ddiff( N, k, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut, workspace, strideW )`][@stdlib/blas/ext/base/ddiff]</span><spanclass="delimiter">: </span><spanclass="description">calculate the k-th discrete forward difference of a double-precision floating-point strided array.</span>
74
+
- <spanclass="signature">[`dediff( N, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut )`][@stdlib/blas/ext/base/dediff]</span><spanclass="delimiter">: </span><spanclass="description">calculate the differences between consecutive elements of a double-precision floating-point strided array.</span>
74
75
- <spanclass="signature">[`dfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dfill]</span><spanclass="delimiter">: </span><spanclass="description">fill a double-precision floating-point strided array with a specified scalar constant.</span>
75
76
- <spanclass="signature">[`dindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/dindex-of-column]</span><spanclass="delimiter">: </span><spanclass="description">return the index of the first column in a double-precision floating-point input matrix which has the same elements as a provided search vector.</span>
76
77
- <spanclass="signature">[`dindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/dindex-of-row]</span><spanclass="delimiter">: </span><spanclass="description">return the index of the first row in a double-precision floating-point input matrix which has the same elements as a provided search vector.</span>
@@ -204,6 +205,7 @@ var o = ns;
204
205
- <spanclass="signature">[`sdsnansumpw( N, x, strideX )`][@stdlib/blas/ext/base/sdsnansumpw]</span><spanclass="delimiter">: </span><spanclass="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation with extended accumulation.</span>
205
206
- <spanclass="signature">[`sdssum( N, x, strideX )`][@stdlib/blas/ext/base/sdssum]</span><spanclass="delimiter">: </span><spanclass="description">calculate the sum of single-precision floating-point strided array elements using extended accumulation.</span>
206
207
- <spanclass="signature">[`sdssumpw( N, x, strideX )`][@stdlib/blas/ext/base/sdssumpw]</span><spanclass="delimiter">: </span><spanclass="description">calculate the sum of single-precision floating-point strided array elements using pairwise summation with extended accumulation.</span>
208
+
- <spanclass="signature">[`sediff( N, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut )`][@stdlib/blas/ext/base/sediff]</span><spanclass="delimiter">: </span><spanclass="description">calculate the differences between consecutive elements of a single-precision floating-point strided array.</span>
207
209
- <spanclass="signature">[`sfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sfill]</span><spanclass="delimiter">: </span><spanclass="description">fill a single-precision floating-point strided array with a specified scalar constant.</span>
208
210
- <spanclass="signature">[`sindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/sindex-of-column]</span><spanclass="delimiter">: </span><spanclass="description">return the index of the first column in a single-precision floating-point input matrix which has the same elements as a provided search vector.</span>
209
211
- <spanclass="signature">[`sindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/sindex-of-row]</span><spanclass="delimiter">: </span><spanclass="description">return the index of the first row in a single-precision floating-point input matrix which has the same elements as a provided search vector.</span>
@@ -236,6 +238,7 @@ var o = ns;
236
238
- <spanclass="signature">[`swhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/swhere]</span><spanclass="delimiter">: </span><spanclass="description">take elements from one of two single-precision floating-point strided arrays depending on a condition.</span>
237
239
- <spanclass="signature">[`szeroTo( N, x, strideX )`][@stdlib/blas/ext/base/szero-to]</span><spanclass="delimiter">: </span><spanclass="description">fill a single-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero.</span>
238
240
- <spanclass="signature">[`wasm`][@stdlib/blas/ext/base/wasm]</span><spanclass="delimiter">: </span><spanclass="description">extensions to basic linear algebra subprograms (BLAS) compiled to WebAssembly.</span>
241
+
- <spanclass="signature">[`zdiff( N, k, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut, workspace, strideW )`][@stdlib/blas/ext/base/zdiff]</span><spanclass="delimiter">: </span><spanclass="description">calculate the k-th discrete forward difference of a double-precision complex floating-point strided array.</span>
239
242
- <spanclass="signature">[`zfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/zfill]</span><spanclass="delimiter">: </span><spanclass="description">fill a double-precision complex floating-point strided array with a specified scalar constant.</span>
240
243
- <spanclass="signature">[`zindexOfColumn( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zindex-of-column]</span><spanclass="delimiter">: </span><spanclass="description">return the index of the first column in a double-precision complex floating-point input matrix which has the same elements as a provided search vector.</span>
241
244
- <spanclass="signature">[`zindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zindex-of-row]</span><spanclass="delimiter">: </span><spanclass="description">return the index of the first row in a double-precision complex floating-point input matrix which has the same elements as a provided search vector.</span>
0 commit comments