blas-base-wasm-scopy

Copy values from `x` into `y`.

https://github.com/stdlib-js/blas-base-wasm-scopy

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.9%) to scientific vocabulary

Keywords

algebra array blas copy float float32 float32array javascript level-1 linear math mathematics ndarray node node-js nodejs scopy stdlib subroutines vector

Last synced: 4 months ago · JSON representation ·

Repository

Copy values from `x` into `y`.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 1.47 MB

Statistics

Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 0

Topics

algebra array blas copy float float32 float32array javascript level-1 linear math mathematics ndarray node node-js nodejs scopy stdlib subroutines vector

Created about 1 year ago · Last pushed 5 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

We 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.

The 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.

When 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.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

scopy

Copy values from x into y.

## Installation ```bash npm install @stdlib/blas-base-wasm-scopy ``` Alternatively, - 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]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - 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]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To 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.

## Usage ```javascript var scopy = require( '@stdlib/blas-base-wasm-scopy' ); ``` #### scopy.main( N, x, strideX, y, strideY ) Copies values from `x` into `y`. ```javascript var Float32Array = require( '@stdlib/array-float32' ); var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); scopy.main( x.length, x, 1, y, 1 ); // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ``` The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float32Array`][@stdlib/array/float32]. - **strideX**: index increment for `x`. - **y**: output [`Float32Array`][@stdlib/array/float32]. - **strideY**: index increment for `y`. The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to copy every other element from `x` into `y` in reverse order, ```javascript var Float32Array = require( '@stdlib/array-float32' ); var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); scopy.main( 3, x, 2, y, -1 ); // y => [ 5.0, 3.0, 1.0, 1.0, 1.0, 1.0 ] ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. ```javascript var Float32Array = require( '@stdlib/array-float32' ); // Initial arrays... var x0 = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var y0 = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); // Create offset views... var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element var y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element scopy.main( 3, x1, -2, y1, 1 ); // y0 => [ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ] ``` #### scopy.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) Copies values from `x` into `y` using alternative indexing semantics. ```javascript var Float32Array = require( '@stdlib/array-float32' ); var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); var y = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] ); scopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); // y => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ``` The function has the following additional parameters: - **offsetX**: starting index for `x`. - **offsetY**: starting index for `y`. While [`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 copy every other value in `x` starting from the second value into the last `N` elements in `y` where `x[i] = y[n]`, `x[i+2] = y[n-1]`,..., ```javascript var Float32Array = require( '@stdlib/array-float32' ); var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); var y = new Float32Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); scopy.ndarray( 3, x, 2, 1, y, -1, y.length-1 ); // y => [ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ] ``` * * * ### Module #### scopy.Module( memory ) Returns a new WebAssembly [module wrapper][@stdlib/wasm/module-wrapper] instance which uses the provided WebAssembly [memory][@stdlib/wasm/memory] instance as its underlying memory. ```javascript var Memory = require( '@stdlib/wasm-memory' ); // 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 mod = new scopy.Module( mem ); // returns // Initialize the routine: mod.initializeSync(); ``` #### scopy.Module.prototype.main( N, xp, sx, yp, sy ) Copies values from `x` into `y`. ```javascript 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 mod = new scopy.Module( mem ); // returns // Initialize the routine: mod.initializeSync(); // Define a vector data type: var dtype = 'float32'; // 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: mod.write( xptr, oneTo( N, dtype ) ); mod.write( yptr, ones( N, dtype ) ); // Perform computation: mod.main( N, xptr, 1, yptr, 1 ); // Read out the results: var view = zeros( N, dtype ); mod.read( yptr, view ); console.log( view ); // => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ``` The function has the following parameters: - **N**: number of indexed elements. - **xp**: input [`Float32Array`][@stdlib/array/float32] pointer (i.e., byte offset). - **sx**: index increment for `x`. - **yp**: input [`Float32Array`][@stdlib/array/float32] pointer (i.e., byte offset). - **sy**: index increment for `y`. #### scopy.Module.prototype.ndarray( N, xp, sx, ox, yp, sy, oy ) Copies values from `x` into `y` using alternative indexing semantics. ```javascript 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 mod = new scopy.Module( mem ); // returns // Initialize the routine: mod.initializeSync(); // Define a vector data type: var dtype = 'float32'; // 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: mod.write( xptr, oneTo( N, dtype ) ); mod.write( yptr, ones( N, dtype ) ); // Perform computation: mod.ndarray( N, xptr, 1, 0, yptr, 1, 0 ); // Read out the results: var view = zeros( N, dtype ); mod.read( yptr, view ); console.log( view ); // => [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ``` The function has the following additional parameters: - **ox**: starting index for `x`. - **oy**: starting index for `y`.

