feat: add blas/ext/base/ndarray/dssumpw

lib/node_modules/@stdlib/blas/ext/base/ndarray/dssumpw/README.md

@@ -0,0 +1,123 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2026 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# dssumpw
+
+> Compute the sum of all elements in a one-dimensional single-precision floating-point ndarray using pairwise summation with extended accumulation and returning an extended precision result.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var dssumpw = require( '@stdlib/blas/ext/base/ndarray/dssumpw' );
+```
+
+#### dssumpw( arrays )
+
+Computes the sum of all elements in a one-dimensional single-precision floating-point ndarray using pairwise summation with extended accumulation and returning an extended precision result.
+
+```javascript
+var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
+
+var x = new Float32Vector( [ 1.0, 3.0, 4.0, 2.0 ] );
+
+var v = dssumpw( [ x ] );
+// returns 10.0
+```
+
+The function has the following parameters:
+
+-   **arrays**: array-like object containing a one-dimensional input ndarray.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   If provided an empty one-dimensional ndarray, the function returns `0.0`.
+-   In general, pairwise summation is more numerically stable than ordinary recursive summation (i.e., "simple" summation), with slightly worse performance. While not the most numerically stable summation technique (e.g., compensated summation techniques such as the Kahan–Babuška-Neumaier algorithm are generally more numerically stable), pairwise summation strikes a reasonable balance between numerical stability and performance. If either numerical stability or performance is more desirable for your use case, consider alternative summation techniques.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/discrete-uniform' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var dssumpw = require( '@stdlib/blas/ext/base/ndarray/dssumpw' );
+
+var opts = {
+    'dtype': 'float32'
+};
+
+var x = discreteUniform( [ 10 ], -50, 50, opts );
+console.log( ndarray2array( x ) );
+
+var v = dssumpw( [ x ] );
+console.log( v );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<section class="references">
+
+## References
+
+-   Higham, Nicholas J. 1993. "The Accuracy of Floating Point Summation." _SIAM Journal on Scientific Computing_ 14 (4): 783–99. doi:[10.1137/0914050][@higham:1993a].
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[@higham:1993a]: https://doi.org/10.1137/0914050
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/blas/ext/base/ndarray/dssumpw/benchmark/benchmark.js

@@ -0,0 +1,103 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/uniform' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var dssumpw = require( './../lib' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'float32'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var x = uniform( [ len ], -10.0, 10.0, options );
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var v;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			v = dssumpw( [ x ] );
+			if ( isnanf( v ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnanf( v ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( format( '%s:len=%d', pkg, len ), f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/blas/ext/base/ndarray/dssumpw/docs/repl.txt

@@ -0,0 +1,27 @@
+
+{{alias}}( arrays )
+    Computes the sum of all elements in a one-dimensional single-precision
+    floating-point ndarray using pairwise summation with extended accumulation
+    and returning an extended precision result.
+
+    If provided an empty ndarray, the function returns `0.0`.
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject<ndarray>
+        Array-like object containing a one-dimensional input ndarray.
+
+    Returns
+    -------
+    out: number
+        Sum.
+
+    Examples
+    --------
+    > var x = new {{alias:@stdlib/ndarray/vector/float32}}( [ 1.0, 2.0, 3.0 ] );
+    > {{alias}}( [ x ] )
+    6.0
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/blas/ext/base/ndarray/dssumpw/docs/types/index.d.ts

@@ -0,0 +1,50 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2026 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { float32ndarray } from '@stdlib/types/ndarray';
+
+/**
+* Computes the sum of all elements in a one-dimensional single-precision floating-point ndarray using pairwise summation with extended accumulation and returning an extended precision result.
+*
+* ## Notes
+*
+* -   The function expects the following ndarrays:
+*
+*     -   a one-dimensional input ndarray.
+*
+* @param arrays - array-like object containing ndarrays
+* @returns sum
+*
+* @example
+* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
+*
+* var x = new Float32Vector( [ 1.0, 3.0, 4.0, 2.0 ] );
+*
+* var v = dssumpw( [ x ] );
+* // returns 10.0
+*/
+declare function dssumpw( arrays: [ float32ndarray ] ): number;
+
+
+// EXPORTS //
+
+export = dssumpw;

lib/node_modules/@stdlib/blas/ext/base/ndarray/dssumpw/docs/types/test.ts

@@ -0,0 +1,57 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2026 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+/* eslint-disable space-in-parens */
+
+import zeros = require( '@stdlib/ndarray/zeros' );
+import dssumpw = require( './index' );
+
+
+// TESTS //
+
+// The function returns a number...
+{
+	const x = zeros( [ 10 ], {
+		'dtype': 'float32'
+	});
+
+	dssumpw( [ x ] ); // $ExpectType number
+}
+
+// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays...
+{
+	dssumpw( '10' ); // $ExpectError
+	dssumpw( 10 ); // $ExpectError
+	dssumpw( true ); // $ExpectError
+	dssumpw( false ); // $ExpectError
+	dssumpw( null ); // $ExpectError
+	dssumpw( undefined ); // $ExpectError
+	dssumpw( [] ); // $ExpectError
+	dssumpw( {} ); // $ExpectError
+	dssumpw( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	const x = zeros( [ 10 ], {
+		'dtype': 'float32'
+	});
+
+	dssumpw(); // $ExpectError
+	dssumpw( [ x ], {} ); // $ExpectError
+}

lib/node_modules/@stdlib/blas/ext/base/ndarray/dssumpw/examples/index.js

@@ -0,0 +1,33 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+var discreteUniform = require( '@stdlib/random/discrete-uniform' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var dssumpw = require( './../lib' );
+
+var opts = {
+	'dtype': 'float32'
+};
+
+var x = discreteUniform( [ 10 ], -50, 50, opts );
+console.log( ndarray2array( x ) );
+
+var v = dssumpw( [ x ] );
+console.log( v );