@stdlib/blas-base-wasm-ddot 0.1.0

package/lib/module.js

@@ -0,0 +1,218 @@
+/**
+* @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 no-restricted-syntax, no-invalid-this */
+
+'use strict';
+
+// MODULES //
+
+var isWebAssemblyMemory = require( '@stdlib/assert-is-wasm-memory' );
+var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
+var inherits = require( '@stdlib/utils-inherit' );
+var WasmModule = require( '@stdlib/wasm-module-wrapper' );
+var format = require( '@stdlib/string-format' );
+var wasmBinary = require( './binary.js' );
+
+
+// MAIN //
+
+/**
+* BLAS routine WebAssembly module wrapper constructor.
+*
+* @constructor
+* @param {Object} memory - WebAssembly memory instance
+* @throws {TypeError} must provide a WebAssembly memory instance
+* @returns {Module} module instance
+*
+* @example
+* var Memory = require( '@stdlib/wasm-memory' );
+* var oneTo = require( '@stdlib/array-one-to' );
+* var ones = require( '@stdlib/array-ones' );
+* var zeros = require( '@stdlib/array-zeros' );
+* var bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' );
+*
+* // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):
+* var mem = new Memory({
+*     'initial': 10,
+*     'maximum': 100
+* });
+*
+* // Create a BLAS routine:
+* var ddot = new Module( mem );
+* // returns <Module>
+*
+* // Initialize the routine:
+* ddot.initializeSync();
+*
+* // Define a vector data type:
+* var dtype = 'float64';
+*
+* // Specify a vector length:
+* var N = 5;
+*
+* // Define pointers (i.e., byte offsets) for storing two vectors:
+* var xptr = 0;
+* var yptr = N * bytesPerElement( dtype );
+*
+* // Write vector values to module memory:
+* ddot.write( xptr, oneTo( N, dtype ) );
+* ddot.write( yptr, ones( N, dtype ) );
+*
+* // Perform computation:
+* var dot = ddot.main( N, xptr, 1, yptr, 1 );
+* // returns 15.0
+*/
+function Module( memory ) {
+	if ( !( this instanceof Module ) ) {
+		return new Module( memory );
+	}
+	if ( !isWebAssemblyMemory( memory ) ) {
+		throw new TypeError( format( 'invalid argument. Must provide a WebAssembly memory instance. Value: `%s`.', memory ) );
+	}
+	// Call the parent constructor:
+	WasmModule.call( this, wasmBinary, memory, {
+		'env': {
+			'memory': memory
+		}
+	});
+
+	return this;
+}
+
+// Inherit from the parent constructor:
+inherits( Module, WasmModule );
+
+/**
+* Computes the dot product of `x` and `y`.
+*
+* @name main
+* @memberof Module.prototype
+* @readonly
+* @type {Function}
+* @param {PositiveInteger} N - number of indexed elements
+* @param {NonNegativeInteger} xptr - first input array pointer (i.e., byte offset)
+* @param {integer} strideX - `x` stride length
+* @param {NonNegativeInteger} yptr - second input array pointer (i.e., byte offset)
+* @param {integer} strideY - `y` stride length
+* @returns {number} dot product
+*
+* @example
+* var Memory = require( '@stdlib/wasm-memory' );
+* var oneTo = require( '@stdlib/array-one-to' );
+* var ones = require( '@stdlib/array-ones' );
+* var zeros = require( '@stdlib/array-zeros' );
+* var bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' );
+*
+* // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):
+* var mem = new Memory({
+*     'initial': 10,
+*     'maximum': 100
+* });
+*
+* // Create a BLAS routine:
+* var ddot = new Module( mem );
+* // returns <Module>
+*
+* // Initialize the routine:
+* ddot.initializeSync();
+*
+* // Define a vector data type:
+* var dtype = 'float64';
+*
+* // Specify a vector length:
+* var N = 5;
+*
+* // Define pointers (i.e., byte offsets) for storing two vectors:
+* var xptr = 0;
+* var yptr = N * bytesPerElement( dtype );
+*
+* // Write vector values to module memory:
+* ddot.write( xptr, oneTo( N, dtype ) );
+* ddot.write( yptr, ones( N, dtype ) );
+*
+* // Perform computation:
+* var dot = ddot.main( N, xptr, 1, yptr, 1 );
+* // returns 15.0
+*/
+setReadOnly( Module.prototype, 'main', function ddot( N, xptr, strideX, yptr, strideY ) {
+	return this._instance.exports.c_ddot( N, xptr, strideX, yptr, strideY );
+});
+
+/**
+* Computes the dot product of `x` and `y` using alternative indexing semantics.
+*
+* @name ndarray
+* @memberof Module.prototype
+* @readonly
+* @type {Function}
+* @param {PositiveInteger} N - number of indexed elements
+* @param {NonNegativeInteger} xptr - first input array pointer (i.e., byte offset)
+* @param {integer} strideX - `x` stride length
+* @param {NonNegativeInteger} offsetX - starting `x` index
+* @param {NonNegativeInteger} yptr - second input array pointer (i.e., byte offset)
+* @param {integer} strideY - `y` stride length
+* @param {NonNegativeInteger} offsetY - starting `y` index
+* @returns {number} dot product
+*
+* @example
+* var Memory = require( '@stdlib/wasm-memory' );
+* var oneTo = require( '@stdlib/array-one-to' );
+* var ones = require( '@stdlib/array-ones' );
+* var zeros = require( '@stdlib/array-zeros' );
+* var bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' );
+*
+* // Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):
+* var mem = new Memory({
+*     'initial': 10,
+*     'maximum': 100
+* });
+*
+* // Create a BLAS routine:
+* var ddot = new Module( mem );
+* // returns <Module>
+*
+* // Initialize the routine:
+* ddot.initializeSync();
+*
+* // Define a vector data type:
+* var dtype = 'float64';
+*
+* // Specify a vector length:
+* var N = 5;
+*
+* // Define pointers (i.e., byte offsets) for storing two vectors:
+* var xptr = 0;
+* var yptr = N * bytesPerElement( dtype );
+*
+* // Write vector values to module memory:
+* ddot.write( xptr, oneTo( N, dtype ) );
+* ddot.write( yptr, ones( N, dtype ) );
+*
+* // Perform computation:
+* var ddot = ddot.ndarray( N, xptr, 1, 0, yptr, 1, 0 );
+* // returns 15.0
+*/
+setReadOnly( Module.prototype, 'ndarray', function ddot( N, xptr, strideX, offsetX, yptr, strideY, offsetY ) {
+	return this._instance.exports.c_ddot_ndarray( N, xptr, strideX, offsetX, yptr, strideY, offsetY ); // eslint-disable-line max-len
+});
+
+
+// EXPORTS //
+
+module.exports = Module;