* * * ## Notes - If `N <= 0`, `y` is left unchanged. - This package implements routines using WebAssembly. When provided arrays which are not allocated on a `scopy` 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/scopy`][@stdlib/blas/base/scopy]. 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/scopy`][@stdlib/blas/base/scopy]. 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. - `scopy()` corresponds to the [BLAS][blas] level 1 function [`scopy`][scopy].

* * * ## Examples ```javascript var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); var scopy = require( '@stdlib/blas-base-wasm-scopy' ); var opts = { 'dtype': 'float32' }; var x = discreteUniform( 10, 0, 100, opts ); console.log( x ); var y = discreteUniform( x.length, 0, 10, opts ); console.log( y ); scopy.ndarray( x.length, x, 1, 0, y, -1, y.length-1 ); console.log( y ); ```

* * * ## Notice This 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. For 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]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 12
Create event: 2

Last Year

Push event: 12
Create event: 2

Dependencies

.github/workflows/benchmark.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request 9c18513d320d7b2c7185fb93396d0c664d5d8448 composite

.github/workflows/examples.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/npm_downloads.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/productionize.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
JS-DevTools/npm-publish 19c28f1ef146469e409470805ea4279d47c3d35c composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/test.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/test_bundles.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
denoland/setup-deno 041b854f97b325bd60e53e9dc2de9cb9f9ac0cba composite

.github/workflows/test_coverage.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
codecov/codecov-action 84508663e988701840491b86de86b666e8a86bed composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/test_install.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/test_published_package.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

package.json npm

@stdlib/array-float32 ^0.2.2 development
@stdlib/array-little-endian-float32 github:stdlib-js/array-little-endian-float32#main development
@stdlib/array-one-to ^0.2.2 development
@stdlib/array-ones ^0.2.1 development
@stdlib/array-zeros ^0.2.2 development
@stdlib/assert-has-wasm-support ^0.2.2 development
@stdlib/bench-harness ^0.2.2 development
@stdlib/blas-ext-base-gfill ^0.2.1 development
@stdlib/blas-ext-base-gfill-by ^0.2.1 development
@stdlib/fs-read-file ^0.2.2 development
@stdlib/fs-write-file ^0.2.2 development
@stdlib/math-base-assert-is-nan ^0.2.2 development
@stdlib/math-base-special-pow ^0.3.0 development
@stdlib/ndarray-base-bytes-per-element ^0.2.2 development
@stdlib/random-array-uniform ^0.2.1 development
@stdlib/random-base-discrete-uniform ^0.2.1 development
@stdlib/string-base-base64-to-uint8array github:stdlib-js/string-base-base64-to-uint8array#main development
@stdlib/string-replace ^0.2.2 development
@stdlib/time-current-year ^0.2.2 development
istanbul ^0.4.1 development
tap-min git+https://github.com/Planeshifter/tap-min.git development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/assert-is-wasm-memory github:stdlib-js/assert-is-wasm-memory#main
@stdlib/blas-base-scopy ^0.2.2
@stdlib/error-tools-fmtprodmsg ^0.2.2
@stdlib/fs-read-wasm ^0.2.2
@stdlib/strided-base-read-dataview github:stdlib-js/strided-base-read-dataview#main
@stdlib/strided-base-stride2offset ^0.1.0
@stdlib/string-format ^0.2.2
@stdlib/types ^0.4.3
@stdlib/utils-define-nonenumerable-read-only-property ^0.2.2
@stdlib/utils-inherit ^0.2.2
@stdlib/utils-library-manifest ^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 github:stdlib-js/wasm-memory#main
@stdlib/wasm-module-wrapper github:stdlib-js/wasm-module-wrapper#main

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science