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 8e49e7e..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-02-03T01:13:41.016Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index fa7f781..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/array/base/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 e3c7633..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/array/base/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 74686c8..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: '6 6 * * 1' - - # 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 +``` -```javascript -var broadcastArray = require( '@stdlib/array-base-broadcast-array' ); +If no recognized module system is present, access bundle contents via the global scope: + +```html + ``` #### broadcastArray( x, inShape, outShape ) @@ -131,8 +137,13 @@ The function returns an object having the following properties: -```javascript -var broadcastArray = require( '@stdlib/array-base-broadcast-array' ); +```html + + + + + + + ```
@@ -267,7 +283,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-broadcast-array/main/LICENSE -[@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/umd
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.dimensions.js b/benchmark/benchmark.dimensions.js deleted file mode 100644 index 8ac2a14..0000000 --- a/benchmark/benchmark.dimensions.js +++ /dev/null @@ -1,116 +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 isArray = require( '@stdlib/assert-is-array' ); -var isEven = require( '@stdlib/math-base-assert-is-even' ); -var zerosnd = require( '@stdlib/array-base-zerosnd' ); -var pkg = require( './../package.json' ).name; -var broadcastArray = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} N - number of dimensions -* @returns {Function} benchmark function -*/ -function createBenchmark( N ) { - var outShape; - var inShape; - var x; - var i; - - outShape = []; - inShape = []; - - // Create an input shape such that half of the dimensions are one (and thus need to be broadcasted) and half of the dimensions are equal to the respective output shape dimensions... - for ( i = 1; i < N+1; i++ ) { - outShape.push( i ); - if ( isEven( i ) ) { - inShape.push( i ); - } else { - inShape.push( 1 ); - } - } - x = zerosnd( inShape ); - - 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 = broadcastArray( x, inShape, outShape ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( - !isArray( out.data ) || - !isArray( out.ref ) || - !isArray( out.shape ) || - !isArray( out.strides ) - ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 10; // 10^max - - for ( i = min; i <= max; i++ ) { - f = createBenchmark( i ); - bench( pkg+':dimensions='+i, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index eb7b098..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/array/base/broadcast-array" -%% click B href "https://github.com/stdlib-js/array-base-broadcast-array/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-broadcast-array/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-broadcast-array/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-broadcast-array/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-broadcast-array/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/broadcast-array -[production-url]: https://github.com/stdlib-js/array-base-broadcast-array/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-broadcast-array/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-broadcast-array/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-broadcast-array/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-broadcast-array/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-broadcast-array/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-broadcast-array/blob/esm/README.md \ No newline at end of file diff --git a/browser.js b/browser.js new file mode 100644 index 0000000..6d3f880 --- /dev/null +++ b/browser.js @@ -0,0 +1,3 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +var e,r;e=this,r=function(){"use strict";function e(e){var r,n,o;for(n=e.length,r=[],o=0;o=0;d--)if(!((l=s-h+d)<0)){if(a=o[l],0!==(i=t[d])&&i= 0; i-- ) {\n\t\tj = M - N + i;\n\t\tif ( j < 0 ) {\n\t\t\t// Prepended singleton dimension; stride is zero...\n\t\t\tcontinue;\n\t\t}\n\t\td = inShape[ j ];\n\t\tdim = outShape[ i ];\n\t\tif ( dim !== 0 && dim < d ) {\n\t\t\tthrow new Error( format( '1hN5F', copy( inShape ).join( ', ' ), copy( outShape ).join( ', ' ), i ) );\n\t\t}\n\t\tif ( d === dim ) {\n\t\t\t// As the dimension sizes are equal, the stride is one, meaning that each element in the array should be iterated over as normal...\n\t\t\tst[ i ] = 1;\n\t\t} else if ( d === 1 ) {\n\t\t\t// In order to broadcast a dimension, we set the stride for that dimension to zero...\n\t\t\tst[ i ] = 0;\n\t\t} else {\n\t\t\t// At this point, we know that `dim > d` and that `d` does not equal `1` (e.g., `dim=3` and `d=2`); in which case, the shapes are considered incompatible (even for desired shapes which are multiples of array dimensions, as might be desired when \"tiling\" an array; e.g., `dim=4` and `d=2`)...\n\t\t\tthrow new Error( format( '1hN5G', copy( inShape ).join( ', ' ), copy( outShape ).join( ', ' ), i ) );\n\t\t}\n\t}\n\t// Return broadcast results:\n\treturn {\n\t\t'ref': x, // reference to the original input array\n\t\t'data': data, // broadcasted array\n\t\t'shape': copy( outShape ), // copy in order to prevent mutation\n\t\t'strides': st\n\t};\n}\n\n\n// EXPORTS //\n\nexport default broadcastArray;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2021 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// MAIN //\n\n/**\n* Returns a filled \"generic\" array.\n*\n* @param {*} value - fill value\n* @param {NonNegativeInteger} len - array length\n* @returns {Array} filled array\n*\n* @example\n* var out = filled( 0.0, 3 );\n* // returns [ 0.0, 0.0, 0.0 ]\n*\n* @example\n* var out = filled( 'beep', 3 );\n* // returns [ 'beep', 'beep', 'beep' ]\n*/\nfunction filled( value, len ) {\n\tvar arr;\n\tvar i;\n\n\t// Manually push elements in order to ensure \"fast\" elements...\n\tarr = [];\n\tfor ( i = 0; i < len; i++ ) {\n\t\tarr.push( value );\n\t}\n\treturn arr;\n}\n\n\n// EXPORTS //\n\nexport default filled;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2021 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// MODULES //\n\nimport filled from '@stdlib/array-base-filled';\n\n\n// MAIN //\n\n/**\n* Returns a zero-filled \"generic\" array.\n*\n* @param {NonNegativeInteger} len - array length\n* @returns {Array} output array\n*\n* @example\n* var out = zeros( 3 );\n* // returns [ 0.0, 0.0, 0.0 ]\n*/\nfunction zeros( len ) {\n\treturn filled( 0.0, len );\n}\n\n\n// EXPORTS //\n\nexport default zeros;\n"],"names":["copy","x","out","len","i","length","push","fmtprodmsg","a","arguments","u","encodeURIComponent","inShape","outShape","data","dim","st","N","M","d","j","Error","format","value","arr","filled","join","ref","shape","strides"],"mappings":";yCAgCA,SAASA,EAAMC,GACd,IAAIC,EACAC,EACAC,EAIJ,IAFAD,EAAMF,EAAEI,OACRH,EAAM,GACAE,EAAI,EAAGA,EAAID,EAAKC,IACrBF,EAAII,KAAML,EAAGG,IAEd,OAAOF,CACR,CCVA,SAASK,IACR,IAGIH,EAHAI,EAAIC,UAEJC,EAAI,uBADAF,EAAG,GACsB,IAEjC,IAAMJ,EAAI,EAAGA,EAAII,EAAEH,OAAQD,IAC1BM,GAAK,UAAYC,mBAAoBH,EAAGJ,IAEzC,OAAOM,CACR,QC2CA,SAAyBT,EAAGW,EAASC,GACpC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAf,EACAgB,EAIJ,IAFAH,EAAIJ,EAASR,SACba,EAAIN,EAAQP,QAEX,MAAM,IAAIgB,MAAOC,EAAO,UAIzB,IADAR,EAAOb,EACDG,EAAIc,EAAGd,EAAIa,EAAGb,IACnBU,EAAO,CAAEA,GAOV,IAHAE,ECtED,SAAiBO,EAAOpB,GACvB,IAAIqB,EACApB,EAIJ,IADAoB,EAAM,GACApB,EAAI,EAAGA,EAAID,EAAKC,IACrBoB,EAAIlB,KAAMiB,GAEX,OAAOC,CACR,CCTQC,CAAQ,EFqEHR,GAGNb,EAAIa,EAAE,EAAGb,GAAK,EAAGA,IAEtB,MADAgB,EAAIF,EAAID,EAAIb,GACH,GAAT,CAMA,GAFAe,EAAIP,EAASQ,GAEA,KADbL,EAAMF,EAAUT,KACEW,EAAMI,EACvB,MAAM,IAAIE,MAAOC,EAAQ,QAAStB,EAAMY,GAAUc,KAAM,MAAQ1B,EAAMa,GAAWa,KAAM,MAAQtB,IAEhG,GAAKe,IAAMJ,EAEVC,EAAIZ,GAAM,MACJ,IAAW,IAANe,EAKX,MAAM,IAAIE,MAAOC,EAAQ,QAAStB,EAAMY,GAAUc,KAAM,MAAQ1B,EAAMa,GAAWa,KAAM,MAAQtB,IAH/FY,EAAIZ,GAAM,CAIV,CAfA,CAkBF,MAAO,CACNuB,IAAO1B,EACPa,KAAQA,EACRc,MAAS5B,EAAMa,GACfgB,QAAWb,EAEb","x_google_ignoreList":[0,1,3,4]} \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index a9d3107..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import broadcastArray from '../docs/types/index'; -export = broadcastArray; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 60fcfce..0000000 --- a/dist/index.js +++ /dev/null @@ -1,19 +0,0 @@ -"use strict";var u=function(n,e){return function(){return e||n((e={exports:{}}).exports,e),e.exports}};var p=u(function(w,m){"use strict";var i=require("@stdlib/array-base-copy-indexed"),l=require("@stdlib/array-base-zeros"),f=require("@stdlib/string-format");function y(n,e,s){var t,o,d,a,h,c,r,v;if(a=s.length,h=e.length,a=0;r--)if(v=h-a+r,!(v<0)){if(c=e[v],o=s[r],o!==0&&o= 0; i-- ) {\n\t\tj = M - N + i;\n\t\tif ( j < 0 ) {\n\t\t\t// Prepended singleton dimension; stride is zero...\n\t\t\tcontinue;\n\t\t}\n\t\td = inShape[ j ];\n\t\tdim = outShape[ i ];\n\t\tif ( dim !== 0 && dim < d ) {\n\t\t\tthrow new Error( format( 'invalid argument. Input array cannot be broadcast to the specified shape, as the specified shape has a dimension whose size is less than the size of the corresponding dimension in the input array. Array shape: (%s). Desired shape: (%s). Dimension: %u.', copy( inShape ).join( ', ' ), copy( outShape ).join( ', ' ), i ) );\n\t\t}\n\t\tif ( d === dim ) {\n\t\t\t// As the dimension sizes are equal, the stride is one, meaning that each element in the array should be iterated over as normal...\n\t\t\tst[ i ] = 1;\n\t\t} else if ( d === 1 ) {\n\t\t\t// In order to broadcast a dimension, we set the stride for that dimension to zero...\n\t\t\tst[ i ] = 0;\n\t\t} else {\n\t\t\t// At this point, we know that `dim > d` and that `d` does not equal `1` (e.g., `dim=3` and `d=2`); in which case, the shapes are considered incompatible (even for desired shapes which are multiples of array dimensions, as might be desired when \"tiling\" an array; e.g., `dim=4` and `d=2`)...\n\t\t\tthrow new Error( format( 'invalid argument. Input array and the specified shape are broadcast incompatible. Array shape: (%s). Desired shape: (%s). Dimension: %u.', copy( inShape ).join( ', ' ), copy( outShape ).join( ', ' ), i ) );\n\t\t}\n\t}\n\t// Return broadcast results:\n\treturn {\n\t\t'ref': x, // reference to the original input array\n\t\t'data': data, // broadcasted array\n\t\t'shape': copy( outShape ), // copy in order to prevent mutation\n\t\t'strides': st\n\t};\n}\n\n\n// EXPORTS //\n\nmodule.exports = broadcastArray;\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 array to a specified shape.\n*\n* @module @stdlib/array-base-broadcast-array\n*\n* @example\n* var broadcastArray = require( '@stdlib/array-base-broadcast-array' );\n*\n* var x = [ 1, 2 ];\n*\n* var out = broadcastArray( x, [ 2 ], [ 2, 2 ] );\n* // returns {...}\n*\n* var shape = out.shape;\n* // returns [ 2, 2 ]\n*\n* var strides = out.strides;\n* // returns [ 0, 1 ]\n*\n* var ref = out.ref;\n* // returns [ 1, 2 ]\n*\n* var bool = ( x === ref );\n* // returns true\n*\n* var data = out.data;\n* // returns [ [ 1, 2 ] ]\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,EAAO,QAAS,iCAAkC,EAClDC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,QAAS,uBAAwB,EA6D9C,SAASC,EAAgBC,EAAGC,EAASC,EAAW,CAC/C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAIJ,GAFAJ,EAAIJ,EAAS,OACbK,EAAIN,EAAQ,OACPK,EAAIC,EACR,MAAM,IAAI,MAAO,8JAA+J,EAIjL,IADAJ,EAAOH,EACDS,EAAIF,EAAGE,EAAIH,EAAGG,IACnBN,EAAO,CAAEA,CAAK,EAOf,IAHAE,EAAKR,EAAOS,CAAE,EAGRG,EAAIH,EAAE,EAAGG,GAAK,EAAGA,IAEtB,GADAC,EAAIH,EAAID,EAAIG,EACP,EAAAC,EAAI,GAMT,IAFAF,EAAIP,EAASS,CAAE,EACfN,EAAMF,EAAUO,CAAE,EACbL,IAAQ,GAAKA,EAAMI,EACvB,MAAM,IAAI,MAAOV,EAAQ,8PAA+PF,EAAMK,CAAQ,EAAE,KAAM,IAAK,EAAGL,EAAMM,CAAS,EAAE,KAAM,IAAK,EAAGO,CAAE,CAAE,EAE1V,GAAKD,IAAMJ,EAEVC,EAAII,CAAE,EAAI,UACCD,IAAM,EAEjBH,EAAII,CAAE,EAAI,MAGV,OAAM,IAAI,MAAOX,EAAQ,2IAA4IF,EAAMK,CAAQ,EAAE,KAAM,IAAK,EAAGL,EAAMM,CAAS,EAAE,KAAM,IAAK,EAAGO,CAAE,CAAE,EAIxO,MAAO,CACN,IAAOT,EACP,KAAQG,EACR,MAASP,EAAMM,CAAS,EACxB,QAAWG,CACZ,CACD,CAKAV,EAAO,QAAUI,IC7FjB,IAAIY,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "copy", "zeros", "format", "broadcastArray", "x", "inShape", "outShape", "data", "dim", "st", "N", "M", "d", "i", "j", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 709282c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,55 +0,0 @@ - -{{alias}}( x, inShape, outShape ) - Broadcasts an array to a specified shape. - - The broadcasted array shares the same data as the input array. As more than - one element of a broadcasted array may refer to the same memory location, - writing to the broadcasted array may affect multiple elements. If you need - to write to the broadcasted array, copy the array before performing - operations which may mutate elements. - - The function throws an error if a provided input shape is incompatible with - a provided output shape. - - Parameters - ---------- - x: Collection - Input array. - - inShape: Collection - Input array shape. - - outShape: Collection - Output array shape. - - Returns - ------- - out: Object - Broadcast object. - - out.ref: Collection - Reference to original input array. - - out.data: ArrayLikeObject - Broadcasted array. - - out.shape: Array - Broadcasted array shape. - - out.strides: Array - Broadcasted array strides. - - Examples - -------- - > var out = {{alias}}( [ 1, 2, 3 ], [ 3 ], [ 2, 3 ] ) - {...} - > out.shape - [ 2, 3 ] - > out.strides - [ 0, 1 ] - > out.data - [ [ 1, 2, 3 ] ] - - See Also - -------- - diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts deleted file mode 100644 index d7b2db1..0000000 --- a/docs/types/index.d.ts +++ /dev/null @@ -1,115 +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 { Collection } from '@stdlib/types/array'; - -/** -* Interface describing a broadcast object. -*/ -interface BroadcastObject { - /** - * Reference to the input array. - */ - ref: Collection; - - /** - * Broadcasted array. - */ - data: any; // FIXME: how to type this, as this can be an arbitrarily nested array, where the number of dimensions is dependent on the length of `inShape`? - - /** - * Broadcasted array shape. - */ - shape: Array; - - /** - * Broadcasted array strides. - */ - strides: Array; -} - -/** -* Broadcasts an array to a specified shape. -* -* ## Notes -* -* - The broadcasted array shares the same data as the input array. As more than one element of a broadcasted array may refer to the same memory location, writing to the broadcasted array may affect multiple elements. If you need to write to the broadcasted array, copy the array before performing operations which may mutate elements. -* - The function throws an error if a provided input shape is incompatible with a provided output shape. -* -* @param x - input array -* @param inShape - input array shape -* @param outShape - output array 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 output shape -* @returns broadcast object -* -* @example -* var x = [ 1, 2 ]; -* -* var out = broadcastArray( x, [ 2 ], [ 2, 2 ] ); -* // returns {...} -* -* var shape = out.shape; -* // returns [ 2, 2 ] -* -* var strides = out.strides; -* // returns [ 0, 1 ] -* -* var ref = out.ref; -* // returns [ 1, 2 ] -* -* var bool = ( x === ref ); -* // returns true -* -* var data = out.data; -* // returns [ [ 1, 2 ] ] -* -* @example -* var x = [ 1, 2 ]; -* -* var out = broadcastArray( x, [ 2 ], [ 2, 1, 2 ] ); -* // returns {...} -* -* var data = out.data; -* // returns [ [ [ 1, 2 ] ] ] -* -* var strides = out.strides; -* // returns [ 0, 0, 1 ] -* -* @example -* var x = [ [ 1 ], [ 2 ] ]; -* -* var out = broadcastArray( x, [ 2, 1 ], [ 3, 2, 2 ] ); -* // returns {...} -* -* var data = out.data; -* // returns [ [ [ 1 ], [ 2 ] ] ] -* -* var strides = out.strides; -* // returns [ 0, 1, 0 ] -*/ -declare function broadcastArray( x: Collection, inShape: Collection, outShape: Collection ): BroadcastObject; - - -// EXPORTS // - -export = broadcastArray; diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 03133e5..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,67 +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 broadcastArray = require( './index' ); - - -// TESTS // - -// The function returns a results object... -{ - broadcastArray( [ 1, 2, 3 ], [ 3 ], [ 2, 3 ] ); // $ExpectType BroadcastObject -} - -// The compiler throws an error if the function is provided a first argument which is not a collection... -{ - broadcastArray( 5, [ 3 ], [ 2, 3 ] ); // $ExpectError - broadcastArray( true, [ 3 ], [ 2, 3 ] ); // $ExpectError - broadcastArray( false, [ 3 ], [ 2, 3 ] ); // $ExpectError - broadcastArray( null, [ 3 ], [ 2, 3 ] ); // $ExpectError - broadcastArray( {}, [ 3 ], [ 2, 3 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a collection of numbers... -{ - broadcastArray( [ 1, 2, 3 ], '5', [ 2, 3 ] ); // $ExpectError - broadcastArray( [ 1, 2, 3 ], 5, [ 2, 3 ] ); // $ExpectError - broadcastArray( [ 1, 2, 3 ], true, [ 2, 3 ] ); // $ExpectError - broadcastArray( [ 1, 2, 3 ], false, [ 2, 3 ] ); // $ExpectError - broadcastArray( [ 1, 2, 3 ], null, [ 2, 3 ] ); // $ExpectError - broadcastArray( [ 1, 2, 3 ], [ '1' ], [ 2, 3 ] ); // $ExpectError - broadcastArray( [ 1, 2, 3 ], {}, [ 2, 3 ] ); // $ExpectError - broadcastArray( [ 1, 2, 3 ], ( x: number ): number => x, [ 2, 3 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a collection of numbers... -{ - broadcastArray( [ 1, 2, 3 ], [ 3 ], '5' ); // $ExpectError - broadcastArray( [ 1, 2, 3 ], [ 3 ], 5 ); // $ExpectError - broadcastArray( [ 1, 2, 3 ], [ 3 ], true ); // $ExpectError - broadcastArray( [ 1, 2, 3 ], [ 3 ], false ); // $ExpectError - broadcastArray( [ 1, 2, 3 ], [ 3 ], null ); // $ExpectError - broadcastArray( [ 1, 2, 3 ], [ 3 ], [ '1' ] ); // $ExpectError - broadcastArray( [ 1, 2, 3 ], [ 3 ], {} ); // $ExpectError - broadcastArray( [ 1, 2, 3 ], [ 3 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - broadcastArray(); // $ExpectError - broadcastArray( [ 1, 2, 3 ], [ 3 ] ); // $ExpectError - broadcastArray( [ 1, 2, 3 ], [ 3 ], [ 2, 3 ], {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index d0c9043..0000000 --- a/examples/index.js +++ /dev/null @@ -1,61 +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 broadcastArray = require( './../lib' ); - -// Create a 2x1 array: -var x = [ - [ 1 ], - [ 2 ] -]; - -// Broadcast the array to 3x2x4: -var o = broadcastArray( x, [ 2, 1 ], [ 3, 2, 4 ] ); -// returns {...} - -// Retrieve the shape: -var sh = o.shape; -// returns [ 3, 2, 4 ] - -// Retrieve the array "strides": -var st = o.strides; -// returns [...] - -// Initialize loop indices: -var i0 = 0; -var i1 = 0; -var i2 = 0; - -// Iterate over elements in the broadcasted array... -var i; -var j; -var k; -for ( i = 0; i < sh[ 0 ]; i++ ) { - i1 = 0; - for ( j = 0; j < sh[ 1 ]; j++ ) { - i2 = 0; - for ( k = 0; k < sh[ 2 ]; k++ ) { - console.log( 'y[%s] = %d', [ i, j, k ].join( ',' ), o.data[ i0 ][ i1 ][ i2 ] ); - i2 += st[ 2 ]; - } - i1 += st[ 1 ]; - } - i0 += st[ 0 ]; -} diff --git a/index.js b/index.js new file mode 100644 index 0000000..ac1d04c --- /dev/null +++ b/index.js @@ -0,0 +1,3 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +var e,r;e=this,r=function(){"use strict";function e(e){var r,n,o;for(n=e.length,r=[],o=0;o=0;d--)if(!((l=s-h+d)<0)){if(a=o[l],0!==(i=t[d])&&i= 0; i-- ) {\n\t\tj = M - N + i;\n\t\tif ( j < 0 ) {\n\t\t\t// Prepended singleton dimension; stride is zero...\n\t\t\tcontinue;\n\t\t}\n\t\td = inShape[ j ];\n\t\tdim = outShape[ i ];\n\t\tif ( dim !== 0 && dim < d ) {\n\t\t\tthrow new Error( format( '1hN5F', copy( inShape ).join( ', ' ), copy( outShape ).join( ', ' ), i ) );\n\t\t}\n\t\tif ( d === dim ) {\n\t\t\t// As the dimension sizes are equal, the stride is one, meaning that each element in the array should be iterated over as normal...\n\t\t\tst[ i ] = 1;\n\t\t} else if ( d === 1 ) {\n\t\t\t// In order to broadcast a dimension, we set the stride for that dimension to zero...\n\t\t\tst[ i ] = 0;\n\t\t} else {\n\t\t\t// At this point, we know that `dim > d` and that `d` does not equal `1` (e.g., `dim=3` and `d=2`); in which case, the shapes are considered incompatible (even for desired shapes which are multiples of array dimensions, as might be desired when \"tiling\" an array; e.g., `dim=4` and `d=2`)...\n\t\t\tthrow new Error( format( '1hN5G', copy( inShape ).join( ', ' ), copy( outShape ).join( ', ' ), i ) );\n\t\t}\n\t}\n\t// Return broadcast results:\n\treturn {\n\t\t'ref': x, // reference to the original input array\n\t\t'data': data, // broadcasted array\n\t\t'shape': copy( outShape ), // copy in order to prevent mutation\n\t\t'strides': st\n\t};\n}\n\n\n// EXPORTS //\n\nexport default broadcastArray;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2021 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// MAIN //\n\n/**\n* Returns a filled \"generic\" array.\n*\n* @param {*} value - fill value\n* @param {NonNegativeInteger} len - array length\n* @returns {Array} filled array\n*\n* @example\n* var out = filled( 0.0, 3 );\n* // returns [ 0.0, 0.0, 0.0 ]\n*\n* @example\n* var out = filled( 'beep', 3 );\n* // returns [ 'beep', 'beep', 'beep' ]\n*/\nfunction filled( value, len ) {\n\tvar arr;\n\tvar i;\n\n\t// Manually push elements in order to ensure \"fast\" elements...\n\tarr = [];\n\tfor ( i = 0; i < len; i++ ) {\n\t\tarr.push( value );\n\t}\n\treturn arr;\n}\n\n\n// EXPORTS //\n\nexport default filled;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2021 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// MODULES //\n\nimport filled from '@stdlib/array-base-filled';\n\n\n// MAIN //\n\n/**\n* Returns a zero-filled \"generic\" array.\n*\n* @param {NonNegativeInteger} len - array length\n* @returns {Array} output array\n*\n* @example\n* var out = zeros( 3 );\n* // returns [ 0.0, 0.0, 0.0 ]\n*/\nfunction zeros( len ) {\n\treturn filled( 0.0, len );\n}\n\n\n// EXPORTS //\n\nexport default zeros;\n"],"names":["copy","x","out","len","i","length","push","fmtprodmsg","a","arguments","u","encodeURIComponent","inShape","outShape","data","dim","st","N","M","d","j","Error","format","value","arr","filled","join","ref","shape","strides"],"mappings":";yCAgCA,SAASA,EAAMC,GACd,IAAIC,EACAC,EACAC,EAIJ,IAFAD,EAAMF,EAAEI,OACRH,EAAM,GACAE,EAAI,EAAGA,EAAID,EAAKC,IACrBF,EAAII,KAAML,EAAGG,IAEd,OAAOF,CACR,CCVA,SAASK,IACR,IAGIH,EAHAI,EAAIC,UAEJC,EAAI,uBADAF,EAAG,GACsB,IAEjC,IAAMJ,EAAI,EAAGA,EAAII,EAAEH,OAAQD,IAC1BM,GAAK,UAAYC,mBAAoBH,EAAGJ,IAEzC,OAAOM,CACR,QC2CA,SAAyBT,EAAGW,EAASC,GACpC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAf,EACAgB,EAIJ,IAFAH,EAAIJ,EAASR,SACba,EAAIN,EAAQP,QAEX,MAAM,IAAIgB,MAAOC,EAAO,UAIzB,IADAR,EAAOb,EACDG,EAAIc,EAAGd,EAAIa,EAAGb,IACnBU,EAAO,CAAEA,GAOV,IAHAE,ECtED,SAAiBO,EAAOpB,GACvB,IAAIqB,EACApB,EAIJ,IADAoB,EAAM,GACApB,EAAI,EAAGA,EAAID,EAAKC,IACrBoB,EAAIlB,KAAMiB,GAEX,OAAOC,CACR,CCTQC,CAAQ,EFqEHR,GAGNb,EAAIa,EAAE,EAAGb,GAAK,EAAGA,IAEtB,MADAgB,EAAIF,EAAID,EAAIb,GACH,GAAT,CAMA,GAFAe,EAAIP,EAASQ,GAEA,KADbL,EAAMF,EAAUT,KACEW,EAAMI,EACvB,MAAM,IAAIE,MAAOC,EAAQ,QAAStB,EAAMY,GAAUc,KAAM,MAAQ1B,EAAMa,GAAWa,KAAM,MAAQtB,IAEhG,GAAKe,IAAMJ,EAEVC,EAAIZ,GAAM,MACJ,IAAW,IAANe,EAKX,MAAM,IAAIE,MAAOC,EAAQ,QAAStB,EAAMY,GAAUc,KAAM,MAAQ1B,EAAMa,GAAWa,KAAM,MAAQtB,IAH/FY,EAAIZ,GAAM,CAIV,CAfA,CAkBF,MAAO,CACNuB,IAAO1B,EACPa,KAAQA,EACRc,MAAS5B,EAAMa,GACfgB,QAAWb,EAEb","x_google_ignoreList":[0,1,3,4]} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 83992bb..0000000 --- a/lib/index.js +++ /dev/null @@ -1,57 +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 array to a specified shape. -* -* @module @stdlib/array-base-broadcast-array -* -* @example -* var broadcastArray = require( '@stdlib/array-base-broadcast-array' ); -* -* var x = [ 1, 2 ]; -* -* var out = broadcastArray( x, [ 2 ], [ 2, 2 ] ); -* // returns {...} -* -* var shape = out.shape; -* // returns [ 2, 2 ] -* -* var strides = out.strides; -* // returns [ 0, 1 ] -* -* var ref = out.ref; -* // returns [ 1, 2 ] -* -* var bool = ( x === ref ); -* // returns true -* -* var data = out.data; -* // returns [ [ 1, 2 ] ] -*/ - -// 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 16676d5..0000000 --- a/lib/main.js +++ /dev/null @@ -1,145 +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 copy = require( '@stdlib/array-base-copy-indexed' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Broadcasts an array to a specified shape. -* -* @param {Collection} x - input array -* @param {NonNegativeIntegerArray} inShape - input array shape -* @param {NonNegativeIntegerArray} outShape - output array shape -* @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 output shape -* @throws {Error} input array and desired shape must be broadcast compatible -* @returns {Object} broadcast object -* -* @example -* var x = [ 1, 2 ]; -* -* var out = broadcastArray( x, [ 2 ], [ 2, 2 ] ); -* // returns {...} -* -* var shape = out.shape; -* // returns [ 2, 2 ] -* -* var strides = out.strides; -* // returns [ 0, 1 ] -* -* var ref = out.ref; -* // returns [ 1, 2 ] -* -* var bool = ( x === ref ); -* // returns true -* -* var data = out.data; -* // returns [ [ 1, 2 ] ] -* -* @example -* var x = [ 1, 2 ]; -* -* var out = broadcastArray( x, [ 2 ], [ 2, 1, 2 ] ); -* // returns {...} -* -* var data = out.data; -* // returns [ [ [ 1, 2 ] ] ] -* -* var strides = out.strides; -* // returns [ 0, 0, 1 ] -* -* @example -* var x = [ [ 1 ], [ 2 ] ]; -* -* var out = broadcastArray( x, [ 2, 1 ], [ 3, 2, 2 ] ); -* // returns {...} -* -* var data = out.data; -* // returns [ [ [ 1 ], [ 2 ] ] ] -* -* var strides = out.strides; -* // returns [ 0, 1, 0 ] -*/ -function broadcastArray( x, inShape, outShape ) { - var data; - var dim; - var st; - var N; - var M; - var d; - var i; - var j; - - N = outShape.length; - M = inShape.length; - if ( N < M ) { - throw new Error( 'invalid argument. Cannot broadcast an array to a shape having fewer dimensions. Arrays can only be broadcasted to shapes having the same or more dimensions.' ); - } - // Prepend additional dimensions... - data = x; - for ( i = M; i < N; i++ ) { - data = [ data ]; - } - - // Initialize a strides array: - st = zeros( N ); - - // Determine the output array strides... - for ( i = N-1; i >= 0; i-- ) { - j = M - N + i; - if ( j < 0 ) { - // Prepended singleton dimension; stride is zero... - continue; - } - d = inShape[ j ]; - dim = outShape[ i ]; - if ( dim !== 0 && dim < d ) { - throw new Error( format( 'invalid argument. Input array cannot be broadcast to the specified shape, as the specified shape has a dimension whose size is less than the size of the corresponding dimension in the input array. Array shape: (%s). Desired shape: (%s). Dimension: %u.', copy( inShape ).join( ', ' ), copy( outShape ).join( ', ' ), i ) ); - } - if ( d === dim ) { - // As the dimension sizes are equal, the stride is one, meaning that each element in the array should be iterated over as normal... - st[ i ] = 1; - } else if ( d === 1 ) { - // In order to broadcast a dimension, we set the stride for that dimension to zero... - st[ i ] = 0; - } else { - // At this point, we know that `dim > d` and that `d` does not equal `1` (e.g., `dim=3` and `d=2`); in which case, the shapes are considered incompatible (even for desired shapes which are multiples of array dimensions, as might be desired when "tiling" an array; e.g., `dim=4` and `d=2`)... - throw new Error( format( 'invalid argument. Input array and the specified shape are broadcast incompatible. Array shape: (%s). Desired shape: (%s). Dimension: %u.', copy( inShape ).join( ', ' ), copy( outShape ).join( ', ' ), i ) ); - } - } - // Return broadcast results: - return { - 'ref': x, // reference to the original input array - 'data': data, // broadcasted array - 'shape': copy( outShape ), // copy in order to prevent mutation - 'strides': st - }; -} - - -// EXPORTS // - -module.exports = broadcastArray; diff --git a/package.json b/package.json index 61b0707..aeb1745 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,7 @@ "version": "0.2.2", "description": "Broadcast an array to a specified 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" - }, + "main": "./index.js", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,38 +12,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy-indexed": "^0.2.2", - "@stdlib/array-base-zeros": "^0.2.2", - "@stdlib/string-format": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-zeros2d": "^0.2.2", - "@stdlib/array-base-zerosnd": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/math-base-assert-is-even": "^0.2.3", - "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", "utilities", @@ -82,7 +26,6 @@ "multidimensional", "ndarray" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats_browser.html b/stats_browser.html new file mode 100644 index 0000000..c0e0ca2 --- /dev/null +++ b/stats_browser.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/stats_node.html b/stats_node.html new file mode 100644 index 0000000..b2edf62 --- /dev/null +++ b/stats_node.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 ee7b040..0000000 --- a/test/test.js +++ /dev/null @@ -1,323 +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 zeros2d = require( '@stdlib/array-base-zeros2d' ); -var broadcastArray = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof broadcastArray, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an output shape which has fewer dimensions than input array', function test( t ) { - var values; - var x; - var i; - - x = [ [ [ [ [ [ [ [ [ [ ] ] ] ] ] ] ] ] ] ]; - - values = [ - [], - [ 1 ], - [ 1, 1 ], - [ 1, 1, 1 ], - [ 1, 1, 1, 1 ], - [ 1, 1, 1, 1, 1 ], - [ 1, 1, 1, 1, 1, 1 ], - [ 1, 1, 1, 1, 1, 1, 1 ], - [ 1, 1, 1, 1, 1, 1, 1, 1 ], - [ 1, 1, 1, 1, 1, 1, 1, 1, 1 ] - ]; - 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() { - broadcastArray( x, [ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 ], 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 = zeros2d( [ 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() { - broadcastArray( x, [ 10, 10 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a desired shape and an input array shape are broadcast-incompatible', function test( t ) { - var values; - var x; - var i; - - x = zeros2d( [ 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() { - broadcastArray( x, [ 10, 10 ], value ); - }; - } -}); - -tape( 'the function returns a broadcasted array which shares the same data as the input array', function test( t ) { - var x; - var o; - - x = [ 1, 2, 3 ]; - o = broadcastArray( x, [ 3 ], [ 2, 3 ] ); - - t.strictEqual( o.data[ 0 ], x, 'returns expected value' ); - t.end(); -}); - -tape( 'the function broadcasts an input array', function test( t ) { - var expected; - var i0; - var i1; - var x; - var o; - var v; - var i; - var j; - - x = [ 1, 2, 3 ]; - o = broadcastArray( x, [ 3 ], [ 2, 3 ] ); - - expected = [ - [ 1, 2, 3 ], - [ 1, 2, 3 ] - ]; - - t.strictEqual( o.ref, x, 'returns expected value' ); - t.strictEqual( o.data[ 0 ], x, 'returns expected value' ); - - t.deepEqual( o.shape, [ 2, 3 ], 'returns expected value' ); - t.deepEqual( o.strides, [ 0, 1 ], 'returns expected value' ); - - i0 = 0; - for ( i = 0; i < o.shape[ 0 ]; i++ ) { - i1 = 0; - for ( j = 0; j < o.shape[ 1 ]; j++ ) { - v = o.data[ i0 ][ i1 ]; - t.strictEqual( v, expected[ i ][ j ], 'returns expected value ('+i+','+j+')' ); - i1 += o.strides[ 1 ]; - } - i0 += o.strides[ 0 ]; - } - t.end(); -}); - -tape( 'the function broadcasts an input array (same shape)', function test( t ) { - var x; - var o; - - x = [ 1, 2, 3 ]; - o = broadcastArray( x, [ 3 ], [ 3 ] ); - - t.strictEqual( o.ref, x, 'returns expected value' ); - t.strictEqual( o.data, x, 'returns expected value' ); - - t.deepEqual( o.shape, [ 3 ], 'returns expected value' ); - t.deepEqual( o.strides, [ 1 ], 'returns expected value' ); - - t.deepEqual( o.data, [ 1, 2, 3 ], 'returns expected value' ); - - x = [ - [ 1, 2, 3 ], - [ 1, 2, 3 ] - ]; - o = broadcastArray( x, [ 2, 3 ], [ 2, 3 ] ); - - t.strictEqual( o.ref, x, 'returns expected value' ); - t.strictEqual( o.data, x, 'returns expected value' ); - - t.deepEqual( o.shape, [ 2, 3 ], 'returns expected value' ); - t.deepEqual( o.strides, [ 1, 1 ], 'returns expected value' ); - - t.deepEqual( o.data, [ [ 1, 2, 3 ], [ 1, 2, 3 ] ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function broadcasts an input array (same number of dimensions)', function test( t ) { - var expected; - var i0; - var i1; - var x; - var o; - var v; - var i; - var j; - - x = [ [ 1, 2, 3 ] ]; - o = broadcastArray( x, [ 1, 3 ], [ 2, 3 ] ); - - expected = [ - [ 1, 2, 3 ], - [ 1, 2, 3 ] - ]; - - t.strictEqual( o.ref, x, 'returns expected value' ); - t.strictEqual( o.data, x, 'returns expected value' ); - - t.deepEqual( o.shape, [ 2, 3 ], 'returns expected value' ); - t.deepEqual( o.strides, [ 0, 1 ], 'returns expected value' ); - - i0 = 0; - for ( i = 0; i < o.shape[ 0 ]; i++ ) { - i1 = 0; - for ( j = 0; j < o.shape[ 1 ]; j++ ) { - v = o.data[ i0 ][ i1 ]; - t.strictEqual( v, expected[ i ][ j ], 'returns expected value ('+i+','+j+')' ); - i1 += o.strides[ 1 ]; - } - i0 += o.strides[ 0 ]; - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var i0; - var i1; - var i2; - var x; - var o; - var v; - var i; - var j; - var k; - - x = [ [ 1, 2, 3 ] ]; - o = broadcastArray( x, [ 1, 3 ], [ 1, 2, 3 ] ); - - expected = [ - [ - [ 1, 2, 3 ], - [ 1, 2, 3 ] - ] - ]; - - t.strictEqual( o.ref, x, 'returns expected value' ); - t.strictEqual( o.data[ 0 ], x, 'returns expected value' ); - - t.deepEqual( o.shape, [ 1, 2, 3 ], 'returns expected value' ); - t.deepEqual( o.strides, [ 0, 0, 1 ], 'returns expected value' ); - - i0 = 0; - for ( i = 0; i < o.shape[ 0 ]; i++ ) { - i1 = 0; - for ( j = 0; j < o.shape[ 1 ]; j++ ) { - i2 = 0; - for ( k = 0; k < o.shape[ 2 ]; k++ ) { - v = o.data[ i0 ][ i1 ][ i2 ]; - t.strictEqual( v, expected[ i ][ j ][ k ], 'returns expected value ('+i+','+j+','+k+')' ); - i2 += o.strides[ 2 ]; - } - i1 += o.strides[ 1 ]; - } - i0 += o.strides[ 0 ]; - } - t.end(); -}); - -tape( 'the function broadcasts an input array (singleton dimension)', function test( t ) { - var expected; - var i0; - var i1; - var i2; - var x; - var o; - var v; - var i; - var j; - var k; - - x = [ [ 1 ], [ 2 ], [ 3 ] ]; - o = broadcastArray( x, [ 3, 1 ], [ 1, 3, 3 ] ); - - expected = [ - [ - [ 1, 1, 1 ], - [ 2, 2, 2 ], - [ 3, 3, 3 ] - ] - ]; - - t.strictEqual( o.ref, x, 'returns expected value' ); - t.strictEqual( o.data[ 0 ], x, 'returns expected value' ); - - t.deepEqual( o.shape, [ 1, 3, 3 ], 'returns expected value' ); - t.deepEqual( o.strides, [ 0, 1, 0 ], 'returns expected value' ); - - i0 = 0; - for ( i = 0; i < o.shape[ 0 ]; i++ ) { - i1 = 0; - for ( j = 0; j < o.shape[ 1 ]; j++ ) { - i2 = 0; - for ( k = 0; k < o.shape[ 2 ]; k++ ) { - v = o.data[ i0 ][ i1 ][ i2 ]; - t.strictEqual( v, expected[ i ][ j ][ k ], 'returns expected value ('+i+','+j+','+k+')' ); - i2 += o.strides[ 2 ]; - } - i1 += o.strides[ 1 ]; - } - i0 += o.strides[ 0 ]; - } - t.end(); -});