From 051a9cb8131367fb7b362c291188084a2735c456 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 7 Oct 2023 13:38:10 +0000 Subject: [PATCH 01/64] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index b55435c..686b559 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,7 @@ "@stdlib/assert-is-ndarray-like": "^0.1.0", "@stdlib/assert-is-nonnegative-integer": "^0.1.0", "@stdlib/ndarray-broadcast-array": "github:stdlib-js/ndarray-broadcast-array#main", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.1.0" }, "devDependencies": { From fb3d2dd42769059113c4eb24d84d89a9b9db9c57 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 7 Oct 2023 15:05:49 +0000 Subject: [PATCH 02/64] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 247 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 128 - package.json | 64 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 577 -- test/test.js | 577 -- 42 files changed, 6204 insertions(+), 5143 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 079ee5d..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -170,7 +163,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -230,9 +223,9 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2042a23..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index 9800802..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6cd202b..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 212ce6f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var v=g(function(q,s){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function l(e,r){var n,i,t,a;if(!m(e))throw new TypeError(u('null4f',e));if(!d(r))throw new TypeError(u("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",r));if(i=r.length,n=e.shape,n.length===i){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = x.shape;\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACX,EAAeM,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACL,EAAcM,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKF,EAAE,MAGFE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACT,EAAsBQ,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOP,EAAWG,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOH,EAAWG,EAAGC,CAAM,CAC5B,CAKAR,EAAO,QAAUM,ICjEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index 2b00bf3..fd2df4c 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3ab2bc3 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";function i(i,a){var o,d,m,l;if(!e(i))throw new TypeError(s("invalid argument. First argument must be an ndarray. Value: `%s`.",i));if(!r(a))throw new TypeError(s("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",a));if(d=a.length,(o=i.shape).length===d){for(l=0;l\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = x.shape;\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","isNonNegativeInteger","join","broadcast"],"mappings":";;0eA0FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,oEAAqER,IAEnG,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKF,EAAEC,OAGCS,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLM,EAAsBP,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMW,KAAM,KAAQ,MAGpJ,GAAKV,EAAIG,KAAQD,EAEhB,OAAOS,EAAWb,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOa,EAAWb,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 26d17a2..0000000 --- a/lib/main.js +++ /dev/null @@ -1,128 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); - } - N = shape.length; - sh = x.shape; - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index 686b559..72bd6ab 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/assert-is-ndarray-like": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/ndarray-broadcast-array": "github:stdlib-js/ndarray-broadcast-array#main", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.1.0" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.1.0", - "@stdlib/bench": "^0.1.0", - "@stdlib/ndarray-array": "^0.1.0", - "@stdlib/ndarray-base-assert-is-read-only": "^0.1.1", - "@stdlib/ndarray-base-ctor": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/ndarray-ctor": "^0.1.0", - "@stdlib/ndarray-ind2sub": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -87,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..a6aaf24 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index c807829..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From a4040020bf52206002a08c5dabb991c81c4804c8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 14 Oct 2023 19:25:28 +0000 Subject: [PATCH 03/64] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 28fc0c6..a2073bd 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,7 @@ "@stdlib/assert-is-ndarray-like": "^0.1.0", "@stdlib/assert-is-nonnegative-integer": "^0.1.0", "@stdlib/ndarray-broadcast-array": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.1.0" }, "devDependencies": { From 0e8dc44498c61508b4c0926b4e8a8e20f9a4d4fc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 14 Oct 2023 19:26:00 +0000 Subject: [PATCH 04/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6261 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index fd2df4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( `@stdlib/ndarray/array` ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 3ab2bc3..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";function i(i,a){var o,d,m,l;if(!e(i))throw new TypeError(s("invalid argument. First argument must be an ndarray. Value: `%s`.",i));if(!r(a))throw new TypeError(s("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",a));if(d=a.length,(o=i.shape).length===d){for(l=0;l\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = x.shape;\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","isNonNegativeInteger","join","broadcast"],"mappings":";;0eA0FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,oEAAqER,IAEnG,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKF,EAAEC,OAGCS,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLM,EAAsBP,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMW,KAAM,KAAQ,MAGpJ,GAAKV,EAAIG,KAAQD,EAEhB,OAAOS,EAAWb,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOa,EAAWb,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a6aaf24..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From dcc6da10ec9928376b9b8efb4b4b4ed75718b93a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 14 Oct 2023 19:27:12 +0000 Subject: [PATCH 05/64] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 128 - package.json | 64 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 -- 42 files changed, 6204 insertions(+), 4607 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 079ee5d..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -170,7 +163,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -230,9 +223,9 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2042a23..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index 9800802..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6cd202b..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cf4ed7f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var v=g(function(q,s){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function l(e,r){var n,i,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(i=r.length,n=e.shape,n.length===i){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = x.shape;\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACX,EAAeM,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACL,EAAcM,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKF,EAAE,MAGFE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACT,EAAsBQ,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOP,EAAWG,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOH,EAAWG,EAAGC,CAAM,CAC5B,CAKAR,EAAO,QAAUM,ICjEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index 2b00bf3..fd2df4c 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7d58e9d --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";function i(i,a){var o,d,m,l;if(!e(i))throw new TypeError(s("invalid argument. First argument must be an ndarray. Value: `%s`.",i));if(!r(a))throw new TypeError(s("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",a));if(d=a.length,(o=i.shape).length===d){for(l=0;l\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = x.shape;\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","isNonNegativeInteger","join","broadcast"],"mappings":";;ifA0FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,oEAAqER,IAEnG,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKF,EAAEC,OAGCS,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLM,EAAsBP,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMW,KAAM,KAAQ,MAGpJ,GAAKV,EAAIG,KAAQD,EAEhB,OAAOS,EAAWb,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOa,EAAWb,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 26d17a2..0000000 --- a/lib/main.js +++ /dev/null @@ -1,128 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); - } - N = shape.length; - sh = x.shape; - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index a2073bd..2bc4a9c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/assert-is-ndarray-like": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/ndarray-broadcast-array": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.1.0" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.1.1", - "@stdlib/bench": "^0.1.0", - "@stdlib/ndarray-array": "^0.1.0", - "@stdlib/ndarray-base-assert-is-read-only": "^0.1.1", - "@stdlib/ndarray-base-ctor": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/ndarray-ctor": "^0.1.0", - "@stdlib/ndarray-ind2sub": "^0.1.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -87,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..109a491 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From c38468c713a765e6fc269982c22abba3c2024a83 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 14 Oct 2023 19:27:48 +0000 Subject: [PATCH 06/64] Update README.md for ESM bundle v0.1.0 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 74c3023..dc5a32a 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.1.0-esm/index.mjs'; ``` #### maybeBroadcastArray( x, shape ) @@ -106,7 +106,7 @@ var y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); import array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@esm/index.mjs'; import numel from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs'; import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; -import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.1.0-esm/index.mjs'; // Create a 2x2 array: var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); From ecffc56cc62e6baf95c6ba2968966477af991814 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 14 Oct 2023 19:27:49 +0000 Subject: [PATCH 07/64] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dc5a32a..86f6c96 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tags). For example, + ```javascript import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.1.0-esm/index.mjs'; ``` @@ -106,7 +111,7 @@ var y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); import array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@esm/index.mjs'; import numel from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs'; import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; -import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.1.0-esm/index.mjs'; +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; // Create a 2x2 array: var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); From b4e9dc9c1b007ae16ba02e9e7ad91b348d621a8b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Nov 2023 17:59:17 +0000 Subject: [PATCH 08/64] Transform error messages --- lib/main.js | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/main.js b/lib/main.js index 26d17a2..cace557 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); var isCollection = require( '@stdlib/assert-is-collection' ); var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -95,7 +95,7 @@ function maybeBroadcastArray( x, shape ) { var i; if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); + throw new TypeError( format( 'null4f,Pc', x ) ); } if ( !isCollection( shape ) ) { throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); diff --git a/package.json b/package.json index 28fc0c6..a2073bd 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,7 @@ "@stdlib/assert-is-ndarray-like": "^0.1.0", "@stdlib/assert-is-nonnegative-integer": "^0.1.0", "@stdlib/ndarray-broadcast-array": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.1.0" }, "devDependencies": { From ca5d351270ee4c2daf693c192450fc33d6eb8988 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 3 Nov 2023 02:56:31 +0000 Subject: [PATCH 09/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6261 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index fd2df4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( `@stdlib/ndarray/array` ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7d58e9d..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";function i(i,a){var o,d,m,l;if(!e(i))throw new TypeError(s("invalid argument. First argument must be an ndarray. Value: `%s`.",i));if(!r(a))throw new TypeError(s("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",a));if(d=a.length,(o=i.shape).length===d){for(l=0;l\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = x.shape;\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","isNonNegativeInteger","join","broadcast"],"mappings":";;ifA0FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,oEAAqER,IAEnG,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKF,EAAEC,OAGCS,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLM,EAAsBP,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMW,KAAM,KAAQ,MAGpJ,GAAKV,EAAIG,KAAQD,EAEhB,OAAOS,EAAWb,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOa,EAAWb,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 109a491..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 07860fda7378de21a6a48c77db45ad87cdfc38e4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 3 Nov 2023 02:57:36 +0000 Subject: [PATCH 10/64] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 128 - package.json | 64 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 -- 43 files changed, 6204 insertions(+), 4608 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 48cd15a..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-11-01T05:52:43.889Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 079ee5d..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -170,7 +163,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -230,9 +223,9 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2042a23..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index 9800802..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6cd202b..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cf4ed7f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var v=g(function(q,s){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function l(e,r){var n,i,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(i=r.length,n=e.shape,n.length===i){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = x.shape;\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACX,EAAeM,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACL,EAAcM,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKF,EAAE,MAGFE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACT,EAAsBQ,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOP,EAAWG,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOH,EAAWG,EAAGC,CAAM,CAC5B,CAKAR,EAAO,QAAUM,ICjEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index 2b00bf3..fd2df4c 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..979ad37 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";function i(i,o){var a,d,m,l;if(!e(i))throw new TypeError(s("null4f,Pc",i));if(!r(o))throw new TypeError(s("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",o));if(d=o.length,(a=i.shape).length===d){for(l=0;l\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'null4f,Pc', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = x.shape;\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","isNonNegativeInteger","join","broadcast"],"mappings":";;0fA0FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,YAAaR,IAE3C,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKF,EAAEC,OAGCS,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLM,EAAsBP,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMW,KAAM,KAAQ,MAGpJ,GAAKV,EAAIG,KAAQD,EAEhB,OAAOS,EAAWb,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOa,EAAWb,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index cace557..0000000 --- a/lib/main.js +++ /dev/null @@ -1,128 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'null4f,Pc', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); - } - N = shape.length; - sh = x.shape; - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index a2073bd..2bc4a9c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/assert-is-ndarray-like": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/ndarray-broadcast-array": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.1.0" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.1.1", - "@stdlib/bench": "^0.1.0", - "@stdlib/ndarray-array": "^0.1.0", - "@stdlib/ndarray-base-assert-is-read-only": "^0.1.1", - "@stdlib/ndarray-base-ctor": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/ndarray-ctor": "^0.1.0", - "@stdlib/ndarray-ind2sub": "^0.1.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -87,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..b1cb358 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From 0b700fddce4a88c69a2f842227e300444d9a3848 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 9 Nov 2023 13:26:47 +0000 Subject: [PATCH 11/64] Transform error messages --- lib/main.js | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/main.js b/lib/main.js index 26d17a2..cace557 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); var isCollection = require( '@stdlib/assert-is-collection' ); var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -95,7 +95,7 @@ function maybeBroadcastArray( x, shape ) { var i; if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); + throw new TypeError( format( 'null4f,Pc', x ) ); } if ( !isCollection( shape ) ) { throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); diff --git a/package.json b/package.json index c3b5a28..ff959b9 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,7 @@ "@stdlib/assert-is-ndarray-like": "^0.1.0", "@stdlib/assert-is-nonnegative-integer": "^0.1.0", "@stdlib/ndarray-broadcast-array": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0" }, "devDependencies": { From 224ec40aa8cd810ecd8335c9e8184909134810f8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 9 Nov 2023 17:17:58 +0000 Subject: [PATCH 12/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6261 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index fd2df4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( `@stdlib/ndarray/array` ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 979ad37..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";function i(i,o){var a,d,m,l;if(!e(i))throw new TypeError(s("null4f,Pc",i));if(!r(o))throw new TypeError(s("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",o));if(d=o.length,(a=i.shape).length===d){for(l=0;l\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'null4f,Pc', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = x.shape;\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","isNonNegativeInteger","join","broadcast"],"mappings":";;0fA0FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,YAAaR,IAE3C,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKF,EAAEC,OAGCS,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLM,EAAsBP,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMW,KAAM,KAAQ,MAGpJ,GAAKV,EAAIG,KAAQD,EAEhB,OAAOS,EAAWb,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOa,EAAWb,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index b1cb358..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From ae505fb6ea70660a0c6b713c8a5ae8cdcd352949 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 9 Nov 2023 17:18:50 +0000 Subject: [PATCH 13/64] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 128 - package.json | 64 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 -- 42 files changed, 6206 insertions(+), 4609 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 079ee5d..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -178,7 +171,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -238,15 +231,15 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2042a23..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index 9800802..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6cd202b..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cf4ed7f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var v=g(function(q,s){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function l(e,r){var n,i,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(i=r.length,n=e.shape,n.length===i){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = x.shape;\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACX,EAAeM,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACL,EAAcM,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKF,EAAE,MAGFE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACT,EAAsBQ,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOP,EAAWG,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOH,EAAWG,EAAGC,CAAM,CAC5B,CAKAR,EAAO,QAAUM,ICjEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index 2b00bf3..fd2df4c 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..979ad37 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";function i(i,o){var a,d,m,l;if(!e(i))throw new TypeError(s("null4f,Pc",i));if(!r(o))throw new TypeError(s("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",o));if(d=o.length,(a=i.shape).length===d){for(l=0;l\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'null4f,Pc', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = x.shape;\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","isNonNegativeInteger","join","broadcast"],"mappings":";;0fA0FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,YAAaR,IAE3C,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKF,EAAEC,OAGCS,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLM,EAAsBP,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMW,KAAM,KAAQ,MAGpJ,GAAKV,EAAIG,KAAQD,EAEhB,OAAOS,EAAWb,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOa,EAAWb,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index cace557..0000000 --- a/lib/main.js +++ /dev/null @@ -1,128 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'null4f,Pc', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); - } - N = shape.length; - sh = x.shape; - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index ff959b9..2bc4a9c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/assert-is-ndarray-like": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/ndarray-broadcast-array": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.1.1", - "@stdlib/bench": "^0.2.0", - "@stdlib/ndarray-array": "^0.1.0", - "@stdlib/ndarray-base-assert-is-read-only": "^0.1.1", - "@stdlib/ndarray-base-ctor": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/ndarray-ctor": "^0.1.0", - "@stdlib/ndarray-ind2sub": "^0.1.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -87,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..52645f5 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From 724067a6b1c1b67dd22d9f78e7a1ba77c657bfa7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Dec 2023 14:08:22 +0000 Subject: [PATCH 14/64] Transform error messages --- lib/main.js | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/main.js b/lib/main.js index 26d17a2..cace557 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); var isCollection = require( '@stdlib/assert-is-collection' ); var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -95,7 +95,7 @@ function maybeBroadcastArray( x, shape ) { var i; if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); + throw new TypeError( format( 'null4f,Pc', x ) ); } if ( !isCollection( shape ) ) { throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); diff --git a/package.json b/package.json index 6861cec..8d70fb0 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,7 @@ "@stdlib/assert-is-ndarray-like": "^0.1.0", "@stdlib/assert-is-nonnegative-integer": "^0.1.0", "@stdlib/ndarray-broadcast-array": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0" }, "devDependencies": { From 6dd21b3d28d77dba623fe8c7f15137de64219507 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 12:23:14 +0000 Subject: [PATCH 15/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6261 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index fd2df4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( `@stdlib/ndarray/array` ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 979ad37..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";function i(i,o){var a,d,m,l;if(!e(i))throw new TypeError(s("null4f,Pc",i));if(!r(o))throw new TypeError(s("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",o));if(d=o.length,(a=i.shape).length===d){for(l=0;l\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'null4f,Pc', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = x.shape;\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","isNonNegativeInteger","join","broadcast"],"mappings":";;0fA0FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,YAAaR,IAE3C,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKF,EAAEC,OAGCS,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLM,EAAsBP,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMW,KAAM,KAAQ,MAGpJ,GAAKV,EAAIG,KAAQD,EAEhB,OAAOS,EAAWb,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOa,EAAWb,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 52645f5..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 776d290024cd0614e573cf1c286150f4b66f2482 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 12:24:03 +0000 Subject: [PATCH 16/64] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 128 - package.json | 64 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 -- 43 files changed, 6206 insertions(+), 4605 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 9a6708a..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-12-01T05:58:26.426Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 079ee5d..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -178,7 +171,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -238,15 +231,15 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2042a23..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index 9800802..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6cd202b..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cf4ed7f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var v=g(function(q,s){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function l(e,r){var n,i,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(i=r.length,n=e.shape,n.length===i){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = x.shape;\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACX,EAAeM,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACL,EAAcM,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKF,EAAE,MAGFE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACT,EAAsBQ,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOP,EAAWG,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOH,EAAWG,EAAGC,CAAM,CAC5B,CAKAR,EAAO,QAAUM,ICjEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index 2b00bf3..fd2df4c 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..979ad37 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";function i(i,o){var a,d,m,l;if(!e(i))throw new TypeError(s("null4f,Pc",i));if(!r(o))throw new TypeError(s("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",o));if(d=o.length,(a=i.shape).length===d){for(l=0;l\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'null4f,Pc', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = x.shape;\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","isNonNegativeInteger","join","broadcast"],"mappings":";;0fA0FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,YAAaR,IAE3C,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKF,EAAEC,OAGCS,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLM,EAAsBP,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMW,KAAM,KAAQ,MAGpJ,GAAKV,EAAIG,KAAQD,EAEhB,OAAOS,EAAWb,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOa,EAAWb,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index cace557..0000000 --- a/lib/main.js +++ /dev/null @@ -1,128 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'null4f,Pc', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); - } - N = shape.length; - sh = x.shape; - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index 8d70fb0..2bc4a9c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/assert-is-ndarray-like": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/ndarray-broadcast-array": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.1.1", - "@stdlib/bench": "^0.2.1", - "@stdlib/ndarray-array": "^0.1.0", - "@stdlib/ndarray-base-assert-is-read-only": "^0.1.1", - "@stdlib/ndarray-base-ctor": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/ndarray-ctor": "^0.1.0", - "@stdlib/ndarray-ind2sub": "^0.1.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -87,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..93de7b9 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From 3f110b9f9616cdb7af10b0b49499dfa591c2669c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 28 Dec 2023 10:26:02 +0000 Subject: [PATCH 17/64] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 5c237fe..c16a2bf 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "@stdlib/assert-is-nonnegative-integer": "^0.1.0", "@stdlib/ndarray-broadcast-array": "^0.1.0", "@stdlib/ndarray-shape": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0" }, "devDependencies": { From 74d3ee312017a6e9a5b61aa799a4c3f93f2a5a05 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 28 Dec 2023 10:26:30 +0000 Subject: [PATCH 18/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6261 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index fd2df4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( `@stdlib/ndarray/array` ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 979ad37..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";function i(i,o){var a,d,m,l;if(!e(i))throw new TypeError(s("null4f,Pc",i));if(!r(o))throw new TypeError(s("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",o));if(d=o.length,(a=i.shape).length===d){for(l=0;l\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'null4f,Pc', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = x.shape;\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","isNonNegativeInteger","join","broadcast"],"mappings":";;0fA0FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,YAAaR,IAE3C,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKF,EAAEC,OAGCS,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLM,EAAsBP,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMW,KAAM,KAAQ,MAGpJ,GAAKV,EAAIG,KAAQD,EAEhB,OAAOS,EAAWb,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOa,EAAWb,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 93de7b9..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From c11b64da1a237469ef38f4237245e2b2c721353f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 28 Dec 2023 10:27:03 +0000 Subject: [PATCH 19/64] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 129 - package.json | 65 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 -- 43 files changed, 6206 insertions(+), 4612 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 30656c4..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c92f5c4..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 113729f..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -178,7 +171,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -238,15 +231,15 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index a18fb31..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index f086e25..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6cd202b..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index ce222f6..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=g(function(w,v){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),l=require('@stdlib/ndarray-shape/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function y(e,r){var i,n,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(n=r.length,i=l(e),i.length===n){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAW,QAAS,uBAAwB,EAC5CC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACZ,EAAeO,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACN,EAAcO,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKL,EAAUG,CAAE,EAGZE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACV,EAAsBS,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOR,EAAWI,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOJ,EAAWI,EAAGC,CAAM,CAC5B,CAKAT,EAAO,QAAUO,IClEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "getShape", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index 2b00bf3..fd2df4c 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..42e8bda --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";function a(a,d){var m,o,l,g;if(!e(a))throw new TypeError(i("invalid argument. First argument must be an ndarray. Value: `%s`.",a));if(!r(d))throw new TypeError(i("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",d));if(o=d.length,(m=s(a)).length===o){for(g=0;g\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;ykBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,oEAAqER,IAEnG,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMY,KAAM,KAAQ,MAGpJ,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 7de2ca6..0000000 --- a/lib/main.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); - } - N = shape.length; - sh = getShape( x ); - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index c16a2bf..2bc4a9c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/assert-is-ndarray-like": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/ndarray-broadcast-array": "^0.1.0", - "@stdlib/ndarray-shape": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.1.1", - "@stdlib/ndarray-array": "^0.1.0", - "@stdlib/ndarray-base-assert-is-read-only": "^0.1.1", - "@stdlib/ndarray-base-ctor": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/ndarray-ctor": "^0.1.0", - "@stdlib/ndarray-ind2sub": "^0.1.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -88,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f486c75 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From 1b2a3bcd14128d92c53c4a496c22d7252b038f80 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 08:28:56 +0000 Subject: [PATCH 20/64] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 5c237fe..c16a2bf 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "@stdlib/assert-is-nonnegative-integer": "^0.1.0", "@stdlib/ndarray-broadcast-array": "^0.1.0", "@stdlib/ndarray-shape": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0" }, "devDependencies": { From 2d26f451a218bb9792e6c94f4d31ad016d1a5f5b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 15:07:43 +0000 Subject: [PATCH 21/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6261 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index fd2df4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( `@stdlib/ndarray/array` ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 42e8bda..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";function a(a,d){var m,o,l,g;if(!e(a))throw new TypeError(i("invalid argument. First argument must be an ndarray. Value: `%s`.",a));if(!r(d))throw new TypeError(i("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",d));if(o=d.length,(m=s(a)).length===o){for(g=0;g\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;ykBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,oEAAqER,IAEnG,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMY,KAAM,KAAQ,MAGpJ,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f486c75..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From b71c72807157d035ec655e2ffbcce0a7408d4cca Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 15:08:17 +0000 Subject: [PATCH 22/64] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 129 - package.json | 65 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 -- 44 files changed, 6206 insertions(+), 4613 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index be7b0b7..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-01-01T05:28:15.650Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 30656c4..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c92f5c4..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 113729f..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -178,7 +171,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -238,15 +231,15 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index a18fb31..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index f086e25..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6cd202b..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index ce222f6..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=g(function(w,v){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),l=require('@stdlib/ndarray-shape/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function y(e,r){var i,n,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(n=r.length,i=l(e),i.length===n){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAW,QAAS,uBAAwB,EAC5CC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACZ,EAAeO,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACN,EAAcO,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKL,EAAUG,CAAE,EAGZE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACV,EAAsBS,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOR,EAAWI,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOJ,EAAWI,EAAGC,CAAM,CAC5B,CAKAT,EAAO,QAAUO,IClEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "getShape", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index 2b00bf3..fd2df4c 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3871fcb --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";function a(a,d){var m,o,l,g;if(!e(a))throw new TypeError(i("invalid argument. First argument must be an ndarray. Value: `%s`.",a));if(!r(d))throw new TypeError(i("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",d));if(o=d.length,(m=s(a)).length===o){for(g=0;g\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;ykBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,oEAAqER,IAEnG,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMY,KAAM,KAAQ,MAGpJ,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 7de2ca6..0000000 --- a/lib/main.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); - } - N = shape.length; - sh = getShape( x ); - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index c16a2bf..2bc4a9c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/assert-is-ndarray-like": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/ndarray-broadcast-array": "^0.1.0", - "@stdlib/ndarray-shape": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.1.1", - "@stdlib/ndarray-array": "^0.1.0", - "@stdlib/ndarray-base-assert-is-read-only": "^0.1.1", - "@stdlib/ndarray-base-ctor": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/ndarray-ctor": "^0.1.0", - "@stdlib/ndarray-ind2sub": "^0.1.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -88,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..7564de0 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From c03fd5fa0c0a0a42169b2a6c16699a9b54b3fda2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 15 Jan 2024 07:13:36 +0000 Subject: [PATCH 23/64] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 5c237fe..c16a2bf 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "@stdlib/assert-is-nonnegative-integer": "^0.1.0", "@stdlib/ndarray-broadcast-array": "^0.1.0", "@stdlib/ndarray-shape": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0" }, "devDependencies": { From e74a8d5e2ecd99d9493da1d73b5b92d94419a61c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 15 Jan 2024 07:14:11 +0000 Subject: [PATCH 24/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6261 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index fd2df4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( `@stdlib/ndarray/array` ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 3871fcb..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";function a(a,d){var m,o,l,g;if(!e(a))throw new TypeError(i("invalid argument. First argument must be an ndarray. Value: `%s`.",a));if(!r(d))throw new TypeError(i("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",d));if(o=d.length,(m=s(a)).length===o){for(g=0;g\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;ykBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,oEAAqER,IAEnG,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMY,KAAM,KAAQ,MAGpJ,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 7564de0..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From a3477a1143849a490244cb41ed5d9ce184d69d36 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 15 Jan 2024 07:14:36 +0000 Subject: [PATCH 25/64] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 51 +- SECURITY.md | 5 - benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 129 - package.json | 65 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 -- 43 files changed, 6207 insertions(+), 4613 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 30656c4..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c92f5c4..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 113729f..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -179,7 +172,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -239,17 +232,17 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm -[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays +[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index a18fb31..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index f086e25..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6cd202b..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index ce222f6..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=g(function(w,v){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),l=require('@stdlib/ndarray-shape/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function y(e,r){var i,n,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(n=r.length,i=l(e),i.length===n){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAW,QAAS,uBAAwB,EAC5CC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACZ,EAAeO,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACN,EAAcO,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKL,EAAUG,CAAE,EAGZE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACV,EAAsBS,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOR,EAAWI,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOJ,EAAWI,EAAGC,CAAM,CAC5B,CAKAT,EAAO,QAAUO,IClEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "getShape", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index e465de2..9e5da3a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3871fcb --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";function a(a,d){var m,o,l,g;if(!e(a))throw new TypeError(i("invalid argument. First argument must be an ndarray. Value: `%s`.",a));if(!r(d))throw new TypeError(i("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",d));if(o=d.length,(m=s(a)).length===o){for(g=0;g\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;ykBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,oEAAqER,IAEnG,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMY,KAAM,KAAQ,MAGpJ,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 7de2ca6..0000000 --- a/lib/main.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); - } - N = shape.length; - sh = getShape( x ); - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index c16a2bf..2bc4a9c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/assert-is-ndarray-like": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/ndarray-broadcast-array": "^0.1.0", - "@stdlib/ndarray-shape": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.1.1", - "@stdlib/ndarray-array": "^0.1.0", - "@stdlib/ndarray-base-assert-is-read-only": "^0.1.1", - "@stdlib/ndarray-base-ctor": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/ndarray-ctor": "^0.1.0", - "@stdlib/ndarray-ind2sub": "^0.1.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -88,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..a3ef0ca --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From 0aa5fb8eda7f40ea70e839d289d7f1965ad41b37 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 09:06:23 +0000 Subject: [PATCH 26/64] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 5c237fe..c16a2bf 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "@stdlib/assert-is-nonnegative-integer": "^0.1.0", "@stdlib/ndarray-broadcast-array": "^0.1.0", "@stdlib/ndarray-shape": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0" }, "devDependencies": { From a242f55c3f5c3d7d0b530a617075fa55510a634a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 14:28:57 +0000 Subject: [PATCH 27/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6261 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 9e5da3a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 3871fcb..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";function a(a,d){var m,o,l,g;if(!e(a))throw new TypeError(i("invalid argument. First argument must be an ndarray. Value: `%s`.",a));if(!r(d))throw new TypeError(i("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",d));if(o=d.length,(m=s(a)).length===o){for(g=0;g\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;ykBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,oEAAqER,IAEnG,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMY,KAAM,KAAQ,MAGpJ,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a3ef0ca..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 4ec280f6c750a895aadd04eb1944994f482c94fc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 14:29:26 +0000 Subject: [PATCH 28/64] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 53 +- SECURITY.md | 5 - benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 129 - package.json | 65 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 -- 44 files changed, 6207 insertions(+), 4619 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 12b6bce..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-02-01T06:22:50.151Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 30656c4..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c92f5c4..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 113729f..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -181,7 +172,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -244,17 +235,17 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm -[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays +[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index a18fb31..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index f086e25..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 271b2b8..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index ce222f6..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=g(function(w,v){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),l=require('@stdlib/ndarray-shape/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function y(e,r){var i,n,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(n=r.length,i=l(e),i.length===n){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAW,QAAS,uBAAwB,EAC5CC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACZ,EAAeO,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACN,EAAcO,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKL,EAAUG,CAAE,EAGZE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACV,EAAsBS,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOR,EAAWI,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOJ,EAAWI,EAAGC,CAAM,CAC5B,CAKAT,EAAO,QAAUO,IClEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "getShape", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index e465de2..9e5da3a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3871fcb --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";function a(a,d){var m,o,l,g;if(!e(a))throw new TypeError(i("invalid argument. First argument must be an ndarray. Value: `%s`.",a));if(!r(d))throw new TypeError(i("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",d));if(o=d.length,(m=s(a)).length===o){for(g=0;g\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;ykBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,oEAAqER,IAEnG,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMY,KAAM,KAAQ,MAGpJ,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 7de2ca6..0000000 --- a/lib/main.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); - } - N = shape.length; - sh = getShape( x ); - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index c16a2bf..2bc4a9c 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/assert-is-ndarray-like": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/ndarray-broadcast-array": "^0.1.0", - "@stdlib/ndarray-shape": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.1.1", - "@stdlib/ndarray-array": "^0.1.0", - "@stdlib/ndarray-base-assert-is-read-only": "^0.1.1", - "@stdlib/ndarray-base-ctor": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/ndarray-ctor": "^0.1.0", - "@stdlib/ndarray-ind2sub": "^0.1.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -88,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..96922a3 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From f81e746887b6b57cdadee03afdd921a4ff3568c5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 01:14:23 +0000 Subject: [PATCH 29/64] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index b6b827b..f221b73 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "@stdlib/assert-is-nonnegative-integer": "^0.2.0", "@stdlib/ndarray-broadcast-array": "^0.2.0", "@stdlib/ndarray-shape": "^0.2.0", - "@stdlib/string-format": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.2.0", "@stdlib/types": "^0.3.1" }, "devDependencies": { From 9909507774628c77eac5009cd28afcc47ba6a2ec Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 04:41:29 +0000 Subject: [PATCH 30/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6261 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 9e5da3a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 3871fcb..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";function a(a,d){var m,o,l,g;if(!e(a))throw new TypeError(i("invalid argument. First argument must be an ndarray. Value: `%s`.",a));if(!r(d))throw new TypeError(i("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",d));if(o=d.length,(m=s(a)).length===o){for(g=0;g\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;ykBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,oEAAqER,IAEnG,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMY,KAAM,KAAQ,MAGpJ,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 96922a3..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 706351a139726591ba3ab6d6785de34498468c8b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 04:42:09 +0000 Subject: [PATCH 31/64] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 53 +- SECURITY.md | 5 - benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 129 - package.json | 65 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 -- 43 files changed, 6207 insertions(+), 4622 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index a858d38..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -181,7 +172,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -244,17 +235,17 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm -[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays +[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index a18fb31..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index f086e25..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 271b2b8..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index ce222f6..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=g(function(w,v){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),l=require('@stdlib/ndarray-shape/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function y(e,r){var i,n,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(n=r.length,i=l(e),i.length===n){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAW,QAAS,uBAAwB,EAC5CC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACZ,EAAeO,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACN,EAAcO,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKL,EAAUG,CAAE,EAGZE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACV,EAAsBS,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOR,EAAWI,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOJ,EAAWI,EAAGC,CAAM,CAC5B,CAKAT,EAAO,QAAUO,IClEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "getShape", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index e465de2..9e5da3a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7882cd0 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";function a(a,d){var m,o,l,g;if(!e(a))throw new TypeError(i("invalid argument. First argument must be an ndarray. Value: `%s`.",a));if(!r(d))throw new TypeError(i("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",d));if(o=d.length,(m=s(a)).length===o){for(g=0;g\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;ykBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,oEAAqER,IAEnG,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMY,KAAM,KAAQ,MAGpJ,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 7de2ca6..0000000 --- a/lib/main.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); - } - N = shape.length; - sh = getShape( x ); - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index f221b73..6854000 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.0", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.2.0", - "@stdlib/assert-is-ndarray-like": "^0.2.0", - "@stdlib/assert-is-nonnegative-integer": "^0.2.0", - "@stdlib/ndarray-broadcast-array": "^0.2.0", - "@stdlib/ndarray-shape": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.0", - "@stdlib/types": "^0.3.1" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.2.0", - "@stdlib/ndarray-array": "^0.1.0", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.0", - "@stdlib/ndarray-base-ctor": "^0.2.0", - "@stdlib/ndarray-base-numel": "^0.2.0", - "@stdlib/ndarray-ctor": "^0.1.0", - "@stdlib/ndarray-ind2sub": "^0.1.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.0" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -88,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d76cb39 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From b790b89f4bc73cc13b4e1082fb140cdd162b7fa6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:34:46 +0000 Subject: [PATCH 32/64] Update README.md for ESM bundle v0.2.0 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 95e0ee3..ef7741d 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.2.0-esm/index.mjs'; ``` #### maybeBroadcastArray( x, shape ) @@ -106,7 +106,7 @@ var y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); import array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@esm/index.mjs'; import numel from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs'; import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; -import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.2.0-esm/index.mjs'; // Create a 2x2 array: var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); From ddcd26dc4c654f869657292fc6c1feadd34d8146 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:34:47 +0000 Subject: [PATCH 33/64] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ef7741d..c729ca9 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tags). For example, + ```javascript import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.2.0-esm/index.mjs'; ``` @@ -106,7 +111,7 @@ var y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); import array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@esm/index.mjs'; import numel from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs'; import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; -import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.2.0-esm/index.mjs'; +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; // Create a 2x2 array: var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); From d12f0f1ebb06b496dfb680d1c9a104b887fc88a9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 19:57:29 +0000 Subject: [PATCH 34/64] Transform error messages --- lib/main.js | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/main.js b/lib/main.js index 7de2ca6..751aba7 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var isCollection = require( '@stdlib/assert-is-collection' ); var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; var broadcast = require( '@stdlib/ndarray-broadcast-array' ); var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -96,10 +96,10 @@ function maybeBroadcastArray( x, shape ) { var i; if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); + throw new TypeError( format( '1k34f', x ) ); } if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '1k3F3', shape ) ); } N = shape.length; sh = getShape( x ); @@ -109,7 +109,7 @@ function maybeBroadcastArray( x, shape ) { for ( i = 0; i < N; i++ ) { d = shape[ i ]; if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); + throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); } // Check whether dimensions match... if ( sh[ i ] !== d ) { diff --git a/package.json b/package.json index ac44132..36de2e0 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "@stdlib/assert-is-nonnegative-integer": "^0.2.1", "@stdlib/ndarray-broadcast-array": "^0.2.1", "@stdlib/ndarray-shape": "^0.2.1", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, From ae2d1750fc53ad483a3cdbd0fef1067bc7bcfd81 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 21:20:35 +0000 Subject: [PATCH 35/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6261 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 9e5da3a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7882cd0..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";function a(a,d){var m,o,l,g;if(!e(a))throw new TypeError(i("invalid argument. First argument must be an ndarray. Value: `%s`.",a));if(!r(d))throw new TypeError(i("invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.",d));if(o=d.length,(m=s(a)).length===o){for(g=0;g\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;ykBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,oEAAqER,IAEnG,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,2FAA4FP,IAM1H,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,2FAA4F,IAAMP,EAAMY,KAAM,KAAQ,MAGpJ,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index d76cb39..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From a6f40d26f6426db83e57dafb9b479edb671ca1cf Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 21:20:56 +0000 Subject: [PATCH 36/64] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 53 +- SECURITY.md | 5 - benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 129 - package.json | 66 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 --- 43 files changed, 4872 insertions(+), 4617 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 041cc14..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -181,7 +172,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -244,17 +235,17 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm -[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays +[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index a18fb31..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index f086e25..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 271b2b8..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index ce222f6..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=g(function(w,v){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),l=require('@stdlib/ndarray-shape/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function y(e,r){var i,n,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(n=r.length,i=l(e),i.length===n){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAW,QAAS,uBAAwB,EAC5CC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACZ,EAAeO,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACN,EAAcO,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKL,EAAUG,CAAE,EAGZE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACV,EAAsBS,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOR,EAAWI,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOJ,EAAWI,EAAGC,CAAM,CAC5B,CAKAT,EAAO,QAAUO,IClEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "getShape", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index e465de2..9e5da3a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..2fe8f12 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 751aba7..0000000 --- a/lib/main.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( '1k34f', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( '1k3F3', shape ) ); - } - N = shape.length; - sh = getShape( x ); - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index 36de2e0..63f3156 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,44 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.2.1", - "@stdlib/assert-is-ndarray-like": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer": "^0.2.1", - "@stdlib/ndarray-broadcast-array": "^0.2.1", - "@stdlib/ndarray-shape": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.2.1", - "@stdlib/ndarray-array": "^0.2.0", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.1", - "@stdlib/ndarray-base-ctor": "^0.2.1", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/ndarray-ctor": "^0.2.0", - "@stdlib/ndarray-ind2sub": "^0.2.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -89,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..5e997cc --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From 5232e83e74e8da814db14b284f43256fea8fd237 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 21:59:42 +0000 Subject: [PATCH 37/64] Update README.md for ESM bundle v0.2.1 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 28aacd4..3439dfa 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.2.1-esm/index.mjs'; ``` #### maybeBroadcastArray( x, shape ) @@ -106,7 +106,7 @@ var y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); import array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@esm/index.mjs'; import numel from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs'; import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; -import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.2.1-esm/index.mjs'; // Create a 2x2 array: var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); From d4588fe7ff8122c374dfdb1e4cbee56600a52370 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 21:59:42 +0000 Subject: [PATCH 38/64] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3439dfa..18e4a85 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tags). For example, + ```javascript import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.2.1-esm/index.mjs'; ``` @@ -106,7 +111,7 @@ var y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); import array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@esm/index.mjs'; import numel from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs'; import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; -import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.2.1-esm/index.mjs'; +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; // Create a 2x2 array: var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); From 868f570bc6471f14a43511b87f8190abfe5d0170 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 08:22:25 +0000 Subject: [PATCH 39/64] Transform error messages --- lib/main.js | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/main.js b/lib/main.js index 7de2ca6..751aba7 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var isCollection = require( '@stdlib/assert-is-collection' ); var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; var broadcast = require( '@stdlib/ndarray-broadcast-array' ); var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -96,10 +96,10 @@ function maybeBroadcastArray( x, shape ) { var i; if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); + throw new TypeError( format( '1k34f', x ) ); } if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '1k3F3', shape ) ); } N = shape.length; sh = getShape( x ); @@ -109,7 +109,7 @@ function maybeBroadcastArray( x, shape ) { for ( i = 0; i < N; i++ ) { d = shape[ i ]; if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); + throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); } // Check whether dimensions match... if ( sh[ i ] !== d ) { diff --git a/package.json b/package.json index 31f1567..54e71e2 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "@stdlib/assert-is-nonnegative-integer": "^0.2.1", "@stdlib/ndarray-broadcast-array": "^0.2.1", "@stdlib/ndarray-shape": "^0.2.1", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, From 592b375a5e6fb3c7a9ed3bcc5a01a5e44c56fb84 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 14:08:29 +0000 Subject: [PATCH 40/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4926 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 9e5da3a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 2fe8f12..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 5e997cc..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 95894cfe819da92e417c0a097b73475facb837b6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 14:08:51 +0000 Subject: [PATCH 41/64] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 53 +- SECURITY.md | 5 - benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 129 - package.json | 66 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 --- 44 files changed, 4872 insertions(+), 4619 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 0764b51..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-03-01T06:02:13.794Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 041cc14..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -181,7 +172,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -244,17 +235,17 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm -[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays +[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index a18fb31..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index f086e25..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 271b2b8..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index ce222f6..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=g(function(w,v){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),l=require('@stdlib/ndarray-shape/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function y(e,r){var i,n,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(n=r.length,i=l(e),i.length===n){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAW,QAAS,uBAAwB,EAC5CC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACZ,EAAeO,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACN,EAAcO,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKL,EAAUG,CAAE,EAGZE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACV,EAAsBS,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOR,EAAWI,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOJ,EAAWI,EAAGC,CAAM,CAC5B,CAKAT,EAAO,QAAUO,IClEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "getShape", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index e465de2..9e5da3a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..cc3447b --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 751aba7..0000000 --- a/lib/main.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( '1k34f', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( '1k3F3', shape ) ); - } - N = shape.length; - sh = getShape( x ); - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index 54e71e2..63f3156 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,44 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.2.1", - "@stdlib/assert-is-ndarray-like": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer": "^0.2.1", - "@stdlib/ndarray-broadcast-array": "^0.2.1", - "@stdlib/ndarray-shape": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.2.1", - "@stdlib/ndarray-array": "^0.2.1", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.1", - "@stdlib/ndarray-base-ctor": "^0.2.1", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/ndarray-ctor": "^0.2.1", - "@stdlib/ndarray-ind2sub": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -89,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..2aba422 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From 5f4125a0bb49bb894db446e3c4135d0f56c117af Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 07:38:22 +0000 Subject: [PATCH 42/64] Transform error messages --- lib/main.js | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/main.js b/lib/main.js index 7de2ca6..751aba7 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var isCollection = require( '@stdlib/assert-is-collection' ); var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; var broadcast = require( '@stdlib/ndarray-broadcast-array' ); var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -96,10 +96,10 @@ function maybeBroadcastArray( x, shape ) { var i; if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); + throw new TypeError( format( '1k34f', x ) ); } if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '1k3F3', shape ) ); } N = shape.length; sh = getShape( x ); @@ -109,7 +109,7 @@ function maybeBroadcastArray( x, shape ) { for ( i = 0; i < N; i++ ) { d = shape[ i ]; if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); + throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); } // Check whether dimensions match... if ( sh[ i ] !== d ) { diff --git a/package.json b/package.json index 31f1567..54e71e2 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "@stdlib/assert-is-nonnegative-integer": "^0.2.1", "@stdlib/ndarray-broadcast-array": "^0.2.1", "@stdlib/ndarray-shape": "^0.2.1", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, From e0f64af3f98ea489df9b2f405a5e3d8a739dfbb8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 13:07:05 +0000 Subject: [PATCH 43/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4926 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 9e5da3a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index cc3447b..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2aba422..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 61d8d1a44d2bb310203bd11ce899adbcebd6e8b6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 13:07:19 +0000 Subject: [PATCH 44/64] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 53 +- SECURITY.md | 5 - benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 129 - package.json | 66 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 --- 44 files changed, 4872 insertions(+), 4622 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 20c4505..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-04-01T05:18:05.955Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 041cc14..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index ec90164..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -181,7 +172,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -244,17 +235,17 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm -[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays +[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index a18fb31..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index f086e25..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 271b2b8..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index ce222f6..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=g(function(w,v){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),l=require('@stdlib/ndarray-shape/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function y(e,r){var i,n,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(n=r.length,i=l(e),i.length===n){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAW,QAAS,uBAAwB,EAC5CC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACZ,EAAeO,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACN,EAAcO,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKL,EAAUG,CAAE,EAGZE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACV,EAAsBS,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOR,EAAWI,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOJ,EAAWI,EAAGC,CAAM,CAC5B,CAKAT,EAAO,QAAUO,IClEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "getShape", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index e465de2..9e5da3a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..cc3447b --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 751aba7..0000000 --- a/lib/main.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( '1k34f', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( '1k3F3', shape ) ); - } - N = shape.length; - sh = getShape( x ); - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index 54e71e2..63f3156 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,44 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.2.1", - "@stdlib/assert-is-ndarray-like": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer": "^0.2.1", - "@stdlib/ndarray-broadcast-array": "^0.2.1", - "@stdlib/ndarray-shape": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.2.1", - "@stdlib/ndarray-array": "^0.2.1", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.1", - "@stdlib/ndarray-base-ctor": "^0.2.1", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/ndarray-ctor": "^0.2.1", - "@stdlib/ndarray-ind2sub": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -89,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..2aba422 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From e8b60d5dd8ea5d4d6a0f3e7f6bd772c0ddece2ef Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 03:52:28 +0000 Subject: [PATCH 45/64] Transform error messages --- lib/main.js | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/main.js b/lib/main.js index 7de2ca6..751aba7 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var isCollection = require( '@stdlib/assert-is-collection' ); var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; var broadcast = require( '@stdlib/ndarray-broadcast-array' ); var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -96,10 +96,10 @@ function maybeBroadcastArray( x, shape ) { var i; if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); + throw new TypeError( format( '1k34f', x ) ); } if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '1k3F3', shape ) ); } N = shape.length; sh = getShape( x ); @@ -109,7 +109,7 @@ function maybeBroadcastArray( x, shape ) { for ( i = 0; i < N; i++ ) { d = shape[ i ]; if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); + throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); } // Check whether dimensions match... if ( sh[ i ] !== d ) { diff --git a/package.json b/package.json index 31f1567..54e71e2 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "@stdlib/assert-is-nonnegative-integer": "^0.2.1", "@stdlib/ndarray-broadcast-array": "^0.2.1", "@stdlib/ndarray-shape": "^0.2.1", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, From 016bb48b659efb89162c560c3a51c162df0b9d9f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 09:15:18 +0000 Subject: [PATCH 46/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4926 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 9e5da3a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index cc3447b..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2aba422..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 6701ac128093fddd7869ae87f4b98eea86275392 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 09:15:41 +0000 Subject: [PATCH 47/64] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 134 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 53 +- SECURITY.md | 5 - benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 129 - package.json | 66 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 --- 43 files changed, 4872 insertions(+), 4623 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 041cc14..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index ec90164..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -181,7 +172,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -244,17 +235,17 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm -[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays +[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index a18fb31..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index f086e25..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 271b2b8..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index ce222f6..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=g(function(w,v){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),l=require('@stdlib/ndarray-shape/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function y(e,r){var i,n,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(n=r.length,i=l(e),i.length===n){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAW,QAAS,uBAAwB,EAC5CC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACZ,EAAeO,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACN,EAAcO,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKL,EAAUG,CAAE,EAGZE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACV,EAAsBS,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOR,EAAWI,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOJ,EAAWI,EAAGC,CAAM,CAC5B,CAKAT,EAAO,QAAUO,IClEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "getShape", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index e465de2..9e5da3a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..cc3447b --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 751aba7..0000000 --- a/lib/main.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( '1k34f', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( '1k3F3', shape ) ); - } - N = shape.length; - sh = getShape( x ); - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index 54e71e2..63f3156 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,44 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.2.1", - "@stdlib/assert-is-ndarray-like": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer": "^0.2.1", - "@stdlib/ndarray-broadcast-array": "^0.2.1", - "@stdlib/ndarray-shape": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.2.1", - "@stdlib/ndarray-array": "^0.2.1", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.1", - "@stdlib/ndarray-base-ctor": "^0.2.1", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/ndarray-ctor": "^0.2.1", - "@stdlib/ndarray-ind2sub": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -89,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..2aba422 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From bf1f73c2b59f6b15fbb752b8e2fca778f2bf6024 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 03:24:32 +0000 Subject: [PATCH 48/64] Transform error messages --- lib/main.js | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/main.js b/lib/main.js index 7de2ca6..751aba7 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var isCollection = require( '@stdlib/assert-is-collection' ); var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; var broadcast = require( '@stdlib/ndarray-broadcast-array' ); var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -96,10 +96,10 @@ function maybeBroadcastArray( x, shape ) { var i; if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); + throw new TypeError( format( '1k34f', x ) ); } if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '1k3F3', shape ) ); } N = shape.length; sh = getShape( x ); @@ -109,7 +109,7 @@ function maybeBroadcastArray( x, shape ) { for ( i = 0; i < N; i++ ) { d = shape[ i ]; if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); + throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); } // Check whether dimensions match... if ( sh[ i ] !== d ) { diff --git a/package.json b/package.json index 08eeeba..1def50b 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "@stdlib/assert-is-nonnegative-integer": "^0.2.2", "@stdlib/ndarray-broadcast-array": "^0.2.1", "@stdlib/ndarray-shape": "^0.2.2", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.3.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, From e8bc6e88b630e75c1d1a600971d804865c495394 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 03:48:58 +0000 Subject: [PATCH 49/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4926 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 9e5da3a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index cc3447b..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2aba422..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 2b28a759008cbeee8c0777e5fc5e26e0c5904c27 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 03:49:14 +0000 Subject: [PATCH 50/64] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 107 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 53 +- SECURITY.md | 5 - benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 129 - package.json | 66 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 --- 43 files changed, 4872 insertions(+), 4738 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 041cc14..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -181,7 +172,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -244,17 +235,17 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm -[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays +[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index a18fb31..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index f086e25..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 271b2b8..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index ce222f6..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=g(function(w,v){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),l=require('@stdlib/ndarray-shape/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function y(e,r){var i,n,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(n=r.length,i=l(e),i.length===n){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAW,QAAS,uBAAwB,EAC5CC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACZ,EAAeO,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACN,EAAcO,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKL,EAAUG,CAAE,EAGZE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACV,EAAsBS,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOR,EAAWI,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOJ,EAAWI,EAAGC,CAAM,CAC5B,CAKAT,EAAO,QAAUO,IClEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "getShape", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index e465de2..9e5da3a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..81f95f3 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.2-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 751aba7..0000000 --- a/lib/main.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( '1k34f', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( '1k3F3', shape ) ); - } - N = shape.length; - sh = getShape( x ); - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index 1def50b..4394033 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,44 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/assert-is-ndarray-like": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer": "^0.2.2", - "@stdlib/ndarray-broadcast-array": "^0.2.1", - "@stdlib/ndarray-shape": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.2.2", - "@stdlib/ndarray-array": "^0.2.1", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.2", - "@stdlib/ndarray-base-ctor": "^0.2.2", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/ndarray-ctor": "^0.2.1", - "@stdlib/ndarray-ind2sub": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -89,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..2c54a8b --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From fdc5546b44c073edc69d5be37bba0d8ee219aecd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 03:53:58 +0000 Subject: [PATCH 51/64] Update README.md for ESM bundle v0.2.2 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c1d94a2..3df5f70 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.2.2-esm/index.mjs'; ``` #### maybeBroadcastArray( x, shape ) @@ -106,7 +106,7 @@ var y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); import array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@esm/index.mjs'; import numel from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs'; import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; -import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.2.2-esm/index.mjs'; // Create a 2x2 array: var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); From 4cb4474506694938de2ef50701d522071c461191 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 03:53:58 +0000 Subject: [PATCH 52/64] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3df5f70..e9a9e2e 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tags). For example, + ```javascript import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.2.2-esm/index.mjs'; ``` @@ -106,7 +111,7 @@ var y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); import array from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-array@esm/index.mjs'; import numel from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs'; import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; -import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@v0.2.2-esm/index.mjs'; +import maybeBroadcastArray from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-maybe-broadcast-array@esm/index.mjs'; // Create a 2x2 array: var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); From 9b52ddf4957b6fdf119ac1c83ec1023f97ab968c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 08:29:32 +0000 Subject: [PATCH 53/64] Transform error messages --- lib/main.js | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/main.js b/lib/main.js index 7de2ca6..751aba7 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var isCollection = require( '@stdlib/assert-is-collection' ); var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; var broadcast = require( '@stdlib/ndarray-broadcast-array' ); var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -96,10 +96,10 @@ function maybeBroadcastArray( x, shape ) { var i; if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); + throw new TypeError( format( '1k34f', x ) ); } if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '1k3F3', shape ) ); } N = shape.length; sh = getShape( x ); @@ -109,7 +109,7 @@ function maybeBroadcastArray( x, shape ) { for ( i = 0; i < N; i++ ) { d = shape[ i ]; if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); + throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); } // Check whether dimensions match... if ( sh[ i ] !== d ) { diff --git a/package.json b/package.json index b50a974..f2470c8 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "@stdlib/assert-is-nonnegative-integer": "^0.2.2", "@stdlib/ndarray-broadcast-array": "^0.2.2", "@stdlib/ndarray-shape": "^0.2.2", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.3.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, From e8eee0ad6ed7a447d74306af007e2ac328e6eacc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 13:23:35 +0000 Subject: [PATCH 54/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4926 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 9e5da3a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 81f95f3..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.2-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2c54a8b..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 32c246824d6a51d21915a4fac552831649126fde Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 13:23:57 +0000 Subject: [PATCH 55/64] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 78 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 53 +- SECURITY.md | 5 - benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 129 - package.json | 66 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 --- 44 files changed, 4872 insertions(+), 4710 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index f9c54f2..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-08-01T06:12:03.426Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 041cc14..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -181,7 +172,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -244,17 +235,17 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm -[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays +[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index a18fb31..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index f086e25..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 271b2b8..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index ce222f6..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=g(function(w,v){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),l=require('@stdlib/ndarray-shape/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function y(e,r){var i,n,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(n=r.length,i=l(e),i.length===n){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAW,QAAS,uBAAwB,EAC5CC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACZ,EAAeO,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACN,EAAcO,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKL,EAAUG,CAAE,EAGZE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACV,EAAsBS,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOR,EAAWI,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOJ,EAAWI,EAAGC,CAAM,CAC5B,CAKAT,EAAO,QAAUO,IClEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "getShape", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index e465de2..9e5da3a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1c79f4d --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.2-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 751aba7..0000000 --- a/lib/main.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( '1k34f', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( '1k3F3', shape ) ); - } - N = shape.length; - sh = getShape( x ); - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index f2470c8..4394033 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,44 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/assert-is-ndarray-like": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer": "^0.2.2", - "@stdlib/ndarray-broadcast-array": "^0.2.2", - "@stdlib/ndarray-shape": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.2.2", - "@stdlib/ndarray-array": "^0.2.1", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.2", - "@stdlib/ndarray-base-ctor": "^0.2.2", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/ndarray-ctor": "^0.2.2", - "@stdlib/ndarray-ind2sub": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -89,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f156ee0 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From b9eb7774af5ee8504ab89fe8baff7dfbcf0875ea Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 2 Feb 2025 15:09:51 +0000 Subject: [PATCH 56/64] Transform error messages --- lib/main.js | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/main.js b/lib/main.js index 7de2ca6..751aba7 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var isCollection = require( '@stdlib/assert-is-collection' ); var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; var broadcast = require( '@stdlib/ndarray-broadcast-array' ); var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -96,10 +96,10 @@ function maybeBroadcastArray( x, shape ) { var i; if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); + throw new TypeError( format( '1k34f', x ) ); } if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '1k3F3', shape ) ); } N = shape.length; sh = getShape( x ); @@ -109,7 +109,7 @@ function maybeBroadcastArray( x, shape ) { for ( i = 0; i < N; i++ ) { d = shape[ i ]; if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); + throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); } // Check whether dimensions match... if ( sh[ i ] !== d ) { diff --git a/package.json b/package.json index da1abac..81a4ea0 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "@stdlib/assert-is-nonnegative-integer": "^0.2.2", "@stdlib/ndarray-broadcast-array": "^0.2.2", "@stdlib/ndarray-shape": "^0.2.2", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, From df978e2dd9c6c3805f5fdd722c78639721f58f5c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 2 Feb 2025 15:23:53 +0000 Subject: [PATCH 57/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4926 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 9e5da3a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 1c79f4d..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.2-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f156ee0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 737053eeb64e3931487a6ab692f8dbdc5ccc04f4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 2 Feb 2025 15:24:20 +0000 Subject: [PATCH 58/64] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 107 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 53 +- SECURITY.md | 5 - benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 129 - package.json | 66 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 --- 45 files changed, 4872 insertions(+), 4843 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 647eee7..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-02-02T15:04:57.833Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 041cc14..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -181,7 +172,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -244,17 +235,17 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm -[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays +[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index a18fb31..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index f086e25..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 271b2b8..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index ce222f6..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=g(function(w,v){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),l=require('@stdlib/ndarray-shape/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function y(e,r){var i,n,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(n=r.length,i=l(e),i.length===n){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAW,QAAS,uBAAwB,EAC5CC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACZ,EAAeO,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACN,EAAcO,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKL,EAAUG,CAAE,EAGZE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACV,EAAsBS,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOR,EAAWI,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOJ,EAAWI,EAAGC,CAAM,CAC5B,CAKAT,EAAO,QAAUO,IClEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "getShape", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index e465de2..9e5da3a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1882c90 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.2-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 751aba7..0000000 --- a/lib/main.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( '1k34f', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( '1k3F3', shape ) ); - } - N = shape.length; - sh = getShape( x ); - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index 81a4ea0..4394033 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,44 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/assert-is-ndarray-like": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer": "^0.2.2", - "@stdlib/ndarray-broadcast-array": "^0.2.2", - "@stdlib/ndarray-shape": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.2.2", - "@stdlib/ndarray-array": "^0.2.1", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.2", - "@stdlib/ndarray-base-ctor": "^0.2.2", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/ndarray-ctor": "^0.2.2", - "@stdlib/ndarray-ind2sub": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -89,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f156ee0 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From 3e384746cbb25e2fb5d1f5da631f0e41d38785ea Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 3 Feb 2025 00:52:11 +0000 Subject: [PATCH 59/64] Transform error messages --- lib/main.js | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/main.js b/lib/main.js index 7de2ca6..751aba7 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var isCollection = require( '@stdlib/assert-is-collection' ); var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; var broadcast = require( '@stdlib/ndarray-broadcast-array' ); var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -96,10 +96,10 @@ function maybeBroadcastArray( x, shape ) { var i; if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); + throw new TypeError( format( '1k34f', x ) ); } if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '1k3F3', shape ) ); } N = shape.length; sh = getShape( x ); @@ -109,7 +109,7 @@ function maybeBroadcastArray( x, shape ) { for ( i = 0; i < N; i++ ) { d = shape[ i ]; if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); + throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); } // Check whether dimensions match... if ( sh[ i ] !== d ) { diff --git a/package.json b/package.json index da1abac..81a4ea0 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "@stdlib/assert-is-nonnegative-integer": "^0.2.2", "@stdlib/ndarray-broadcast-array": "^0.2.2", "@stdlib/ndarray-shape": "^0.2.2", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, From 81b0ab927b52c531fa35f9aeac729cb91b83b2ee Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 3 Feb 2025 01:13:51 +0000 Subject: [PATCH 60/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4926 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 9e5da3a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 1882c90..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.2-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f156ee0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 4b1ef2505904ada093c5faf26abf367e275295b5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 3 Feb 2025 01:14:13 +0000 Subject: [PATCH 61/64] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 107 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 53 +- SECURITY.md | 5 - benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 129 - package.json | 66 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 --- 45 files changed, 4872 insertions(+), 4843 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 611f53c..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-02-03T00:45:11.403Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 465edfd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 041cc14..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -181,7 +172,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -244,17 +235,17 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm -[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays +[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index a18fb31..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index f086e25..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 271b2b8..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index ce222f6..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=g(function(w,v){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),l=require('@stdlib/ndarray-shape/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function y(e,r){var i,n,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(n=r.length,i=l(e),i.length===n){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAW,QAAS,uBAAwB,EAC5CC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACZ,EAAeO,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACN,EAAcO,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKL,EAAUG,CAAE,EAGZE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACV,EAAsBS,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOR,EAAWI,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOJ,EAAWI,EAAGC,CAAM,CAC5B,CAKAT,EAAO,QAAUO,IClEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "getShape", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index e465de2..9e5da3a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1882c90 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.2-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 751aba7..0000000 --- a/lib/main.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( '1k34f', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( '1k3F3', shape ) ); - } - N = shape.length; - sh = getShape( x ); - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index 81a4ea0..4394033 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,44 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/assert-is-ndarray-like": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer": "^0.2.2", - "@stdlib/ndarray-broadcast-array": "^0.2.2", - "@stdlib/ndarray-shape": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.2.2", - "@stdlib/ndarray-array": "^0.2.1", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.2", - "@stdlib/ndarray-base-ctor": "^0.2.2", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/ndarray-ctor": "^0.2.2", - "@stdlib/ndarray-ind2sub": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -89,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f156ee0 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); From cc1bec896e7eb33f5336f123c5409d20e78465ca Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 19 May 2025 01:07:11 +0000 Subject: [PATCH 62/64] Transform error messages --- lib/main.js | 8 ++++---- package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/main.js b/lib/main.js index 7de2ca6..751aba7 100644 --- a/lib/main.js +++ b/lib/main.js @@ -25,7 +25,7 @@ var isCollection = require( '@stdlib/assert-is-collection' ); var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; var broadcast = require( '@stdlib/ndarray-broadcast-array' ); var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -96,10 +96,10 @@ function maybeBroadcastArray( x, shape ) { var i; if ( !isndarrayLike( x ) ) { - throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) ); + throw new TypeError( format( '1k34f', x ) ); } if ( !isCollection( shape ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '1k3F3', shape ) ); } N = shape.length; sh = getShape( x ); @@ -109,7 +109,7 @@ function maybeBroadcastArray( x, shape ) { for ( i = 0; i < N; i++ ) { d = shape[ i ]; if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) ); + throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); } // Check whether dimensions match... if ( sh[ i ] !== d ) { diff --git a/package.json b/package.json index da1abac..81a4ea0 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "@stdlib/assert-is-nonnegative-integer": "^0.2.2", "@stdlib/ndarray-broadcast-array": "^0.2.2", "@stdlib/ndarray-shape": "^0.2.2", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, From 9e359fdd41c764098d52c6d3b0fb6920383a947b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 19 May 2025 01:10:27 +0000 Subject: [PATCH 63/64] Remove files --- index.d.ts | 79 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4926 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 9e5da3a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,79 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { typedndarray, Shape } from '@stdlib/types/ndarray'; - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - The function throws an error if a provided ndarray is incompatible with a provided shape. -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input array may affect multiple elements. If you need to write to the input array, copy the array before broadcasting. -* -* @param x - input array -* @param shape - desired shape -* @throws input array cannot have more dimensions than the desired shape -* @throws input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws input array and desired shape must be broadcast compatible -* @returns broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ -declare function maybeBroadcastArray( x: typedndarray, shape: Shape ): typedndarray; - - -// EXPORTS // - -export = maybeBroadcastArray; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 1882c90..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.2-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f156ee0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 6b3b4da14a60ae8271b2bca5efcd0a5b2fa88408 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 19 May 2025 01:10:50 +0000 Subject: [PATCH 64/64] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 194 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 107 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 53 +- SECURITY.md | 5 - benchmark/benchmark.js | 196 - benchmark/benchmark.ndims.js | 110 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 61 - docs/types/test.ts | 65 - examples/index.js | 45 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 68 - lib/main.js | 129 - package.json | 66 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 577 --- 45 files changed, 4872 insertions(+), 4847 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.ndims.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 6cbce1d..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-05-19T00:58:02.791Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 7a3aaa6..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 534468c..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 041cc14..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '34 10 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -181,7 +172,7 @@ for ( i = 0; i < N; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -244,17 +235,17 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-maybe-broadcast-array/main/LICENSE -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes +[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/ndarray-base-broadcast-shapes/tree/esm -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array +[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray-broadcast-array/tree/esm -[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays +[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray-maybe-broadcast-arrays/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index a18fb31..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,196 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var Float64Array = require( '@stdlib/array-float64' ); -var ndarrayBase = require( '@stdlib/ndarray-base-ctor' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::base_ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::base_ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ), - ndarrayBase( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], [ 2, 2, 2 ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::ndarray,2d,same_shape', function benchmark( b ) { - var strides; - var values; - var buffer; - var offset; - var dtype; - var shape; - var order; - var out; - var i; - - dtype = 'float64'; - buffer = new Float64Array( 4 ); - shape = [ 2, 2 ]; - strides = [ 2, 1 ]; - offset = 0; - order = 'row-major'; - - values = [ - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ), - ndarray( dtype, buffer, shape, strides, offset, order ) - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( values[ i%values.length ], shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.ndims.js b/benchmark/benchmark.ndims.js deleted file mode 100644 index f086e25..0000000 --- a/benchmark/benchmark.ndims.js +++ /dev/null @@ -1,110 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var array = require( '@stdlib/ndarray-array' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var maybeBroadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} ndims - number of dimensions to which to broadcast -* @returns {Function} benchmark function -*/ -function createBenchmark( ndims ) { - var shape; - var sh; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - sh = x.shape; - - shape = []; - for ( i = 0; i < ndims; i++ ) { - shape.push( 0 ); - } - for ( i = ndims; i >= 1; i-- ) { - if ( i > sh.length ) { - shape[ ndims-i ] = 5; - } else { - shape[ ndims-i ] = sh[ i-1 ]; - } - } - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = maybeBroadcastArray( x, shape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isndarrayLike( out ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 2; - max = 10; - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+'::ndarray,2d:from_ndims=2,to_ndims='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 271b2b8..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array" -%% click B href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array -[production-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-maybe-broadcast-array/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 71859ce..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import maybeBroadcastArray from '../docs/types/index'; -export = maybeBroadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index ce222f6..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var g=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=g(function(w,v){ -var m=require('@stdlib/assert-is-ndarray-like/dist'),d=require('@stdlib/assert-is-collection/dist'),f=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,o=require('@stdlib/ndarray-broadcast-array/dist'),l=require('@stdlib/ndarray-shape/dist'),u=require('@stdlib/error-tools-fmtprodmsg/dist');function y(e,r){var i,n,t,a;if(!m(e))throw new TypeError(u('1k34f',e));if(!d(r))throw new TypeError(u('1k3F3',r));if(n=r.length,i=l(e),i.length===n){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of nonnegative integers. Value: `%s`.', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nmodule.exports = maybeBroadcastArray;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.\n*\n* @module @stdlib/ndarray-maybe-broadcast-array\n*\n* @example\n* var array = require( '@stdlib/ndarray-array' );\n* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' );\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAe,QAAS,8BAA+B,EACvDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAY,QAAS,iCAAkC,EACvDC,EAAW,QAAS,uBAAwB,EAC5CC,EAAS,QAAS,uBAAwB,EAgE9C,SAASC,EAAqBC,EAAGC,EAAQ,CACxC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,CAACZ,EAAeO,CAAE,EACtB,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAE,CAAE,EAEvG,GAAK,CAACN,EAAcO,CAAM,EACzB,MAAM,IAAI,UAAWH,EAAQ,2FAA4FG,CAAM,CAAE,EAMlI,GAJAE,EAAIF,EAAM,OACVC,EAAKL,EAAUG,CAAE,EAGZE,EAAG,SAAWC,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,CAAE,EACR,CAACV,EAAsBS,CAAE,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2FAA4F,IAAMG,EAAM,KAAM,GAAI,EAAI,GAAI,CAAE,EAG1J,GAAKC,EAAIG,CAAE,IAAMD,EAEhB,OAAOR,EAAWI,EAAGC,CAAM,CAE7B,CACA,OAAOD,CACR,CAEA,OAAOJ,EAAWI,EAAGC,CAAM,CAC5B,CAKAT,EAAO,QAAUO,IClEjB,IAAIO,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isndarrayLike", "isCollection", "isNonNegativeInteger", "broadcast", "getShape", "format", "maybeBroadcastArray", "x", "shape", "sh", "N", "d", "i", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 59f13e6..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,61 +0,0 @@ - -{{alias}}( x, shape ) - Broadcasts an ndarray to a specified shape if and only if the specified - shape differs from the provided ndarray's shape. - - If a provided ndarray has the same shape as the specified shape, the - function returns the provided ndarray. - - If a provided ndarray has a different (broadcast compatible) shape than the - specified shape, the function returns a new *read-only* ndarray view of the - provided ndarray's data. The view is typically *not* contiguous. As more - than one element of a returned view may refer to the same memory location, - writing to the input ndarray may affect multiple elements. If you need to - write to the input ndarray, copy the input ndarray before broadcasting. - - The function throws an error if a provided ndarray is incompatible with a - provided shape. - - Parameters - ---------- - x: ndarray - Input array. - - shape: ArrayLikeObject - Desired shape. - - Returns - ------- - out: ndarray - Broadcasted array. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > var sh = x.shape - [ 2, 2 ] - > var y = {{alias}}( x, [ 3, 2, 2 ] ) - - > sh = y.shape - [ 3, 2, 2 ] - > var v = y.get( 0, 0, 0 ) - 1 - > v = y.get( 0, 0, 1 ) - 2 - > v = y.get( 0, 1, 0 ) - 3 - > v = y.get( 0, 1, 1 ) - 4 - > v = y.get( 1, 0, 0 ) - 1 - > v = y.get( 1, 1, 0 ) - 3 - > v = y.get( 2, 0, 0 ) - 1 - > v = y.get( 2, 1, 1 ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 4f03b84..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,65 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/ndarray-zeros' ); -import maybeBroadcastArray = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType typedndarray -} - -// The compiler throws an error if the function is not provided a first argument which is an ndarray... -{ - maybeBroadcastArray( '5', [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( 5, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( true, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( false, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( null, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( {}, [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( [ '5' ], [ 2, 2, 2 ] ); // $ExpectError - maybeBroadcastArray( ( x: number ): number => x, [ 2, 2, 2 ] ); // $ExpectError -} - -// The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray( x, '5' ); // $ExpectError - maybeBroadcastArray( x, 5 ); // $ExpectError - maybeBroadcastArray( x, true ); // $ExpectError - maybeBroadcastArray( x, false ); // $ExpectError - maybeBroadcastArray( x, null ); // $ExpectError - maybeBroadcastArray( x, {} ); // $ExpectError - maybeBroadcastArray( x, [ '5' ] ); // $ExpectError - maybeBroadcastArray( x, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = zeros( [ 2, 2 ] ); - - maybeBroadcastArray(); // $ExpectError - maybeBroadcastArray( x ); // $ExpectError - maybeBroadcastArray( x, [ 1, 2, 3 ], [ 2, 3 ] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 9ade0a9..0000000 --- a/examples/index.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var array = require( '@stdlib/ndarray-array' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -var maybeBroadcastArray = require( './../lib' ); - -// Create a 2x2 array: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -// returns - -// Broadcast the array to 3x2x2: -var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -// returns - -// Retrieve the shape: -var sh = y.shape; -// returns [ 3, 2, 2 ] - -// Retrieve the number of elements: -var N = numel( sh ); - -// Loop through the array elements... -var i; -for ( i = 0; i < N; i++ ) { - console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) ); -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 96% rename from docs/types/index.d.ts rename to index.d.ts index e465de2..9e5da3a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { typedndarray, Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1882c90 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-ndarray-like@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.2-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-broadcast-array@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-shape@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";function d(d,o){var m,j,l,a;if(!r(d))throw new TypeError(n("1k34f",d));if(!s(o))throw new TypeError(n("1k3F3",o));if(j=o.length,(m=i(d)).length===j){for(a=0;a\n*\n* var shx = x.shape;\n* // returns [ 2, 2 ]\n*\n* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );\n* // returns \n*\n* var shy = y.shape;\n* // returns [ 3, 2, 2 ]\n*\n* var v = y.get( 0, 0, 0 );\n* // returns 1\n*\n* v = y.get( 0, 0, 1 );\n* // returns 2\n*\n* v = y.get( 1, 0, 0 );\n* // returns 1\n*\n* v = y.get( 1, 1, 0 );\n* // returns 3\n*\n* v = y.get( 2, 0, 0 );\n* // returns 1\n*\n* v = y.get( 2, 1, 1 );\n* // returns 4\n*\n* @example\n* import array from '@stdlib/ndarray-array';\n*\n* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );\n* // returns \n*\n* var y = maybeBroadcastArray( x, [ 3, 2 ] );\n* // throws \n*/\nfunction maybeBroadcastArray( x, shape ) {\n\tvar sh;\n\tvar N;\n\tvar d;\n\tvar i;\n\n\tif ( !isndarrayLike( x ) ) {\n\t\tthrow new TypeError( format( '1k34f', x ) );\n\t}\n\tif ( !isCollection( shape ) ) {\n\t\tthrow new TypeError( format( '1k3F3', shape ) );\n\t}\n\tN = shape.length;\n\tsh = getShape( x );\n\n\t// Check whether we need to broadcast the input array...\n\tif ( sh.length === N ) {\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\td = shape[ i ];\n\t\t\tif ( !isNonNegativeInteger( d ) ) {\n\t\t\t\tthrow new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) );\n\t\t\t}\n\t\t\t// Check whether dimensions match...\n\t\t\tif ( sh[ i ] !== d ) {\n\t\t\t\t// We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\t\t\t\treturn broadcast( x, shape );\n\t\t\t}\n\t\t}\n\t\treturn x;\n\t}\n\t// If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape...\n\treturn broadcast( x, shape );\n}\n\n\n// EXPORTS //\n\nexport default maybeBroadcastArray;\n"],"names":["maybeBroadcastArray","x","shape","sh","N","d","i","isndarrayLike","TypeError","format","isCollection","length","getShape","isNonNegativeInteger","join","broadcast"],"mappings":";;klBA2FA,SAASA,EAAqBC,EAAGC,GAChC,IAAIC,EACAC,EACAC,EACAC,EAEJ,IAAMC,EAAeN,GACpB,MAAM,IAAIO,UAAWC,EAAQ,QAASR,IAEvC,IAAMS,EAAcR,GACnB,MAAM,IAAIM,UAAWC,EAAQ,QAASP,IAMvC,GAJAE,EAAIF,EAAMS,QACVR,EAAKS,EAAUX,IAGPU,SAAWP,EAAI,CACtB,IAAME,EAAI,EAAGA,EAAIF,EAAGE,IAAM,CAEzB,GADAD,EAAIH,EAAOI,IACLO,EAAsBR,GAC3B,MAAM,IAAIG,UAAWC,EAAQ,QAAS,IAAMP,EAAMY,KAAM,KAAQ,MAGjE,GAAKX,EAAIG,KAAQD,EAEhB,OAAOU,EAAWd,EAAGC,EAEtB,CACD,OAAOD,CACP,CAED,OAAOc,EAAWd,EAAGC,EACtB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 229ca68..0000000 --- a/lib/index.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* @module @stdlib/ndarray-maybe-broadcast-array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* var maybeBroadcastArray = require( '@stdlib/ndarray-maybe-broadcast-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 751aba7..0000000 --- a/lib/main.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var isCollection = require( '@stdlib/assert-is-collection' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var broadcast = require( '@stdlib/ndarray-broadcast-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Broadcasts an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. -* -* ## Notes -* -* - If a provided ndarray has the same shape as the specified shape, the function returns the provided ndarray. -* - If a provided ndarray has a different (broadcast compatible) shape than the specified shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the input ndarray may affect multiple elements. If you need to write to the input ndarray, copy the input ndarray before broadcasting. -* -* @param {ndarray} x - input array -* @param {NonNegativeIntegerArray} shape - desired shape -* @throws {TypeError} first argument must be an ndarray -* @throws {TypeError} second argument must be an array of nonnegative integers -* @throws {Error} input array cannot have more dimensions than the desired shape -* @throws {Error} input array dimension sizes must be `1` or equal to the corresponding dimension in the provided shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {ndarray} broadcasted array -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var shx = x.shape; -* // returns [ 2, 2 ] -* -* var y = maybeBroadcastArray( x, [ 3, 2, 2 ] ); -* // returns -* -* var shy = y.shape; -* // returns [ 3, 2, 2 ] -* -* var v = y.get( 0, 0, 0 ); -* // returns 1 -* -* v = y.get( 0, 0, 1 ); -* // returns 2 -* -* v = y.get( 1, 0, 0 ); -* // returns 1 -* -* v = y.get( 1, 1, 0 ); -* // returns 3 -* -* v = y.get( 2, 0, 0 ); -* // returns 1 -* -* v = y.get( 2, 1, 1 ); -* // returns 4 -* -* @example -* var array = require( '@stdlib/ndarray-array' ); -* -* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -* // returns -* -* var y = maybeBroadcastArray( x, [ 3, 2 ] ); -* // throws -*/ -function maybeBroadcastArray( x, shape ) { - var sh; - var N; - var d; - var i; - - if ( !isndarrayLike( x ) ) { - throw new TypeError( format( '1k34f', x ) ); - } - if ( !isCollection( shape ) ) { - throw new TypeError( format( '1k3F3', shape ) ); - } - N = shape.length; - sh = getShape( x ); - - // Check whether we need to broadcast the input array... - if ( sh.length === N ) { - for ( i = 0; i < N; i++ ) { - d = shape[ i ]; - if ( !isNonNegativeInteger( d ) ) { - throw new TypeError( format( '1k3F3', '[' + shape.join( ',' ) + ']' ) ); - } - // Check whether dimensions match... - if ( sh[ i ] !== d ) { - // We found a mismatched dimension; delegate to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); - } - } - return x; - } - // If we are provided an array having a different rank (i.e., number of dimensions) than the desired shape, assume we need to broadcast, delegating to `broadcast` to ensure that the input array is broadcast compatible with the desired array shape... - return broadcast( x, shape ); -} - - -// EXPORTS // - -module.exports = maybeBroadcastArray; diff --git a/package.json b/package.json index 81a4ea0..4394033 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,44 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/assert-is-ndarray-like": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer": "^0.2.2", - "@stdlib/ndarray-broadcast-array": "^0.2.2", - "@stdlib/ndarray-shape": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-float64": "^0.2.2", - "@stdlib/ndarray-array": "^0.2.1", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.2", - "@stdlib/ndarray-base-ctor": "^0.2.2", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/ndarray-ctor": "^0.2.2", - "@stdlib/ndarray-ind2sub": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -89,7 +28,6 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f156ee0 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 01bf6c1..0000000 --- a/test/test.js +++ /dev/null @@ -1,577 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var array = require( '@stdlib/ndarray-array' ); -var ndarray = require( '@stdlib/ndarray-ctor' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var maybeBroadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof maybeBroadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if a first argument which is not an ndarray', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( value, [ 2, 2 ] ); - }; - } -}); - -tape( 'the function throws an error if a second argument which is not an array of nonnegative integers', function test( t ) { - var values; - var x; - var i; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [ 2, -1 ], - [ 2, 3.14 ], - [ 2, -1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape which has fewer dimensions than the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - }); - - values = [ - [], - [ 2 ], - [ 2, 2 ], - [ 2, 2, 2 ], - [ 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2 ], - [ 2, 2, 2, 2, 2, 2, 2, 2, 2 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided a shape with '+values[ i ].length+' dimension' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape having a dimension whose size is less than the corresponding dimension in the input array', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 10, 1 ], - [ 10, 10, 2 ], - [ 10, 10, 9 ], - [ 10, 1, 10 ], - [ 10, 2, 10 ], - [ 10, 9, 10 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape which are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = array({ - 'shape': [ 10, 10 ] - }); - - values = [ - [ 10, 20, 10 ], - [ 10, 10, 100 ] - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ] ), Error, 'throws an error when provided shape ('+values[ i ].join( ',')+')' ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - maybeBroadcastArray( x, value ); - }; - } -}); - -tape( 'if an input ndarray requires broadcasting, the function returns a read-only ndarray', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.notEqual( y, x, 'returns new instance' ); - t.strictEqual( isReadOnly( y ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a view over the input array data buffer', function test( t ) { - var x; - var y; - - x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); - y = maybeBroadcastArray( x, [ 2, 2, 2 ] ); - - t.strictEqual( y.data, x.data, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, -1 ], 3, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; strides)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ -2, 1 ], 2, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (row-major; non-contiguous)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = ndarray( 'generic', data, [ 2, 2 ], [ 4, 2 ], 1, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 5 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 7 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (column-major)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2 ], - 'order': 'column-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 2 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 3 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 2, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - // Should return the same instance: - t.strictEqual( y, x, 'returns expected value' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 1, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 1, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2, 3, 4 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 2, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, x.get( i, 0, 0 ), 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, x.get( i, 0, 1 ), 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 2, 1 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1, 2 ]; - x = array( data, { - 'dtype': 'generic', - 'shape': [ 1, 2 ], - 'order': 'row-major' - }); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 1 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -}); - -tape( 'the function broadcasts an input array (0-dimensional array)', function test( t ) { - var expected; - var actual; - var data; - var x; - var y; - var v; - var i; - - data = [ 1 ]; - x = ndarray( 'generic', data, [], [ 0 ], 0, 'row-major' ); - - expected = [ 5, 2, 2 ]; - y = maybeBroadcastArray( x, expected ); - - actual = y.shape; - t.deepEqual( actual, expected, 'returns expected shape' ); - - for ( i = 0; i < expected[ 0 ]; i++ ) { - v = y.get( i, 0, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,0)' ); - - v = y.get( i, 0, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',0,1)' ); - - v = y.get( i, 1, 0 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,0)' ); - - v = y.get( i, 1, 1 ); - t.strictEqual( v, data[ 0 ], 'returns expected value for element ('+i+',1,1)' ); - } - t.end(); -});