package/lib/routine.js

@@ -0,0 +1,178 @@
+/**
+* @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 no-restricted-syntax, no-invalid-this */
+
+'use strict';
+
+// MODULES //
+
+var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
+var inherits = require( '@stdlib/utils-inherit' );
+var stride2offset = require( '@stdlib/strided-base-stride2offset' );
+var Memory = require( '@stdlib/wasm-memory' );
+var arrays2ptrs = require( '@stdlib/wasm-base-arrays2ptrs' );
+var strided2object = require( '@stdlib/wasm-base-strided2object' );
+var Module = require( './module.js' );
+
+
+// MAIN //
+
+/**
+* Routine constructor.
+*
+* @private
+* @constructor
+* @returns {Routine} routine instance
+*
+* @example
+* var Float64Array = require( '@stdlib/array-float64' );
+*
+* // Create a new routine:
+* var ddot = new Routine();
+*
+* // Initialize the module:
+* ddot.initializeSync();
+*
+* // Define strided arrays:
+* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] );
+*
+* // Perform operation:
+* var dot = ddot.main( x.length, x, 1, y, 1 );
+* // returns 15.0
+*
+* @example
+* var Float64Array = require( '@stdlib/array-float64' );
+*
+* // Create a new routine:
+* var ddot = new Routine();
+*
+* // Initialize the module:
+* ddot.initializeSync();
+*
+* // Define strided arrays:
+* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] );
+*
+* // Perform operation:
+* var dot = ddot.ndarray( x.length, x, 1, 0, y, 1, 0 );
+* // returns 15.0
+*/
+function Routine() {
+	if ( !( this instanceof Routine ) ) {
+		return new Routine();
+	}
+	Module.call( this, new Memory({
+		'initial': 0
+	}));
+	return this;
+}
+
+// Inherit from the parent constructor:
+inherits( Routine, Module );
+
+/**
+* Computes the dot product of `x` and `y`.
+*
+* @name main
+* @memberof Routine.prototype
+* @readonly
+* @type {Function}
+* @param {PositiveInteger} N - number of indexed elements
+* @param {Float64Array} x - first input array
+* @param {integer} strideX - `x` stride length
+* @param {Float64Array} y - second input array
+* @param {integer} strideY - `y` stride length
+* @returns {number} dot product
+*
+* @example
+* var Float64Array = require( '@stdlib/array-float64' );
+*
+* // Create a new routine:
+* var ddot = new Routine();
+*
+* // Initialize the module:
+* ddot.initializeSync();
+*
+* // Define strided arrays:
+* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] );
+*
+* // Perform operation:
+* var dot = ddot.main( x.length, x, 1, y, 1 );
+* // returns 15.0
+*/
+setReadOnly( Routine.prototype, 'main', function ddot( N, x, strideX, y, strideY ) {
+	return this.ndarray( N, x, strideX, stride2offset( N, strideX ), y, strideY, stride2offset( N, strideY ) ); // eslint-disable-line max-len
+});
+
+/**
+* Computes the dot product of `x` and `y` using alternative indexing semantics.
+*
+* @name ndarray
+* @memberof Routine.prototype
+* @readonly
+* @type {Function}
+* @param {PositiveInteger} N - number of indexed elements
+* @param {Float64Array} x - first input array
+* @param {integer} strideX - `x` stride length
+* @param {NonNegativeInteger} offsetX - starting `x` index
+* @param {Float64Array} y - second input array
+* @param {integer} strideY - `y` stride length
+* @param {NonNegativeInteger} offsetY - starting `y` index
+* @returns {number} dot product
+*
+* @example
+* var Float64Array = require( '@stdlib/array-float64' );
+*
+* // Create a new routine:
+* var ddot = new Routine();
+*
+* // Initialize the module:
+* ddot.initializeSync();
+*
+* // Define strided arrays:
+* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+* var y = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] );
+*
+* // Perform operation:
+* var dot = ddot.ndarray( x.length, x, 1, 0, y, 1, 0 );
+* // returns 15.0
+*/
+setReadOnly( Routine.prototype, 'ndarray', function ddot( N, x, strideX, offsetX, y, strideY, offsetY ) {
+	var ptrs;
+	var p0;
+	var p1;
+
+	// Convert the input arrays to "pointers" in the module's memory:
+	ptrs = arrays2ptrs( this, [
+		strided2object( N, x, strideX, offsetX ),
+		strided2object( N, y, strideY, offsetY )
+	]);
+	p0 = ptrs[ 0 ];
+	p1 = ptrs[ 1 ];
+
+	// Perform computation by calling the corresponding parent method:
+	return Module.prototype.ndarray.call( this, N, p0.ptr, p0.stride, p0.offset, p1.ptr, p1.stride, p1.offset ); // eslint-disable-line max-len
+});
+
+
+// EXPORTS //
+
+module.exports = Routine;

