{"id":25173132,"url":"https://github.com/stdlib-js/blas-base-wasm-sdot","last_synced_at":"2026-04-29T00:02:40.681Z","repository":{"id":259138929,"uuid":"876415684","full_name":"stdlib-js/blas-base-wasm-sdot","owner":"stdlib-js","description":"Compute the dot product of `x` and `y`.","archived":false,"fork":false,"pushed_at":"2026-04-12T12:55:18.000Z","size":2641,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-04-12T13:13:17.213Z","etag":null,"topics":["algebra","array","blas","dot","float","float32","float32array","javascript","level-1","linear","math","mathematics","ndarray","node","node-js","nodejs","sdot","stdlib","subroutines","vector"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2024-10-21T23:48:24.000Z","updated_at":"2026-04-12T11:15:30.000Z","dependencies_parsed_at":"2025-04-12T18:21:40.916Z","dependency_job_id":"c429ee3e-d8a2-4319-b603-16993f02a19c","html_url":"https://github.com/stdlib-js/blas-base-wasm-sdot","commit_stats":null,"previous_names":["stdlib-js/blas-base-sdot-wasm","stdlib-js/blas-base-wasm-sdot"],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/stdlib-js/blas-base-wasm-sdot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fblas-base-wasm-sdot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fblas-base-wasm-sdot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fblas-base-wasm-sdot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fblas-base-wasm-sdot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/blas-base-wasm-sdot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fblas-base-wasm-sdot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32173530,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-23T02:19:40.750Z","status":"ssl_error","status_checked_at":"2026-04-23T02:17:55.737Z","response_time":53,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["algebra","array","blas","dot","float","float32","float32array","javascript","level-1","linear","math","mathematics","ndarray","node","node-js","nodejs","sdot","stdlib","subroutines","vector"],"created_at":"2025-02-09T10:28:13.642Z","updated_at":"2026-04-29T00:02:40.675Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2024 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.\u003c/p\u003e\n  \u003cp\u003eThe library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.\u003c/p\u003e\n  \u003cp\u003eWhen you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# sdot\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Compute the dot product of `x` and `y`.\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/blas-base-wasm-sdot\n```\n\nAlternatively,\n\n-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar sdot = require( '@stdlib/blas-base-wasm-sdot' );\n```\n\n#### sdot.main( N, x, strideX, y, strideY )\n\nComputes the dot product of `x` and `y`.\n\n```javascript\nvar Float32Array = require( '@stdlib/array-float32' );\n\nvar x = new Float32Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );\nvar y = new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );\n\nvar z = sdot.main( x.length, x, 1, y, 1 );\n// returns -5.0\n```\n\nThe function has the following parameters:\n\n-   **N**: number of indexed elements.\n-   **x**: first input [`Float32Array`][@stdlib/array/float32].\n-   **strideX**: index increment for `x`.\n-   **y**: second input [`Float32Array`][@stdlib/array/float32].\n-   **strideY**: index increment for `y`.\n\nThe `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to calculate the dot product of every other value in `x` and the first `N` elements of `y` in reverse order,\n\n```javascript\nvar Float32Array = require( '@stdlib/array-float32' );\n\nvar x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );\nvar y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );\n\nvar z = sdot.main( 3, x, 2, y, -1 );\n// returns 9.0\n```\n\nNote that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.\n\n\u003c!-- eslint-disable stdlib/capitalized-comments --\u003e\n\n```javascript\nvar Float32Array = require( '@stdlib/array-float32' );\n\n// Initial arrays...\nvar x0 = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );\nvar y0 = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );\n\n// Create offset views...\nvar x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element\nvar y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element\n\nvar z = sdot.main( 3, x1, -2, y1, 1 );\n// returns 128.0\n```\n\n#### sdot.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )\n\nComputes the dot product of `x` and `y` using alternative indexing semantics.\n\n```javascript\nvar Float32Array = require( '@stdlib/array-float32' );\n\nvar x = new Float32Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );\nvar y = new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );\n\nvar z = sdot.ndarray( x.length, x, 1, 0, y, 1, 0 );\n// returns -5.0\n```\n\nThe function has the following additional parameters:\n\n-   **offsetX**: starting index for `x`.\n-   **offsetY**: starting index for `y`.\n\nWhile [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the dot product of every other value in `x` starting from the second value with the last 3 elements in `y` in reverse order\n\n```javascript\nvar Float32Array = require( '@stdlib/array-float32' );\n\nvar x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );\nvar y = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );\n\nvar z = sdot.ndarray( 3, x, 2, 1, y, -1, y.length-1 );\n// returns 128.0\n```\n\n* * *\n\n### Module\n\n#### sdot.Module( memory )\n\nReturns a new WebAssembly [module wrapper][@stdlib/wasm/module-wrapper] instance which uses the provided WebAssembly [memory][@stdlib/wasm/memory] instance as its underlying memory.\n\n\u003c!-- eslint-disable node/no-sync --\u003e\n\n```javascript\nvar Memory = require( '@stdlib/wasm-memory' );\n\n// Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):\nvar mem = new Memory({\n    'initial': 10,\n    'maximum': 100\n});\n\n// Create a BLAS routine:\nvar mod = new sdot.Module( mem );\n// returns \u003cModule\u003e\n\n// Initialize the routine:\nmod.initializeSync();\n```\n\n#### sdot.Module.prototype.main( N, xp, sx, yp, sy )\n\nComputes the dot product of `x` and `y`.\n\n\u003c!-- eslint-disable node/no-sync --\u003e\n\n```javascript\nvar Memory = require( '@stdlib/wasm-memory' );\nvar oneTo = require( '@stdlib/array-one-to' );\nvar ones = require( '@stdlib/array-ones' );\nvar zeros = require( '@stdlib/array-zeros' );\nvar bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' );\n\n// Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):\nvar mem = new Memory({\n    'initial': 10,\n    'maximum': 100\n});\n\n// Create a BLAS routine:\nvar mod = new sdot.Module( mem );\n// returns \u003cModule\u003e\n\n// Initialize the routine:\nmod.initializeSync();\n\n// Define a vector data type:\nvar dtype = 'float32';\n\n// Specify a vector length:\nvar N = 5;\n\n// Define pointers (i.e., byte offsets) for storing two vectors:\nvar xptr = 0;\nvar yptr = N * bytesPerElement( dtype );\n\n// Write vector values to module memory:\nmod.write( xptr, oneTo( N, dtype ) );\nmod.write( yptr, ones( N, dtype ) );\n\n// Perform computation:\nvar z = mod.main( N, xptr, 1, yptr, 1 );\n\nconsole.log( z );\n```\n\nThe function has the following parameters:\n\n-   **N**: number of indexed elements.\n-   **xp**: first input [`Float32Array`][@stdlib/array/float32] pointer (i.e., byte offset).\n-   **sx**: index increment for `x`.\n-   **yp**: second input [`Float32Array`][@stdlib/array/float32] pointer (i.e., byte offset).\n-   **sy**: index increment for `y`.\n\n#### sdot.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy )\n\nComputes the dot product of `x` and `y` using alternative indexing semantics.\n\n\u003c!-- eslint-disable node/no-sync --\u003e\n\n```javascript\nvar Memory = require( '@stdlib/wasm-memory' );\nvar oneTo = require( '@stdlib/array-one-to' );\nvar ones = require( '@stdlib/array-ones' );\nvar zeros = require( '@stdlib/array-zeros' );\nvar bytesPerElement = require( '@stdlib/ndarray-base-bytes-per-element' );\n\n// Create a new memory instance with an initial size of 10 pages (640KiB) and a maximum size of 100 pages (6.4MiB):\nvar mem = new Memory({\n    'initial': 10,\n    'maximum': 100\n});\n\n// Create a BLAS routine:\nvar mod = new sdot.Module( mem );\n// returns \u003cModule\u003e\n\n// Initialize the routine:\nmod.initializeSync();\n\n// Define a vector data type:\nvar dtype = 'float32';\n\n// Specify a vector length:\nvar N = 5;\n\n// Define pointers (i.e., byte offsets) for storing two vectors:\nvar xptr = 0;\nvar yptr = N * bytesPerElement( dtype );\n\n// Write vector values to module memory:\nmod.write( xptr, oneTo( N, dtype ) );\nmod.write( yptr, ones( N, dtype ) );\n\n// Perform computation:\nvar z = mod.ndarray( N, xptr, 1, 0, yptr, 1, 0 );\n\nconsole.log( z );\n```\n\nThe function has the following additional parameters:\n\n-   **ox**: starting index for `x`.\n-   **oy**: starting index for `y`.\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n* * *\n\n## Notes\n\n-   If `N \u003c= 0`, both `main` and `ndarray` methods return `0.0`.\n-   This package implements routines using WebAssembly. When provided arrays which are not allocated on a `sdot` module memory instance, data must be explicitly copied to module memory prior to computation. Data movement may entail a performance cost, and, thus, if you are using arrays external to module memory, you should prefer using [`@stdlib/blas-base/sdot`][@stdlib/blas/base/sdot]. However, if working with arrays which are allocated and explicitly managed on module memory, you can achieve better performance when compared to the pure JavaScript implementations found in [`@stdlib/blas/base/sdot`][@stdlib/blas/base/sdot]. Beware that such performance gains may come at the cost of additional complexity when having to perform manual memory management. Choosing between implementations depends heavily on the particular needs and constraints of your application, with no one choice universally better than the other.\n-   `sdot()` corresponds to the [BLAS][blas] level 1 function [`sdot`][sdot].\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n* * *\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar discreteUniform = require( '@stdlib/random-array-discrete-uniform' );\nvar sdot = require( '@stdlib/blas-base-wasm-sdot' );\n\nvar opts = {\n    'dtype': 'float32'\n};\nvar x = discreteUniform( 10, 0, 100, opts );\nconsole.log( x );\n\nvar y = discreteUniform( x.length, 0, 10, opts );\nconsole.log( y );\n\nvar z = sdot.ndarray( x.length, x, 1, 0, y, -1, y.length-1 );\nconsole.log( z );\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.\n\nFor more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2026. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/blas-base-wasm-sdot.svg\n[npm-url]: https://npmjs.org/package/@stdlib/blas-base-wasm-sdot\n\n[test-image]: https://github.com/stdlib-js/blas-base-wasm-sdot/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/blas-base-wasm-sdot/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/blas-base-wasm-sdot/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/blas-base-wasm-sdot?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/blas-base-wasm-sdot.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/blas-base-wasm-sdot/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg\n[chat-url]: https://stdlib.zulipchat.com\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/blas-base-wasm-sdot/tree/deno\n[deno-readme]: https://github.com/stdlib-js/blas-base-wasm-sdot/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/blas-base-wasm-sdot/tree/umd\n[umd-readme]: https://github.com/stdlib-js/blas-base-wasm-sdot/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/blas-base-wasm-sdot/tree/esm\n[esm-readme]: https://github.com/stdlib-js/blas-base-wasm-sdot/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/blas-base-wasm-sdot/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/blas-base-wasm-sdot/main/LICENSE\n\n[blas]: http://www.netlib.org/blas\n\n[sdot]: https://www.netlib.org/lapack/explore-html/d1/dcc/group__dot_gaa145c21fd5f5b672ac0b4560154682dd.html#gaa145c21fd5f5b672ac0b4560154682dd\n\n[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\n\n[@stdlib/array/float32]: https://github.com/stdlib-js/array-float32\n\n[@stdlib/wasm/memory]: https://github.com/stdlib-js/wasm-memory\n\n[@stdlib/wasm/module-wrapper]: https://github.com/stdlib-js/wasm-module-wrapper\n\n[@stdlib/blas/base/sdot]: https://github.com/stdlib-js/blas-base-sdot\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fblas-base-wasm-sdot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fblas-base-wasm-sdot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fblas-base-wasm-sdot/lists"}