test: add tests for the main method

Author: kgryte

lib/node_modules/@stdlib/blas/base/daxpy-wasm/test/test.module.main.js

@@ -0,0 +1,325 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 node/no-sync */
+
+'use strict';
+
+// MODULES //
+
+var tape = require( 'tape' );
+var Memory = require( '@stdlib/wasm/memory' );
+var Float64Array = require( '@stdlib/array/float64' );
+var daxpy = require( './../lib' );
+
+
+// TESTS //
+
+tape( 'main export is an object', function test( t ) {
+	t.ok( true, __filename );
+	t.strictEqual( typeof daxpy, 'object', 'main export is an object' );
+	t.end();
+});
+
+tape( 'a module instance has a `main` method which has an arity of 6', function test( t ) {
+	var mem;
+	var mod;
+
+	mem = new Memory({
+		'initial': 0
+	});
+	mod = new daxpy.Module( mem );
+	t.strictEqual( mod.main.length, 6, 'returns expected value' );
+	t.end();
+});
+
+tape( 'a module instance has a `main` method which multiplies `x` by a constant and adds the result to `y`', function test( t ) {
+	var expected;
+	var actual;
+	var mem;
+	var mod;
+
+	mem = new Memory({
+		'initial': 1
+	});
+	mod = new daxpy.Module( mem );
+	mod.initializeSync();
+
+	mod.write( 0, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) );
+	mod.write( 40, new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ) );
+
+	expected = new Float64Array( [ 3.0, 5.0, 7.0, 9.0, 11.0 ] );
+
+	mod.main( 5, 2.0, 0, 1, 40, 1 );
+
+	actual = new Float64Array( 5 );
+	mod.read( 40, actual );
+	t.deepEqual( actual, expected, 'returns expected value' );
+
+	// Short datasets:
+	mod.write( 0, new Float64Array( [ 1.0, 2.0 ] ) );
+	mod.write( 16, new Float64Array( [ 1.0, 1.0 ] ) );
+
+	expected = new Float64Array( [ 3.0, 5.0 ] );
+
+	mod.main( 2, 2.0, 0, 1, 16, 1 );
+
+	actual = new Float64Array( 2 );
+	mod.read( 16, actual );
+	t.deepEqual( actual, expected, 'returns expected value' );
+
+	t.end();
+});
+
+tape( 'a module instance has a `main` method which efficiently handles the case where `alpha` is `0`', function test( t ) {
+	var expected;
+	var actual;
+	var mem;
+	var mod;
+
+	mem = new Memory({
+		'initial': 1
+	});
+	mod = new daxpy.Module( mem );
+	mod.initializeSync();
+
+	mod.write( 0, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) );
+	mod.write( 40, new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ) );
+
+	expected = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] );
+
+	mod.main( 5, 0.0, 0, 1, 40, 1 );
+
+	actual = new Float64Array( 5 );
+	mod.read( 40, actual );
+	t.deepEqual( actual, expected, 'returns expected value' );
+
+	t.end();
+});
+
+tape( 'a module instance has a `main` method which supports an `x` stride', function test( t ) {
+	var expected;
+	var actual;
+	var mem;
+	var mod;
+	var N;
+
+	mem = new Memory({
+		'initial': 1
+	});
+	mod = new daxpy.Module( mem );
+	mod.initializeSync();
+
+	mod.write( 0, new Float64Array([
+		1.0, // 0
+		2.0,
+		3.0, // 1
+		4.0,
+		5.0  // 2
+	]));
+	mod.write( 40, new Float64Array([
+		1.0, // 0
+		1.0, // 1
+		1.0, // 2
+		1.0,
+		1.0
+	]));
+	N = 3;
+
+	mod.main( N, 2.0, 0, 2, 40, 1 );
+
+	expected = new Float64Array( [ 3.0, 7.0, 11.0, 1.0, 1.0 ] );
+
+	actual = new Float64Array( 5 );
+	mod.read( 40, actual );
+	t.deepEqual( actual, expected, 'returns expected value' );
+
+	t.end();
+});
+
+tape( 'a module instance has a `main` method which supports a `y` stride', function test( t ) {
+	var expected;
+	var actual;
+	var mem;
+	var mod;
+	var N;
+
+	mem = new Memory({
+		'initial': 1
+	});
+	mod = new daxpy.Module( mem );
+	mod.initializeSync();
+
+	mod.write( 0, new Float64Array([
+		1.0, // 0
+		2.0, // 1
+		3.0, // 2
+		4.0,
+		5.0
+	]));
+	mod.write( 40, new Float64Array([
+		1.0, // 0
+		1.0,
+		1.0, // 1
+		1.0,
+		1.0  // 2
+	]));
+	N = 3;
+
+	mod.main( N, 2.0, 0, 1, 40, 2 );
+
+	expected = new Float64Array( [ 3.0, 1.0, 5.0, 1.0, 7.0 ] );
+
+	actual = new Float64Array( 5 );
+	mod.read( 40, actual );
+	t.deepEqual( actual, expected, 'returns expected value' );
+
+	t.end();
+});
+
+tape( 'a module instance has a `main` method which returns a pointer to the output array', function test( t ) {
+	var out;
+	var mem;
+	var mod;
+
+	mem = new Memory({
+		'initial': 1
+	});
+	mod = new daxpy.Module( mem );
+	mod.initializeSync();
+
+	mod.write( 0, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) );
+	mod.write( 40, new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ) );
+
+	out = mod.main( 5, 3.0, 0, 1, 40, 1 );
+
+	t.strictEqual( out, 40, 'returns expected value' );
+	t.end();
+});
+
+tape( 'if provided an `N` parameter less than or equal to `0`, a module instance has a `main` method which leaves the output array unchanged', function test( t ) {
+	var expected;
+	var actual;
+	var mem;
+	var mod;
+
+	mem = new Memory({
+		'initial': 1
+	});
+	mod = new daxpy.Module( mem );
+	mod.initializeSync();
+
+	mod.write( 0, new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ) );
+	mod.write( 40, new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ) );
+
+	expected = new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] );
+
+	mod.main( -1, 3.0, 0, 1, 40, 1 );
+	actual = new Float64Array( 5 );
+	mod.read( 40, actual );
+	t.deepEqual( actual, expected, 'returns expected value' );
+
+	mod.main( 0, 3.0, 0, 1, 40, 1 );
+	actual = new Float64Array( 5 );
+	mod.read( 40, actual );
+	t.deepEqual( actual, expected, 'returns expected value' );
+
+	t.end();
+});
+
+tape( 'a module instance has a `main` method which supports negative strides', function test( t ) {
+	var expected;
+	var actual;
+	var mem;
+	var mod;
+	var N;
+
+	mem = new Memory({
+		'initial': 1
+	});
+	mod = new daxpy.Module( mem );
+	mod.initializeSync();
+
+	mod.write( 0, new Float64Array([
+		1.0, // 2
+		2.0,
+		3.0, // 1
+		4.0,
+		5.0  // 0
+	]));
+	mod.write( 40, new Float64Array([
+		6.0, // 2
+		7.0, // 1
+		8.0, // 0
+		9.0,
+		10.0
+	]));
+	N = 3;
+
+	mod.main( N, 3.0, 0, -2, 40, -1 );
+
+	expected = new Float64Array( [ 9.0, 16.0, 23.0, 9.0, 10.0 ] );
+
+	actual = new Float64Array( 5 );
+	mod.read( 40, actual );
+	t.deepEqual( actual, expected, 'returns expected value' );
+
+	t.end();
+});
+
+tape( 'a module instance has a `main` method which supports complex access patterns', function test( t ) {
+	var expected;
+	var actual;
+	var mem;
+	var mod;
+	var N;
+
+	mem = new Memory({
+		'initial': 1
+	});
+	mod = new daxpy.Module( mem );
+	mod.initializeSync();
+
+	mod.write( 0, new Float64Array([
+		1.0, // 0
+		2.0,
+		3.0, // 1
+		4.0,
+		5.0, // 2
+		6.0
+	]));
+	mod.write( 48, new Float64Array([
+		7.0,  // 2
+		8.0,  // 1
+		9.0,  // 0
+		10.0,
+		11.0,
+		12.0
+	]));
+	N = 3;
+
+	mod.main( N, 3.0, 0, 2, 48, -1 );
+
+	expected = new Float64Array( [ 22.0, 17.0, 12.0, 10.0, 11.0, 12.0 ] );
+
+	actual = new Float64Array( 6 );
+	mod.read( 48, actual );
+	t.deepEqual( actual, expected, 'returns expected value' );
+
+	t.end();
+});