diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/README.md new file mode 100644 index 000000000000..3d3323c7f114 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/README.md @@ -0,0 +1,146 @@ + + +# saxpby + +> Multiply a one-dimensional single-precision floating-point ndarray by a scalar constant and add the result to a second one-dimensional single-precision floating-point ndarray multiplied by a scalar constant. + +
+ +This BLAS extension implements the operation + + + +```math +\mathbf{y} = \alpha \mathbf{x} + \beta \mathbf{y} +``` + + + +
+ + + +
+ +## Usage + +```javascript +var saxpby = require( '@stdlib/blas/ext/base/ndarray/saxpby' ); +``` + +#### saxpby( arrays ) + +Multiplies a one-dimensional single-precision floating-point ndarray by a scalar constant and adds the result to a second one-dimensional single-precision floating-point ndarray multiplied by a scalar constant. + +```javascript +var Float32Vector = require( '@stdlib/ndarray/vector/float32' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + +var x = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +var y = new Float32Vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + +var alpha = scalar2ndarray( 5.0, { + 'dtype': 'float32' +}); + +var beta = scalar2ndarray( 2.0, { + 'dtype': 'float32' +}); + +saxpby( [ x, y, alpha, beta ] ); +// y => [ 9.0, 16.0, 23.0, 30.0, 37.0 ] +``` + +The function has the following parameters: + +- **arrays**: array-like object containing the following ndarrays: + + - a one-dimensional input ndarray. + - a one-dimensional output ndarray. + - a zero-dimensional ndarray containing the constant by which to multiply the input ndarray. + - a zero-dimensional ndarray containing the constant by which to multiply the output ndarray. + +
+ + + +
+ +## Notes + +- The output ndarray is modified **in-place** (i.e., the output ndarray is **mutated**). + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/discrete-uniform' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var ndarraylike2scalar = require( '@stdlib/ndarray/ndarraylike2scalar' ); +var saxpby = require( '@stdlib/blas/ext/base/ndarray/saxpby' ); + +var opts = { + 'dtype': 'float32' +}; + +var x = discreteUniform( [ 10 ], -100, 100, opts ); +console.log( ndarray2array( x ) ); + +var y = discreteUniform( [ 10 ], -100, 100, opts ); +console.log( ndarray2array( y ) ); + +var alpha = scalar2ndarray( 5.0, opts ); +console.log( 'Alpha: %d', ndarraylike2scalar( alpha ) ); + +var beta = scalar2ndarray( 2.0, opts ); +console.log( 'Beta: %d', ndarraylike2scalar( beta ) ); + +saxpby( [ x, y, alpha, beta ] ); +console.log( ndarray2array( y ) ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/benchmark/benchmark.js new file mode 100644 index 000000000000..440e89f09d6c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/benchmark/benchmark.js @@ -0,0 +1,111 @@ +/** +* @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 scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var saxpby = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - ndarray length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var alpha; + var beta; + var x; + var y; + + x = uniform( [ len ], -100.0, 100.0, options ); + y = uniform( [ len ], -100.0, 100.0, options ); + alpha = scalar2ndarray( 5.0, options ); + beta = scalar2ndarray( 2.0, options ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var out; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = saxpby( [ x, y, alpha, beta ] ); + if ( typeof out !== 'object' ) { + b.fail( 'should return an ndarray' ); + } + } + b.toc(); + if ( typeof out !== 'object' ) { + b.fail( 'should return an ndarray' ); + } + 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(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/docs/repl.txt new file mode 100644 index 000000000000..a55bb6de2827 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/docs/repl.txt @@ -0,0 +1,41 @@ + +{{alias}}( arrays ) + Multiplies a one-dimensional single-precision floating-point ndarray by a + scalar constant and adds the result to a second one-dimensional single- + precision floating-point ndarray multiplied by a scalar constant. + + The output ndarray is modified *in-place* (i.e., the output ndarray is + *mutated*). + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing the following ndarrays: + + - a one-dimensional input ndarray. + - a one-dimensional output ndarray. + - a zero-dimensional ndarray containing the constant by which to + multiply the input ndarray. + - a zero-dimensional ndarray containing the constant by which to + multiply the output ndarray. + + Returns + ------- + out: ndarray + Output ndarray. + + Examples + -------- + > var xbuf = [ 1.0, 2.0, 3.0, 4.0 ]; + > var x = new {{alias:@stdlib/ndarray/vector/float32}}( xbuf ); + > var ybuf = [ 2.0, 3.0, 4.0, 5.0 ]; + > var y = new {{alias:@stdlib/ndarray/vector/float32}}( ybuf ); + > var opts = { 'dtype': 'float32' }; + > var alpha = {{alias:@stdlib/ndarray/from-scalar}}( 5.0, opts ); + > var beta = {{alias:@stdlib/ndarray/from-scalar}}( 2.0, opts ); + > {{alias}}( [ x, y, alpha, beta ] ) + [ 9.0, 16.0, 23.0, 30.0 ] + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/docs/types/index.d.ts new file mode 100644 index 000000000000..30f0b6f4d54c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/docs/types/index.d.ts @@ -0,0 +1,63 @@ +/* +* @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 + +/// + +import { float32ndarray, typedndarray } from '@stdlib/types/ndarray'; + +/** +* Multiplies a one-dimensional single-precision floating-point ndarray by a scalar constant and adds the result to a second one-dimensional single-precision floating-point ndarray multiplied by a scalar constant. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - a one-dimensional input ndarray. +* - a one-dimensional output ndarray. +* - a zero-dimensional ndarray containing the scalar constant by which to multiply the input ndarray. +* - a zero-dimensional ndarray containing the scalar constant by which to multiply the output ndarray. +* +* @param arrays - array-like object containing ndarrays +* @returns output ndarray +* +* @example +* var Float32Vector = require( '@stdlib/ndarray/vector/float32' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* +* var x = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float32Vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* var alpha = scalar2ndarray( 5.0, { +* 'dtype': 'float32' +* }); +* +* var beta = scalar2ndarray( 2.0, { +* 'dtype': 'float32' +* }); +* +* var out = saxpby( [ x, y, alpha, beta ] ); +* // returns [ 9.0, 16.0, 23.0, 30.0, 37.0 ] +*/ +declare function saxpby( arrays: [ float32ndarray, float32ndarray, typedndarray, typedndarray ] ): float32ndarray; + + +// EXPORTS // + +export = saxpby; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/docs/types/test.ts new file mode 100644 index 000000000000..fe28e8edd8fd --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/docs/types/test.ts @@ -0,0 +1,76 @@ +/* +* @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 scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +import saxpby = require( './index' ); + + +// TESTS // + +// The function returns an ndarray... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float32' + }); + const y = zeros( [ 10 ], { + 'dtype': 'float32' + }); + const alpha = scalar2ndarray( 5.0, { + 'dtype': 'float32' + }); + const beta = scalar2ndarray( 2.0, { + 'dtype': 'float32' + }); + + saxpby( [ x, y, alpha, beta ] ); // $ExpectType float32ndarray +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + saxpby( '10' ); // $ExpectError + saxpby( 5 ); // $ExpectError + saxpby( true ); // $ExpectError + saxpby( false ); // $ExpectError + saxpby( null ); // $ExpectError + saxpby( undefined ); // $ExpectError + saxpby( [] ); // $ExpectError + saxpby( {} ); // $ExpectError + saxpby( ( 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' + }); + const y = zeros( [ 10 ], { + 'dtype': 'float32' + }); + const alpha = scalar2ndarray( 5.0, { + 'dtype': 'float32' + }); + const beta = scalar2ndarray( 2.0, { + 'dtype': 'float32' + }); + + saxpby(); // $ExpectError + saxpby( [ x, y, alpha, beta ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/examples/index.js new file mode 100644 index 000000000000..f2b8bfd406b7 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/examples/index.js @@ -0,0 +1,44 @@ +/** +* @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 scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var ndarraylike2scalar = require( '@stdlib/ndarray/ndarraylike2scalar' ); +var saxpby = require( './../lib' ); + +var opts = { + 'dtype': 'float32' +}; + +var x = discreteUniform( [ 10 ], -100, 100, opts ); +console.log( ndarray2array( x ) ); + +var y = discreteUniform( [ 10 ], -100, 100, opts ); +console.log( ndarray2array( y ) ); + +var alpha = scalar2ndarray( 5.0, opts ); +console.log( 'Alpha: %d', ndarraylike2scalar( alpha ) ); + +var beta = scalar2ndarray( 2.0, opts ); +console.log( 'Beta: %d', ndarraylike2scalar( beta ) ); + +saxpby( [ x, y, alpha, beta ] ); +console.log( ndarray2array( y ) ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/lib/index.js new file mode 100644 index 000000000000..1db420e2de16 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/lib/index.js @@ -0,0 +1,53 @@ +/** +* @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'; + +/** +* Multiply a single-precision floating-point ndarray by a scalar constant and add the result to a second single-precision floating-point ndarray multiplied by a scalar constant. +* +* @module @stdlib/blas/ext/base/ndarray/saxpby +* +* @example +* var Float32Vector = require( '@stdlib/ndarray/vector/float32' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* var saxpby = require( '@stdlib/blas/ext/base/ndarray/saxpby' ); +* +* var x = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float32Vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* var alpha = scalar2ndarray( 5.0, { +* 'dtype': 'float32' +* }); +* +* var beta = scalar2ndarray( 2.0, { +* 'dtype': 'float32' +* }); +* +* var out = saxpby( [ x, y, alpha, beta ] ); +* // returns [ 9.0, 16.0, 23.0, 30.0, 37.0 ] +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/lib/main.js new file mode 100644 index 000000000000..51ae5a5522b2 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/lib/main.js @@ -0,0 +1,83 @@ +/** +* @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 numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); +var getStride = require( '@stdlib/ndarray/base/stride' ); +var getOffset = require( '@stdlib/ndarray/base/offset' ); +var getData = require( '@stdlib/ndarray/base/data-buffer' ); +var strided = require( '@stdlib/blas/ext/base/saxpby' ).ndarray; +var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' ); + + +// MAIN // + +/** +* Multiplies a single-precision floating-point ndarray by a scalar constant and adds the result to a second single-precision floating-point ndarray multiplied by a scalar constant. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - a one-dimensional input ndarray. +* - a one-dimensional output ndarray. +* - a zero-dimensional ndarray containing the constant by which to multiply the input ndarray. +* - a zero-dimensional ndarray containing the constant by which to multiply the output ndarray. +* +* @param {ArrayLikeObject} arrays - array-like object containing ndarrays +* @returns {ndarray} output ndarray +* +* @example +* var Float32Vector = require( '@stdlib/ndarray/vector/float32' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* +* var x = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* var y = new Float32Vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* var alpha = scalar2ndarray( 5.0, { +* 'dtype': 'float32' +* }); +* +* var beta = scalar2ndarray( 2.0, { +* 'dtype': 'float32' +* }); +* +* var out = saxpby( [ x, y, alpha, beta ] ); +* // returns [ 9.0, 16.0, 23.0, 30.0, 37.0 ] +*/ +function saxpby( arrays ) { + var alpha; + var beta; + var x; + var y; + + x = arrays[ 0 ]; + y = arrays[ 1 ]; + alpha = ndarraylike2scalar( arrays[ 2 ] ); + beta = ndarraylike2scalar( arrays[ 3 ] ); + strided( numelDimension( x, 0 ), alpha, getData( x ), getStride( x, 0 ), getOffset( x ), beta, getData( y ), getStride( y, 0 ), getOffset( y ) ); // eslint-disable-line max-len + return y; +} + + +// EXPORTS // + +module.exports = saxpby; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/package.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/package.json new file mode 100644 index 000000000000..2e41b201452c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/package.json @@ -0,0 +1,75 @@ +{ + "name": "@stdlib/blas/ext/base/ndarray/saxpby", + "version": "0.0.0", + "description": "Multiply a single-precision floating-point ndarray by a scalar constant and add the result to a second single-precision floating-point ndarray multiplied by a scalar constant.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "blas", + "extended", + "ext", + "saxpby", + "axpby", + "multiply", + "add", + "scalar", + "constant", + "linear", + "combination", + "strided", + "array", + "ndarray", + "float32", + "single", + "single-precision" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/test/test.js new file mode 100644 index 000000000000..a091f9051494 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpby/test/test.js @@ -0,0 +1,275 @@ +/** +* @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 tape = require( 'tape' ); +var Float32Array = require( '@stdlib/array/float32' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var saxpby = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Returns a one-dimensional ndarray. +* +* @private +* @param {Float32Array} buffer - underlying data buffer +* @param {NonNegativeInteger} length - number of indexed elements +* @param {integer} stride - stride length +* @param {NonNegativeInteger} offset - index offset +* @returns {ndarray} one-dimensional ndarray +*/ +function vector( buffer, length, stride, offset ) { + return new ndarray( 'float32', buffer, [ length ], [ stride ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof saxpby, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( saxpby.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function multiplies `x` by a constant and adds the result to `y` multiplied by a constant', function test( t ) { + var expected; + var actual; + var alpha; + var beta; + var xbuf; + var ybuf; + var x; + var y; + + xbuf = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0 ] ); + ybuf = new Float32Array( [ 1.0, 2.0, -3.0, 4.0, -1.0 ] ); + x = vector( xbuf, 5, 1, 0 ); + y = vector( ybuf, 5, 1, 0 ); + alpha = scalar2ndarray( 5.0, { + 'dtype': 'float32' + }); + beta = scalar2ndarray( 3.0, { + 'dtype': 'float32' + }); + expected = new Float32Array([ + -7.0, // 5.0*(-2.0) + 3.0*1.0 + 11.0, // 5.0*1.0 + 3.0*2.0 + 6.0, // 5.0*3.0 + 3.0*(-3.0) + -13.0, // 5.0*(-5.0) + 3.0*4.0 + 17.0 // 5.0*4.0 + 3.0*(-1.0) + ]); + + actual = saxpby( [ x, y, alpha, beta ] ); + t.strictEqual( actual, y, 'returns expected value' ); + t.deepEqual( ybuf, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports input ndarrays having non-unit strides', function test( t ) { + var expected; + var actual; + var alpha; + var beta; + var xbuf; + var ybuf; + var x; + var y; + + xbuf = new Float32Array([ + -2.0, // 0 + 1.0, + 3.0, // 1 + -5.0, + 4.0, // 2 + 0.0, + -1.0, // 3 + -3.0 + ]); + ybuf = new Float32Array([ + 1.0, // 0 + 2.0, + -3.0, // 1 + 4.0, + -1.0, // 2 + 0.0, + 3.0, // 3 + 2.0 + ]); + x = vector( xbuf, 4, 2, 0 ); + y = vector( ybuf, 4, 2, 0 ); + alpha = scalar2ndarray( 5.0, { + 'dtype': 'float32' + }); + beta = scalar2ndarray( 3.0, { + 'dtype': 'float32' + }); + expected = new Float32Array([ + -7.0, // 5.0*(-2.0) + 3.0*1.0 + 2.0, + 6.0, // 5.0*3.0 + 3.0*(-3.0) + 4.0, + 17.0, // 5.0*4.0 + 3.0*(-1.0) + 0.0, + 4.0, // 5.0*(-1.0) + 3.0*3.0 + 2.0 + ]); + + actual = saxpby( [ x, y, alpha, beta ] ); + t.strictEqual( actual, y, 'returns expected value' ); + t.deepEqual( ybuf, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports input ndarrays having negative strides', function test( t ) { + var expected; + var actual; + var alpha; + var beta; + var xbuf; + var ybuf; + var x; + var y; + + xbuf = new Float32Array([ + -2.0, // 4 + 1.0, // 3 + 3.0, // 2 + -5.0, // 1 + 4.0 // 0 + ]); + ybuf = new Float32Array([ + 1.0, // 4 + 2.0, // 3 + -3.0, // 2 + 4.0, // 1 + -1.0 // 0 + ]); + x = vector( xbuf, 5, -1, 4 ); + y = vector( ybuf, 5, -1, 4 ); + alpha = scalar2ndarray( 5.0, { + 'dtype': 'float32' + }); + beta = scalar2ndarray( 3.0, { + 'dtype': 'float32' + }); + expected = new Float32Array([ + -7.0, // 5.0*(-2.0) + 3.0*1.0 + 11.0, // 5.0*1.0 + 3.0*2.0 + 6.0, // 5.0*3.0 + 3.0*(-3.0) + -13.0, // 5.0*(-5.0) + 3.0*4.0 + 17.0 // 5.0*4.0 + 3.0*(-1.0) + ]); + + actual = saxpby( [ x, y, alpha, beta ] ); + t.strictEqual( actual, y, 'returns expected value' ); + t.deepEqual( ybuf, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports input ndarrays having non-zero offsets', function test( t ) { + var expected; + var actual; + var alpha; + var beta; + var xbuf; + var ybuf; + var x; + var y; + + xbuf = new Float32Array([ + 1.0, + -2.0, + 3.0, // 0 + -5.0, // 1 + 4.0, // 2 + 0.0 + ]); + ybuf = new Float32Array([ + 1.0, + -2.0, + 0.0, // 0 + 4.0, // 1 + -1.0, // 2 + 0.0 + ]); + x = vector( xbuf, 3, 1, 2 ); + y = vector( ybuf, 3, 1, 2 ); + alpha = scalar2ndarray( 5.0, { + 'dtype': 'float32' + }); + beta = scalar2ndarray( 3.0, { + 'dtype': 'float32' + }); + expected = new Float32Array([ + 1.0, + -2.0, + 15.0, // 5.0*3.0 + 3.0*0.0 + -13.0, // 5.0*(-5.0) + 3.0*4.0 + 17.0, // 5.0*4.0 + 3.0*(-1.0) + 0.0 + ]); + + actual = saxpby( [ x, y, alpha, beta ] ); + t.strictEqual( actual, y, 'returns expected value' ); + t.deepEqual( ybuf, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the output ndarray unchanged when the input ndarrays are empty', function test( t ) { + var expected; + var actual; + var alpha; + var beta; + var xbuf; + var ybuf; + var x; + var y; + + xbuf = new Float32Array( [] ); + ybuf = new Float32Array( [] ); + x = vector( xbuf, 0, 1, 0 ); + y = vector( ybuf, 0, 1, 0 ); + alpha = scalar2ndarray( 5.0, { + 'dtype': 'float32' + }); + beta = scalar2ndarray( 3.0, { + 'dtype': 'float32' + }); + expected = new Float32Array( [] ); + + actual = saxpby( [ x, y, alpha, beta ] ); + t.strictEqual( actual, y, 'returns expected value' ); + t.deepEqual( ybuf, expected, 'returns expected value' ); + + t.end(); +});