diff --git a/lib/node_modules/@stdlib/blas/ext/README.md b/lib/node_modules/@stdlib/blas/ext/README.md index 062b9138a777..d5c6e9b23753 100644 --- a/lib/node_modules/@stdlib/blas/ext/README.md +++ b/lib/node_modules/@stdlib/blas/ext/README.md @@ -46,6 +46,7 @@ The namespace contains the following:
- [`base`][@stdlib/blas/ext/base]: base (i.e., lower-level) extensions to basic linear algebra subprograms (BLAS). +- [`sum( x[, options] )`][@stdlib/blas/ext/sum]: compute the sum along one or more ndarray dimensions.
@@ -90,6 +91,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base +[@stdlib/blas/ext/sum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/sum + diff --git a/lib/node_modules/@stdlib/blas/ext/base/README.md b/lib/node_modules/@stdlib/blas/ext/base/README.md index bf22466878ec..4aa888cfeb2b 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/README.md @@ -43,6 +43,7 @@ var o = ns;
+- [`cfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/cfill]: fill a single-precision complex floating-point strided array with a specified scalar constant. - [`dapx( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dapx]: add a scalar constant to each element in a double-precision floating-point strided array. - [`dapxsum( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dapxsum]: add a scalar constant to each double-precision floating-point strided array element and compute the sum. - [`dapxsumkbn( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dapxsumkbn]: add a scalar constant to each double-precision floating-point strided array element and compute the sum using an improved Kahan–Babuška algorithm. @@ -121,6 +122,7 @@ var o = ns; - [`gsumkbn2( N, x, strideX )`][@stdlib/blas/ext/base/gsumkbn2]: calculate the sum of strided array elements using a second-order iterative Kahan–Babuška algorithm. - [`gsumors( N, x, strideX )`][@stdlib/blas/ext/base/gsumors]: calculate the sum of strided array elements using ordinary recursive summation. - [`gsumpw( N, x, strideX )`][@stdlib/blas/ext/base/gsumpw]: calculate the sum of strided array elements using pairwise summation. +- [`ndarray`][@stdlib/blas/ext/base/ndarray]: base ndarray extended BLAS functions. - [`sapx( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sapx]: add a scalar constant to each element in a single-precision floating-point strided array. - [`sapxsum( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sapxsum]: add a scalar constant to each single-precision floating-point strided array element and compute the sum. - [`sapxsumkbn( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sapxsumkbn]: add a scalar constant to each single-precision floating-point strided array element and compute the sum using an improved Kahan–Babuška algorithm. @@ -158,6 +160,7 @@ var o = ns; - [`ssumors( N, x, strideX )`][@stdlib/blas/ext/base/ssumors]: calculate the sum of single-precision floating-point strided array elements using ordinary recursive summation. - [`ssumpw( N, x, strideX )`][@stdlib/blas/ext/base/ssumpw]: calculate the sum of single-precision floating-point strided array elements using pairwise summation. - [`wasm`][@stdlib/blas/ext/base/wasm]: extensions to basic linear algebra subprograms (BLAS) compiled to WebAssembly. +- [`zfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/zfill]: fill a double-precision complex floating-point strided array with a specified scalar constant.
@@ -208,6 +211,8 @@ console.log( objectKeys( ns ) ); +[@stdlib/blas/ext/base/cfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cfill + [@stdlib/blas/ext/base/dapx]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dapx [@stdlib/blas/ext/base/dapxsum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dapxsum @@ -364,6 +369,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/gsumpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gsumpw +[@stdlib/blas/ext/base/ndarray]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray + [@stdlib/blas/ext/base/sapx]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sapx [@stdlib/blas/ext/base/sapxsum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sapxsum @@ -438,6 +445,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/wasm]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/wasm +[@stdlib/blas/ext/base/zfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zfill + diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md index 0af6587b0d10..e5f885b33aa7 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md @@ -43,6 +43,17 @@ The namespace exposes the following APIs: +
+ +- [`dcusum( arrays )`][@stdlib/blas/ext/base/ndarray/dcusum]: compute the cumulative sum of a one-dimensional double-precision floating-point ndarray. +- [`dsum( arrays )`][@stdlib/blas/ext/base/ndarray/dsum]: compute the sum of all elements in a one-dimensional double-precision floating-point ndarray. +- [`gcusum( arrays )`][@stdlib/blas/ext/base/ndarray/gcusum]: compute the cumulative sum of a one-dimensional ndarray. +- [`gsum( arrays )`][@stdlib/blas/ext/base/ndarray/gsum]: compute the sum of all elements in a one-dimensional ndarray. +- [`scusum( arrays )`][@stdlib/blas/ext/base/ndarray/scusum]: compute the cumulative sum of a one-dimensional single-precision floating-point ndarray. +- [`ssum( arrays )`][@stdlib/blas/ext/base/ndarray/ssum]: compute the sum of all elements in a one-dimensional single-precision floating-point ndarray. + +
+ @@ -80,6 +91,22 @@ console.log( objectKeys( ns ) );
+ + +[@stdlib/blas/ext/base/ndarray/dcusum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dcusum + +[@stdlib/blas/ext/base/ndarray/dsum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dsum + +[@stdlib/blas/ext/base/ndarray/gcusum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gcusum + +[@stdlib/blas/ext/base/ndarray/gsum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gsum + +[@stdlib/blas/ext/base/ndarray/scusum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/scusum + +[@stdlib/blas/ext/base/ndarray/ssum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/ssum + + +
diff --git a/lib/node_modules/@stdlib/ndarray/base/assert/README.md b/lib/node_modules/@stdlib/ndarray/base/assert/README.md index e9780f927e6e..2bde98a10df8 100644 --- a/lib/node_modules/@stdlib/ndarray/base/assert/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/assert/README.md @@ -46,6 +46,7 @@ var o = ns; - [`hasEqualShape( x, y )`][@stdlib/ndarray/base/assert/has-equal-shape]: test if two ndarrays have the same shape. - [`isAllowedDataTypeCast( from, to, casting )`][@stdlib/ndarray/base/assert/is-allowed-data-type-cast]: determine whether an ndarray data type can be cast to another ndarray data type according to a specified casting mode. - [`isBooleanDataType( value )`][@stdlib/ndarray/base/assert/is-boolean-data-type]: test if an input value is a supported ndarray boolean data type. +- [`isBooleanIndexDataType( value )`][@stdlib/ndarray/base/assert/is-boolean-index-data-type]: test if an input value is a supported ndarray boolean index data type. - [`isBufferLengthCompatibleShape( len, shape )`][@stdlib/ndarray/base/assert/is-buffer-length-compatible-shape]: determine if a buffer length is compatible with an array shape. - [`isBufferLengthCompatible( len, shape, strides, offset )`][@stdlib/ndarray/base/assert/is-buffer-length-compatible]: determine if a buffer length is compatible with ndarray meta data. - [`isCastingMode( value )`][@stdlib/ndarray/base/assert/is-casting-mode]: test if an input value is a supported ndarray casting mode. @@ -56,8 +57,11 @@ var o = ns; - [`isContiguous( shape, strides, offset )`][@stdlib/ndarray/base/assert/is-contiguous]: determine if an array is contiguous. - [`isDataType( value )`][@stdlib/ndarray/base/assert/is-data-type]: test if an input value is a supported ndarray data type. - [`isFloatingPointDataType( value )`][@stdlib/ndarray/base/assert/is-floating-point-data-type]: test if an input value is a supported ndarray floating-point data type. +- [`isIndexDataType( value )`][@stdlib/ndarray/base/assert/is-index-data-type]: test if an input value is a supported ndarray index data type. - [`isIndexMode( value )`][@stdlib/ndarray/base/assert/is-index-mode]: test if an input value is a supported ndarray index mode. - [`isIntegerDataType( value )`][@stdlib/ndarray/base/assert/is-integer-data-type]: test if an input value is a supported ndarray integer data type. +- [`isIntegerIndexDataType( value )`][@stdlib/ndarray/base/assert/is-integer-index-data-type]: test if an input value is a supported ndarray integer index data type. +- [`isMaskIndexDataType( value )`][@stdlib/ndarray/base/assert/is-mask-index-data-type]: test if an input value is a supported ndarray mask index data type. - [`isMostlySafeDataTypeCast( from, to )`][@stdlib/ndarray/base/assert/is-mostly-safe-data-type-cast]: determine whether an ndarray data type can be safely cast or, for floating-point data types, downcast to another ndarray data type. - [`isNumericDataType( value )`][@stdlib/ndarray/base/assert/is-numeric-data-type]: test if an input value is a supported ndarray numeric data type. - [`isOrder( value )`][@stdlib/ndarray/base/assert/is-order]: test if an input value is an ndarray order. @@ -122,6 +126,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/assert/is-boolean-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-boolean-data-type +[@stdlib/ndarray/base/assert/is-boolean-index-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-boolean-index-data-type + [@stdlib/ndarray/base/assert/is-buffer-length-compatible-shape]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-buffer-length-compatible-shape [@stdlib/ndarray/base/assert/is-buffer-length-compatible]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-buffer-length-compatible @@ -142,10 +148,16 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/assert/is-floating-point-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-floating-point-data-type +[@stdlib/ndarray/base/assert/is-index-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-index-data-type + [@stdlib/ndarray/base/assert/is-index-mode]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-index-mode [@stdlib/ndarray/base/assert/is-integer-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-integer-data-type +[@stdlib/ndarray/base/assert/is-integer-index-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-integer-index-data-type + +[@stdlib/ndarray/base/assert/is-mask-index-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-mask-index-data-type + [@stdlib/ndarray/base/assert/is-mostly-safe-data-type-cast]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-mostly-safe-data-type-cast [@stdlib/ndarray/base/assert/is-numeric-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/is-numeric-data-type diff --git a/lib/node_modules/@stdlib/stats/base/README.md b/lib/node_modules/@stdlib/stats/base/README.md index 4034a6d79340..6533f3c8a450 100644 --- a/lib/node_modules/@stdlib/stats/base/README.md +++ b/lib/node_modules/@stdlib/stats/base/README.md @@ -72,7 +72,7 @@ The namespace contains the following statistical functions: - [`dnanmskrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/base/dnanmskrange]: calculate the range of a double-precision floating-point strided array according to a mask, ignoring `NaN` values. - [`dnanstdev( N, correction, x, stride )`][@stdlib/stats/base/dnanstdev]: calculate the standard deviation of a double-precision floating-point strided array ignoring `NaN` values. - [`dsem( N, correction, x, stride )`][@stdlib/stats/base/dsem]: calculate the standard error of the mean of a double-precision floating-point strided array. -- [`dsempn( N, correction, x, stride )`][@stdlib/stats/base/dsempn]: calculate the standard error of the mean of a double-precision floating-point strided array using a two-pass algorithm. +- [`dsempn( N, correction, x, strideX )`][@stdlib/stats/base/dsempn]: calculate the standard error of the mean of a double-precision floating-point strided array using a two-pass algorithm. - [`dstdev( N, correction, x, stride )`][@stdlib/stats/base/dstdev]: calculate the standard deviation of a double-precision floating-point strided array. - [`dvarm( N, mean, correction, x, stride )`][@stdlib/stats/base/dvarm]: calculate the variance of a double-precision floating-point strided array provided a known mean. - [`dvarmpn( N, mean, correction, x, stride )`][@stdlib/stats/base/dvarmpn]: calculate the variance of a double-precision floating-point strided array provided a known mean and using Neely's correction algorithm.