Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/array-base-broadcast-array

Broadcast an array to a specified shape.

https://github.com/stdlib-js/array-base-broadcast-array

Science Score: 26.0%

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

  • ○
    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 (15.0%) to scientific vocabulary

Keywords

array base broadcast broadcasting javascript multidimensional ndarray node node-js nodejs reshape stdlib util utilities utility utils
Last synced: 6 months ago · JSON representation

Repository

Broadcast an array to a specified shape.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
array base broadcast broadcasting javascript multidimensional ndarray node node-js nodejs reshape stdlib util utilities utility utils
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

About stdlib...

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!

broadcastArray

NPM version Build Status Coverage Status <!-- dependencies -->

Broadcast an array to a specified shape.

## Installation ```bash npm install @stdlib/array-base-broadcast-array ``` 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 broadcastArray = require( '@stdlib/array-base-broadcast-array' ); ``` #### broadcastArray( x, inShape, outShape ) Broadcasts an array to a specified shape. ```javascript var x = [ 1, 2 ]; var out = broadcastArray( x, [ 2 ], [ 2, 2 ] ); // returns {...} var shape = out.shape; // returns [ 2, 2 ] var strides = out.strides; // returns [ 0, 1 ] var ref = out.ref; // returns [ 1, 2 ] var bool = ( x === ref ); // returns true var data = out.data; // returns [ [ 1, 2 ] ] ``` The function returns an object having the following properties: - **ref**: reference to the original input array. - **data**: broadcasted array. - **shape**: broadcasted array shape. - **strides**: broadcasted array strides. Strides describe how to iterate over broadcasted array dimensions.
## Notes - The broadcasted array shares the same data as the input array. As more than one element of a broadcasted array may refer to the same memory location, writing to the broadcasted array may affect multiple elements. If you need to write to the broadcasted array, copy the array **before** performing operations which may mutate elements. - The function throws an error if a provided input shape is [incompatible][@stdlib/ndarray/base/broadcast-shapes] with a provided output shape.
## Examples ```javascript var broadcastArray = require( '@stdlib/array-base-broadcast-array' ); // Create a 2x1 array: var x = [ [ 1 ], [ 2 ] ]; // Broadcast the array to 3x2x4: var o = broadcastArray( x, [ 2, 1 ], [ 3, 2, 4 ] ); // returns {...} // Retrieve the shape: var sh = o.shape; // returns [ 3, 2, 4 ] // Retrieve the array "strides": var st = o.strides; // returns [...] // Initialize loop indices: var i0 = 0; var i1 = 0; var i2 = 0; // Iterate over elements in the broadcasted array... var i; var j; var k; for ( i = 0; i < sh[ 0 ]; i++ ) { i1 = 0; for ( j = 0; j < sh[ 1 ]; j++ ) { i2 = 0; for ( k = 0; k < sh[ 2 ]; k++ ) { console.log( 'y[%s] = %d', [ i, j, k ].join( ',' ), o.data[ i0 ][ i1 ][ i2 ] ); i2 += st[ 2 ]; } i1 += st[ 1 ]; } i0 += st[ 0 ]; } ```
* * * ## 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

Standard library for JavaScript.

GitHub Events

Total
  • Push event: 19
Last Year
  • Push event: 19

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 35 last-month
  • Total dependent packages: 11
  • Total dependent repositories: 1
  • Total versions: 5
  • Total maintainers: 4
npmjs.org: @stdlib/array-base-broadcast-array

Broadcast an array to a specified shape.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 5
  • Dependent Packages: 11
  • Dependent Repositories: 1
  • Downloads: 35 Last month
Rankings
Dependent packages count: 1.9%
Downloads: 6.6%
Average: 10.2%
Dependent repos count: 10.4%
Forks count: 15.4%
Stargazers count: 16.8%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 6 months ago

Dependencies

.github/workflows/benchmark.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request v3 composite
.github/workflows/examples.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • actions/upload-artifact v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/productionize.yml actions
  • act10ns/slack v2 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • JS-DevTools/npm-publish v2 composite
  • act10ns/slack v2 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/test.yml actions
  • act10ns/slack v2 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/test_bundles.yml actions
  • act10ns/slack v2 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • denoland/setup-deno v1 composite
.github/workflows/test_coverage.yml actions
  • act10ns/slack v2 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • codecov/codecov-action v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/test_install.yml actions
  • act10ns/slack v2 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
package.json npm
  • @stdlib/array-base-zeros2d github:stdlib-js/array-base-zeros2d#main development
  • @stdlib/array-base-zerosnd github:stdlib-js/array-base-zerosnd#main development
  • @stdlib/assert-is-array ^0.0.7 development
  • @stdlib/bench ^0.0.12 development
  • @stdlib/math-base-assert-is-even ^0.0.7 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/array-base-copy-indexed ^0.0.1
  • @stdlib/array-base-zeros ^0.0.2
  • @stdlib/string-format ^0.0.3
  • @stdlib/types ^0.0.14