npm install @stdlib/ndarray-base-maybe-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.

varmaybeBroadcastArrays=require('@stdlib/ndarray-base-maybe-broadcast-arrays');

Broadcastsndarrays 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=maybeBroadcastArrays([x,y]);// returns [ <ndarray>, <ndarray> ]

• The function throws an error if a providedbroadcast-incompatible ndarrays.
• If a providedndarray has a shape matching the common shape, the function returns the providedndarray.
• If a providedndarray has a different (broadcast compatible) shape than the common shape, the function returns a new (base)ndarray view of the providedndarray's data. The view is 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 performing operations which may mutate elements.
• A returnedndarray is a "base"ndarray, and, thus, a returnedndarray view does not perform bounds checking or afford any of the guarantees of the non-basendarray constructor. The primary intent of this function is to broadcast ndarray-like objects within internal implementations and to do so with minimal overhead.

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.

SeeLICENSE.

Copyright © 2016-2025. The StdlibAuthors.