Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 14 Commits
.github		.github
benchmark		benchmark
dist		dist
docs		docs
examples		examples
lib		lib
test		test
.editorconfig		.editorconfig
.eslintrc.js		.eslintrc.js
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
.npmrc		.npmrc
CHANGELOG.md		CHANGELOG.md
CITATION.cff		CITATION.cff
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
CONTRIBUTORS		CONTRIBUTORS
LICENSE		LICENSE
Makefile		Makefile
NOTICE		NOTICE
README.md		README.md
SECURITY.md		SECURITY.md
branches.md		branches.md
package.json		package.json

Repository files navigation

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 considerfinancially supporting stdlib. We greatly appreciate your continued support!

broadcastArrays

Broadcastndarrays to a common shape.

Installation

npm install @stdlib/ndarray-broadcast-arrays

Alternatively,

To load the package in a website via ascript tag without installation and bundlers, use theES Module available on theesm branch (seeREADME).
If you are using Deno, visit thedeno branch (seeREADME for usage intructions).
For use in Observable, or in browser/node environments, use theUniversal Module Definition (UMD) build available on theumd branch (seeREADME).

Thebranches.md 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

varbroadcastArrays=require('@stdlib/ndarray-broadcast-arrays');

broadcastArrays( ...arrays )

Broadcasts a list ofndarrays to a common shape.

vararray=require('@stdlib/ndarray-array');varzeros=require('@stdlib/ndarray-zeros');// Create a 2x2 ndarray:varx=array([[1,2],[3,4]]);// returns <ndarray>// Create a 2x2x2 ndarray:vary=zeros([2,2,2]);// returns <ndarray>// Broadcast to a common shape:varout=broadcastArrays([x,y]);// returns [ <ndarray>, <ndarray> ]

The function supports two (mutually exclusive) means for providingndarray arguments:

providing a single array ofndarray arguments.
providingndarray arguments as separate arguments.

vararray=require('@stdlib/ndarray-array');varzeros=require('@stdlib/ndarray-zeros');// Create a 2x2 ndarray:varx=array([[1,2],[3,4]]);// returns <ndarray>// Create a 2x2x2 ndarray:vary=zeros([2,2,2]);// returns <ndarray>// Broadcast to a common shape:varout=broadcastArrays(x,y);// returns [ <ndarray>, <ndarray> ]

Notes

The function throws an error if providedbroadcast-incompatible ndarrays.
Returnedndarrays areread-only views on their respective underlying data buffers. The views are typicallynot contiguous. As more than one element of a returned view may refer to the same memory location, writing to a view may affect multiple elements. If you need to write to a returnedndarray, copy thendarraybefore broadcasting.
The function always returns newndarray instances even if an inputndarray shape and the broadcasted shape are the same.

Examples

vararray=require('@stdlib/ndarray-array');varzeros=require('@stdlib/ndarray-zeros');varnumel=require('@stdlib/ndarray-base-numel');varind2sub=require('@stdlib/ndarray-ind2sub');varbroadcastArrays=require('@stdlib/ndarray-broadcast-arrays');// Create a 2x2 array:varx=array([[1,2],[3,4]]);// returns <ndarray>// Create a 3x2x2 array:vary=zeros([3,2,2]);// returns <ndarray>// Broadcast the arrays to a common shape:varout=broadcastArrays([x,y]);// returns [ <ndarray>, <ndarray> ]// Retrieve the common shape:varsh=out[0].shape;// returns [ 3, 2, 2 ]// Retrieve the number of elements:varN=numel(sh);// Loop through the array elements...vari;for(i=0;i<N;i++){console.log('X[%s] = %d',ind2sub(sh,i).join(', '),out[0].iget(i));}

Notice

This package is part ofstdlib, 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 developstdlib, see the main projectrepository.