{"id":26119154,"url":"https://github.com/stdlib-js/ndarray-base-broadcast-shapes","last_synced_at":"2026-03-10T06:31:00.257Z","repository":{"id":41354540,"uuid":"376831022","full_name":"stdlib-js/ndarray-base-broadcast-shapes","owner":"stdlib-js","description":"Broadcast array shapes to a single shape.","archived":false,"fork":false,"pushed_at":"2026-02-04T15:43:55.000Z","size":399,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-02-22T20:51:18.288Z","etag":null,"topics":["array","base","broadcast","broadcasting","javascript","multidimensional","ndarray","node","node-js","nodejs","stdlib","types","util","utilities","utility","utils"],"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":"2021-06-14T13:22:47.000Z","updated_at":"2026-02-04T15:39:34.000Z","dependencies_parsed_at":"2023-02-17T06:30:58.340Z","dependency_job_id":"280238aa-0e74-4356-896a-5025bc3539d1","html_url":"https://github.com/stdlib-js/ndarray-base-broadcast-shapes","commit_stats":{"total_commits":47,"total_committers":1,"mean_commits":47.0,"dds":0.0,"last_synced_commit":"8659aaa379b3bf30861610beb45296dd6e13cf39"},"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/stdlib-js/ndarray-base-broadcast-shapes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-broadcast-shapes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-broadcast-shapes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-broadcast-shapes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-broadcast-shapes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/ndarray-base-broadcast-shapes/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fndarray-base-broadcast-shapes/sbom","scorecard":{"id":329426,"data":{"date":"2025-08-11","repo":{"name":"github.com/stdlib-js/ndarray-base-broadcast-shapes","commit":"139523449683b80a0a227ab01f8c796347f22c38"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":1,"reason":"2 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Security-Policy","score":9,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Info: Found linked content: SECURITY.md:1","Warn: One or no descriptive hints of disclosure, vulnerability, and/or timelines in security policy","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/benchmark.yml:1","Warn: no topLevel permission defined: .github/workflows/cancel.yml:1","Warn: no topLevel permission defined: .github/workflows/close_pull_requests.yml:1","Warn: no topLevel permission defined: .github/workflows/examples.yml:1","Warn: no topLevel permission defined: .github/workflows/npm_downloads.yml:1","Warn: no topLevel permission defined: .github/workflows/productionize.yml:1","Warn: no topLevel permission defined: .github/workflows/publish.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Warn: no topLevel permission defined: .github/workflows/test_bundles.yml:1","Warn: no topLevel permission defined: .github/workflows/test_coverage.yml:1","Warn: no topLevel permission defined: .github/workflows/test_install.yml:1","Warn: no topLevel permission defined: .github/workflows/test_published_package.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":3,"reason":"dependency not pinned by hash detected -- score normalized to 3","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/ndarray-base-broadcast-shapes/productionize.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:275: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/ndarray-base-broadcast-shapes/productionize.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:449: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/ndarray-base-broadcast-shapes/productionize.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:457: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/ndarray-base-broadcast-shapes/productionize.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:623: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/ndarray-base-broadcast-shapes/productionize.yml/main?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58","Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58","Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58","Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58","Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58","Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:165","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617","Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617","Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76","Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76","Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76","Warn: npmCommand not pinned by hash: .github/workflows/test.yml:83","Warn: npmCommand not pinned by hash: .github/workflows/test_bundles.yml:72","Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67","Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67","Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67","Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:74","Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75","Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75","Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75","Warn: npmCommand not pinned by hash: .github/workflows/test_published_package.yml:93","Info:  33 out of  33 GitHub-owned GitHubAction dependencies pinned","Info:  19 out of  24 third-party GitHubAction dependencies pinned","Info:   0 out of  32 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-18T03:13:26.826Z","repository_id":41354540,"created_at":"2025-08-18T03:13:26.826Z","updated_at":"2025-08-18T03:13:26.826Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30326891,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T05:25:20.737Z","status":"ssl_error","status_checked_at":"2026-03-10T05:25:17.430Z","response_time":106,"last_error":"SSL_read: 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":["array","base","broadcast","broadcasting","javascript","multidimensional","ndarray","node","node-js","nodejs","stdlib","types","util","utilities","utility","utils"],"created_at":"2025-03-10T12:15:53.817Z","updated_at":"2026-03-10T06:31:00.237Z","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) 2021 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# broadcastShapes\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 Broadcast array shapes to a single shape.\n\n\u003c!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003c!-- Package usage documentation. --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/ndarray-base-broadcast-shapes\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 broadcastShapes = require( '@stdlib/ndarray-base-broadcast-shapes' );\n```\n\n#### broadcastShapes( shapes )\n\nBroadcasts array shapes to a single shape.\n\n```javascript\nvar sh1 = [ 8, 1, 6, 1 ];\nvar sh2 = [ 7, 1, 5 ];\n\nvar sh = broadcastShapes( [ sh1, sh2 ] );\n// returns [ 8, 7, 6, 5 ]\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003c!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   When operating on two arrays, the function compares their shapes element-wise, beginning with the trailing (i.e., rightmost) dimension. The following are examples of compatible shapes and their corresponding broadcasted shape:\n\n    ```text\n    A      (4d array):  8 x 1 x 6 x 1\n    B      (3d array):      7 x 1 x 5\n    ---------------------------------\n    Result (4d array):  8 x 7 x 6 x 5\n\n    A      (2d array):  5 x 4\n    B      (1d array):      1\n    -------------------------\n    Result (2d array):  5 x 4\n\n    A      (2d array):  5 x 4\n    B      (1d array):      4\n    -------------------------\n    Result (2d array):  5 x 4\n\n    A      (3d array):  15 x 3 x 5\n    B      (3d array):  15 x 1 x 5\n    ------------------------------\n    Result (3d array):  15 x 3 x 5\n\n    A      (3d array):  15 x 3 x 5\n    B      (2d array):       3 x 5\n    ------------------------------\n    Result (3d array):  15 x 3 x 5\n\n    A      (3d array):  15 x 3 x 5\n    B      (2d array):       3 x 1\n    ------------------------------\n    Result (3d array):  15 x 3 x 5\n\n    A      (5d array):  8 x 1 x 1 x 6 x 1\n    B      (4d array):      1 x 7 x 1 x 5\n    C      (5d array):  8 x 4 x 1 x 6 x 5\n    -------------------------------------\n    Result (5d array):  8 x 4 x 7 x 6 x 5\n\n    A      (5d array):  8 x 1 x 1 x 6 x 1\n    B      (1d array):                  0\n    -------------------------------------\n    Result (5d array):  8 x 1 x 1 x 6 x 0\n\n    A      (5d array):  8 x 0 x 1 x 6 x 1\n    B      (2d array):              6 x 5\n    -------------------------------------\n    Result (5d array):  8 x 0 x 1 x 6 x 5\n\n    A      (5d array):  8 x 1 x 1 x 6 x 1\n    B      (5d array):  8 x 0 x 1 x 6 x 1\n    -------------------------------------\n    Result (5d array):  8 x 0 x 1 x 6 x 1\n\n    A      (3d array):  3 x 2 x 1\n    B      (0d array):\n    -----------------------------\n    Result (3d array):  3 x 2 x 1\n\n    A      (0d array):\n    B      (3d array):  3 x 2 x 1\n    -----------------------------\n    Result (3d array):  3 x 2 x 1\n    ```\n\n    As demonstrated above, arrays are not required to have the same number of dimensions in order to be broadcast compatible. Array shapes with fewer dimensions are implicitly prepended with singleton dimensions (i.e., dimensions equal to `1`). Accordingly, the following example\n\n    ```text\n    A      (2d array):  5 x 4\n    B      (1d array):      4\n    -------------------------\n    Result (2d array):  5 x 4\n    ```\n\n    is equivalent to\n\n    ```text\n    A      (2d array):  5 x 4\n    B      (2d array):  1 x 4\n    -------------------------\n    Result (2d array):  5 x 4\n    ```\n\n    Similarly, a zero-dimensional array is expanded (by prepending singleton dimensions) from\n\n    ```text\n    A      (3d array):  3 x 2 x 1\n    B      (0d array):\n    -----------------------------\n    Result (3d array):  3 x 2 x 1\n    ```\n\n    to\n\n    ```text\n    A      (3d array):  3 x 2 x 1\n    B      (3d array):  1 x 1 x 1\n    -----------------------------\n    Result (3d array):  3 x 2 x 1\n    ```\n\n    Stated otherwise, every array has implicit leading dimensions of size `1`. During broadcasting, a `3 x 4` matrix is the same as a `3 x 4 x 1 x 1 x 1` multidimensional array.\n\n-   Two respective dimensions in two shape arrays are compatible if\n\n    1.  the dimensions are equal.\n    2.  one dimension is `1`.\n\n    The two aforementioned rules apply to empty arrays or arrays that have a dimension of size `0`. For unequal dimensions, the size of the dimension which is not `1` determines the size of the output shape dimension.\n\n    Accordingly, dimensions of size `0` must be paired with a dimension of size `0` or `1`. In such cases, by the rules above, the size of the corresponding output shape dimension is `0`.\n\n-   The function returns `null` if provided incompatible shapes (i.e., shapes which cannot be broadcast with one another).\n\n    ```javascript\n    var sh1 = [ 3, 2 ];\n    var sh2 = [ 2, 3 ];\n\n    var sh = broadcastShapes( [ sh1, sh2 ] );\n    // returns null\n    ```\n\n    The following are examples of array shapes which are **not** compatible and do **not** broadcast:\n\n    ```text\n    A      (1d array):  3\n    B      (1d array):  4                   # dimension does not match\n\n    A      (2d array):      2 x 1\n    B      (3d array):  8 x 4 x 3           # second dimension does not match\n\n    A      (3d array):  15 x 3 x 5\n    B      (2d array):  15 x 3              # singleton dimensions can only be prepended, not appended\n\n    A      (5d array):  8 x 8 x 1 x 6 x 1\n    B      (5d array):  8 x 0 x 1 x 6 x 1   # second dimension does not match\n    ```\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- Package usage examples. --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar lpad = require( '@stdlib/string-left-pad' );\nvar broadcastShapes = require( '@stdlib/ndarray-base-broadcast-shapes' );\n\nvar shapes;\nvar out;\nvar sh;\nvar i;\nvar j;\n\nfunction shape2string( shape ) {\n    return lpad( shape.join( ' x ' ), 20, ' ' );\n}\n\nshapes = [\n    [ [ 1, 2 ], [ 2 ] ],\n    [ [ 1, 1 ], [ 3, 4 ] ],\n    [ [ 6, 7 ], [ 5, 6, 1 ], [ 7 ], [ 5, 1, 7 ] ],\n    [ [ 1, 3 ], [ 3, 1 ] ],\n    [ [ 1 ], [ 3 ] ],\n    [ [ 2 ], [ 3, 2 ] ],\n    [ [ 2, 3 ], [ 2, 3 ], [ 2, 3 ], [ 2, 3 ] ],\n    [ [ 1, 2 ], [ 1, 2 ] ]\n];\n\nfor ( i = 0; i \u003c shapes.length; i++ ) {\n    sh = shapes[ i ];\n    for ( j = 0; j \u003c sh.length; j++ ) {\n        console.log( shape2string( sh[ j ] ) );\n    }\n    console.log( lpad( '', 20, '-' ) );\n\n    out = broadcastShapes( sh );\n    console.log( shape2string( out )+'\\n' );\n}\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- C interface documentation. --\u003e\n\n* * *\n\n\u003csection class=\"c\"\u003e\n\n## C APIs\n\n\u003c!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003c!-- C usage documentation. --\u003e\n\n\u003csection class=\"usage\"\u003e\n\n### Usage\n\n```c\n#include \"stdlib/ndarray/base/broadcast_shapes.h\"\n```\n\n#### stdlib_ndarray_broadcast_shapes( M, \\*\\*shapes, \\*ndims, \\*out )\n\nBroadcasts array shapes to a single shape.\n\n```c\n#include \"stdlib/ndarray/base/broadcast_shapes.h\"\n#include \u003cstdint.h\u003e\n\nint64_t N1 = 4;\nint64_t sh1[] = { 8, 1, 6, 1 };\n\nint64_t N2 = 3;\nint64_t sh2[] = { 7, 1, 5 };\n\nint64_t ndims[] = { N1, N2 };\nint64_t *shapes[] = { sh1, sh2 };\n\nint64_t out[] = { 0, 0, 0, 0 };\nint8_t status = stdlib_ndarray_broadcast_shapes( 2, shapes, ndims, out );\nif ( status != 0 ) {\n    // Handle error...\n}\n```\n\nThe function accepts the following arguments:\n\n-   **M**: `[in] int64_t` number of shape arrays.\n-   **shapes**: `[in] int64_t**` array of shape arrays (dimensions).\n-   **ndims**: `[in] int64_t*` number of dimensions for each respective shape array.\n-   **out**: `[out] int64_t*` output shape array.\n\n```c\nint8_t stdlib_ndarray_broadcast_shapes( const int64_t M, const int64_t *shapes[], const int64_t ndims[], int64_t *out );\n```\n\nIf successful, the function returns `0`; otherwise, the function returns `-1` (e.g., due to incompatible shapes).\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003c!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n### Notes\n\n-   Even if the function is unsuccessful, the function may still overwrite elements in the output array before returning. In other words, do not assume that providing incompatible shapes is a no-op with regard to the output array.\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- C API usage examples. --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n### Examples\n\n```c\n#include \"stdlib/ndarray/base/broadcast_shapes.h\"\n#include \u003cstdint.h\u003e\n#include \u003cstdio.h\u003e\n#include \u003cinttypes.h\u003e\n\nint main( void ) {\n    int64_t N1 = 4;\n    int64_t sh1[] = { 8, 1, 6, 1 };\n\n    int64_t N2 = 3;\n    int64_t sh2[] = { 7, 1, 5 };\n\n    int64_t ndims[] = { N1, N2 };\n    int64_t *shapes[] = { sh1, sh2 };\n\n    int64_t out[] = { 0, 0, 0, 0 };\n    int8_t status = stdlib_ndarray_broadcast_shapes( 2, shapes, ndims, out );\n    if ( status != 0 ) {\n        printf( \"incompatible shapes\\n\" );\n        return 1;\n    }\n    int64_t i;\n    printf( \"shape = ( \" );\n    for ( i = 0; i \u003c N1; i++ ) {\n        printf( \"%\"PRId64\"\", out[ i ] );\n        if ( i \u003c N1-1 ) {\n            printf( \", \" );\n        }\n    }\n    printf( \" )\\n\" );\n    return 0;\n}\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.c --\u003e\n\n\u003c!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"references\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.references --\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-2025. 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/ndarray-base-broadcast-shapes.svg\n[npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-broadcast-shapes\n\n[test-image]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-broadcast-shapes/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-broadcast-shapes?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/ndarray-base-broadcast-shapes.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/ndarray-base-broadcast-shapes/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\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/ndarray-base-broadcast-shapes/tree/deno\n[deno-readme]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/umd\n[umd-readme]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm\n[esm-readme]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-broadcast-shapes/main/LICENSE\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fndarray-base-broadcast-shapes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fndarray-base-broadcast-shapes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fndarray-base-broadcast-shapes/lists"}