package/manifest.json

@@ -0,0 +1,36 @@
+{
+  "options": {},
+  "fields": [
+    {
+      "field": "src",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "include",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "libraries",
+      "resolve": false,
+      "relative": false
+    },
+    {
+      "field": "libpath",
+      "resolve": true,
+      "relative": false
+    }
+  ],
+  "confs": [
+    {
+      "src": [],
+      "include": [],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/blas-base-ddot"
+      ]
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "@stdlib/blas-base-wasm-ddot",
+  "version": "0.1.0",
+  "description": "Compute the dot product of `x` and `y`.",
+  "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",
+  "browser": {
+    "./lib/binary.js": "./lib/binary.browser.js"
+  },
+  "directories": {
+    "doc": "./docs",
+    "lib": "./lib",
+    "scripts": "./scripts",
+    "src": "./src",
+    "dist": "./dist"
+  },
+  "types": "./docs/types",
+  "scripts": {},
+  "homepage": "https://stdlib.io",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/blas-base-wasm-ddot.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {
+    "@stdlib/assert-is-wasm-memory": "^0.1.0",
+    "@stdlib/blas-base-ddot": "^0.4.0",
+    "@stdlib/fs-read-wasm": "^0.2.2",
+    "@stdlib/strided-base-stride2offset": "^0.1.0",
+    "@stdlib/string-format": "^0.2.2",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2",
+    "@stdlib/utils-inherit": "^0.2.2",
+    "@stdlib/wasm-base-arrays2ptrs": "github:stdlib-js/wasm-base-arrays2ptrs#main",
+    "@stdlib/wasm-base-strided2object": "github:stdlib-js/wasm-base-strided2object#main",
+    "@stdlib/wasm-memory": "^0.1.0",
+    "@stdlib/wasm-module-wrapper": "github:stdlib-js/wasm-module-wrapper#main",
+    "@stdlib/error-tools-fmtprodmsg": "^0.2.2"
+  },
+  "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",
+    "level 1",
+    "ddot",
+    "linear",
+    "algebra",
+    "subroutines",
+    "dot",
+    "vector",
+    "array",
+    "ndarray",
+    "float64",
+    "double",
+    "float64array",
+    "webassembly",
+    "wasm"
+  ],
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
+  }
+}

package/src/exports.json

@@ -0,0 +1,4 @@
+[
+  "_c_ddot",
+  "_c_ddot_ndarray"
+]