From 305d854f13f0b43487e4cc85d3127aab202b7722 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 8 Sep 2025 02:58:07 +0000 Subject: [PATCH 01/36] Transform error messages --- lib/main.js | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/main.js b/lib/main.js index 3530917..c43ed91 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); var defaults = require( '@stdlib/ndarray-defaults' ); var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // diff --git a/package.json b/package.json index 359a6eb..cc9324d 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.2.2", "@stdlib/ndarray-base-promote-dtypes": "github:stdlib-js/ndarray-base-promote-dtypes#main", "@stdlib/ndarray-defaults": "^0.3.0", - "@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 e29ac587afb18213c74ad1f337b471748ae67465 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 8 Sep 2025 02:58:49 +0000 Subject: [PATCH 02/36] Auto-generated commit --- .editorconfig | 180 - .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 - .github/workflows/test_published_package.yml | 105 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 49 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 160 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 33 - docs/types/test.ts | 84 - examples/index.js | 60 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 40 - lib/main.js | 102 - package.json | 66 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 328 -- 43 files changed, 4869 insertions(+), 4346 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 .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 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 (94%) 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/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a9bf37b..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/base/binary-input-casting-dtype) 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 12cd77e..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/base/binary-input-casting-dtype) 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 a9decd9..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: '19 7 * * 4' - - # 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 + + ```
@@ -199,7 +190,7 @@ logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ] ## 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]. @@ -262,9 +253,9 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-binary-input-casting-dtype/main/LICENSE -[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes +[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes/tree/esm -[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies +[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies/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 ee0b109..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var dtypes = require( '@stdlib/ndarray-dtypes' ); -var pkg = require( './../package.json' ).name; -var resolve = require( './../lib' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'numeric' ); - - -// MAIN // - -bench( pkg+':policy=none', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'none' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=promoted', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'promoted' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=accumulation', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'accumulation' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=output', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'output' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'int32' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1799fb0..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/base/binary-input-casting-dtype" -%% click B href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/binary-input-casting-dtype -[production-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/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 c73d928..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import outputDataType from '../docs/types/index'; -export = outputDataType; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 74fde9e..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var g=v(function(F,o){ -var T=require('@stdlib/ndarray-base-assert-is-floating-point-data-type/dist'),E=require('@stdlib/ndarray-base-assert-is-signed-integer-data-type/dist'),_=require('@stdlib/ndarray-base-assert-is-unsigned-integer-data-type/dist'),f=require('@stdlib/ndarray-base-assert-is-data-type/dist'),u=require('@stdlib/ndarray-base-promote-dtypes/dist'),i=require('@stdlib/ndarray-defaults/dist'),D=require('@stdlib/array-base-join/dist'),s=require('@stdlib/error-tools-fmtprodmsg/dist'),m=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),q=i.get("dtypes.real_floating_point");function I(r,e,a,t){var n;if(t==="none")return r;if(t==="output")return a;if(t==="promoted"){if(n=u([r,e,a]),n===null)throw new Error(s("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",D([r,e],", "),a));return n}if(t==="accumulation")return T(r)||r==="generic"?r:_(r)?u([r,p]):E(r)?u([r,m]):q;if(f(t))return t;throw new TypeError(s("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",t))}o.exports=I -});var l=g();module.exports=l; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 256ac28..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nvar isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' );\nvar isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' );\nvar isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' );\nvar isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );\nvar promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' );\nvar defaults = require( '@stdlib/ndarray-defaults' );\nvar join = require( '@stdlib/array-base-join' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = resolve;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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* Resolve the casting data type for an input ndarray provided to a binary function.\n*\n* @module @stdlib/ndarray-base-binary-input-casting-dtype\n*\n* @example\n* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' );\n*\n* var dt = resolve( 'float64', 'float64', 'float64', 'none' );\n* // returns \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,cAwBA,IAAIC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA4B,QAAS,2DAA4D,EACjGC,EAAa,QAAS,0CAA2C,EACjEC,EAAmB,QAAS,qCAAsC,EAClEC,EAAW,QAAS,0BAA2B,EAC/CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAS,QAAS,uBAAwB,EAK1CC,EAA+BH,EAAS,IAAK,uBAAwB,EACrEI,EAAiCJ,EAAS,IAAK,yBAA0B,EACzEK,EAAoCL,EAAS,IAAK,4BAA6B,EAoBnF,SAASM,EAASC,EAASC,EAASC,EAAQC,EAAS,CACpD,IAAIC,EACJ,GAAKD,IAAW,OAEf,OAAOH,EAER,GAAKG,IAAW,SACf,OAAOD,EAER,GAAKC,IAAW,WAAa,CAE5B,GADAC,EAAKZ,EAAkB,CAAEQ,EAASC,EAASC,CAAO,CAAE,EAC/CE,IAAO,KACX,MAAM,IAAI,MAAOT,EAAQ,sHAAuHD,EAAM,CAAEM,EAASC,CAAQ,EAAG,IAAK,EAAGC,CAAO,CAAE,EAE9L,OAAOE,CACR,CACA,GAAKD,IAAW,eAIf,OAAKf,EAAyBY,CAAQ,GAAKA,IAAY,UAC/CA,EAGHV,EAA2BU,CAAQ,EAChCR,EAAkB,CAAEQ,EAASH,CAA+B,CAAE,EAEjER,EAAyBW,CAAQ,EAC9BR,EAAkB,CAAEQ,EAASJ,CAA6B,CAAE,EAG7DE,EAGR,GAAKP,EAAYY,CAAO,EACvB,OAAOA,EAER,MAAM,IAAI,UAAWR,EAAQ,qFAAsFQ,CAAO,CAAE,CAC7H,CAKAhB,EAAO,QAAUY,ICnEjB,IAAIM,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isFloatingPointDataType", "isSignedIntegerDataType", "isUnsignedIntegerDataType", "isDataType", "promoteDataTypes", "defaults", "join", "format", "DEFAULT_SIGNED_INTEGER_DTYPE", "DEFAULT_UNSIGNED_INTEGER_DTYPE", "DEFAULT_REAL_FLOATING_POINT_DTYPE", "resolve", "idtype1", "idtype2", "odtype", "policy", "dt", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8eb71cc..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,33 +0,0 @@ - -{{alias}}( idtype1, idtype2, odtype, policy ) - Resolves the casting data type for an input ndarray provided to a binary - function. - - Parameters - ---------- - idtype1: string - Input ndarray data type. - - idtype2: string - Additional input ndarray data type. - - odtype: string - Output ndarray data type. - - policy: string - Input ndarray casting data type policy. If `policy` is a data type, the - function returns the `policy` value. - - Returns - ------- - out: string - Input ndarray casting data type. - - Examples - -------- - > var out = {{alias}}( 'float64', 'float64', 'float64', 'none' ) - 'float64' - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 29c87a8..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 inputCastingDataType = require( './index' ); - - -// TESTS // - -// The function returns a data type... -{ - inputCastingDataType( 'float64', 'float64', 'float64', 'none' ); // $ExpectType DataType -} - -// The compiler throws an error if not provided a first argument which is a data type... -{ - inputCastingDataType( '10', 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( true, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( false, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( null, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( undefined, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( [], 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( {}, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( ( x: number ): number => x, 'float64', 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a second argument which is a data type... -{ - inputCastingDataType( 'float64', '10', 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', true, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', false, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', null, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', undefined, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', [], 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', {}, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', ( x: number ): number => x, 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a third argument which is a data type... -{ - inputCastingDataType( 'float64', 'float64', '10', 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', true, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', false, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', null, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', undefined, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', [], 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', {}, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', ( x: number ): number => x, 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a fourth argument which is either a data type or data type policy... -{ - inputCastingDataType( 'float64', 'float64', 'float64', '10' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', true ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', false ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', null ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', undefined ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', [] ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', {} ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - inputCastingDataType(); // $ExpectError - inputCastingDataType( 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', 'none', 'foo' ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 8c7ef88..0000000 --- a/examples/index.js +++ /dev/null @@ -1,60 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var unzip = require( '@stdlib/utils-unzip' ); -var nCartesianProduct = require( '@stdlib/array-base-n-cartesian-product' ); -var logEachMap = require( '@stdlib/console-log-each-map' ); -var inputCastingDataType = require( './../lib' ); - -var idt1 = [ - 'float32', - 'float64' -]; - -var idt2 = [ - 'int8', - 'uint8', - 'uint16', - 'uint32' -]; - -var odt = [ - 'float32', - 'float64', - 'complex64', - 'complex128' -]; - -// Define a list of casting policies: -var policies = [ - 'promoted', - 'accumulation', - 'output' -]; - -// Generate dtype-policy argument groups: -var args = nCartesianProduct( idt1, idt2, odt, policies ); - -// Unzip the argument arrays: -args = unzip( args ); - -// Resolve casting data types: -logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ], args[ 1 ], args[ 2 ], args[ 3 ], naryFunction( inputCastingDataType, 4 ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 94% rename from docs/types/index.d.ts rename to index.d.ts index 80fe519..5e11c50 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..30bcddb --- /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 t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..ea3b324 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;+xBAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 69b2434..0000000 --- a/lib/index.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Resolve the casting data type for an input ndarray provided to a binary function. -* -* @module @stdlib/ndarray-base-binary-input-casting-dtype -* -* @example -* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' ); -* -* var dt = resolve( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ - -// 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 c43ed91..0000000 --- a/lib/main.js +++ /dev/null @@ -1,102 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable id-length, max-len */ - -'use strict'; - -// MODULES // - -var isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' ); -var isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' ); -var isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' ); -var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); -var defaults = require( '@stdlib/ndarray-defaults' ); -var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' ); -var DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' ); -var DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' ); - - -// MAIN // - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param {string} idtype1 - input ndarray data type -* @param {string} idtype2 - additional input ndarray data type -* @param {string} odtype - output ndarray data type -* @param {string} policy - input ndarray data type casting policy -* @throws {TypeError} fourth argument must be a recognized data type policy -* @throws {Error} unexpected error -* @returns {string} data type -* -* @example -* var dt = resolve( 'float32', 'float32', 'float64', 'none' ); -* // returns -*/ -function resolve( idtype1, idtype2, odtype, policy ) { - var dt; - if ( policy === 'none' ) { - // When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is... - return idtype1; - } - if ( policy === 'output' ) { - return odtype; - } - if ( policy === 'promoted' ) { - dt = promoteDataTypes( [ idtype1, idtype2, odtype ] ); - if ( dt === null ) { - throw new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) ); - } - return dt; - } - if ( policy === 'accumulation' ) { - // When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays... - - // If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type... - if ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited - return idtype1; - } - // Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements... - if ( isUnsignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] ); - } - if ( isSignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] ); - } - // For all other input data types, accumulate in the default real-valued floating-point data type... - return DEFAULT_REAL_FLOATING_POINT_DTYPE; - } - // Check for an explicit data type... - if ( isDataType( policy ) ) { - return policy; - } - throw new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) ); -} - - -// EXPORTS // - -module.exports = resolve; diff --git a/package.json b/package.json index cc9324d..d2034f5 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Resolve the casting data type for an input ndarray provided to a binary function.", "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/array-base-join": "^0.1.1", - "@stdlib/ndarray-base-assert-is-data-type": "^0.2.2", - "@stdlib/ndarray-base-assert-is-floating-point-data-type": "^0.2.2", - "@stdlib/ndarray-base-assert-is-signed-integer-data-type": "^0.2.2", - "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.2.2", - "@stdlib/ndarray-base-promote-dtypes": "github:stdlib-js/ndarray-base-promote-dtypes#main", - "@stdlib/ndarray-defaults": "^0.3.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-n-cartesian-product": "^0.2.2", - "@stdlib/console-log-each-map": "github:stdlib-js/console-log-each-map#main", - "@stdlib/ndarray-dtypes": "^0.3.0", - "@stdlib/utils-nary-function": "^0.2.2", - "@stdlib/utils-unzip": "^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", @@ -91,7 +30,6 @@ "resolve", "casting" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..5cf5940 --- /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 6a8c99f..0000000 --- a/test/test.js +++ /dev/null @@ -1,328 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 resolve = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof resolve, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an unsupported/unrecognized casting policy', function test( t ) { - var values; - var i; - - values = [ - 'float', - 'cmplx', - 'beep', - 'boop', - '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() { - resolve( 'float64', 'float64', 'float64', value ); - }; - } -}); - -tape( 'the function throws an error if provided data types which do not promote when the casting policy is "promoted"', function test( t ) { - var dt1; - var dt2; - var dt3; - var i; - - dt1 = [ - 'binary', - 'bool', - 'int32', - 'uint32', - 'binary' - ]; - dt2 = [ - 'generic', - 'float32', - 'bool', - 'int8', - 'int32' - ]; - dt3 = [ - 'float32', - 'int16', - 'float64', - 'bool', - 'float64' - ]; - for ( i = 0; i < dt1.length; i++ ) { - t.throws( badValue( dt1[ i ], dt2[ i ], dt3[ i ] ), Error, 'throws an error when provided '+dt1[ i ]+' and '+dt2[ i ]+' and '+dt3[ i ] ); - } - t.end(); - - function badValue( v1, v2, v3 ) { - return function badValue() { - resolve( v1, v2, v3, 'promoted' ); - }; - } -}); - -tape( 'the function resolves a casting data type (policy=none)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64' - ]; - - expected = dt1; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'none' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=output)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'complex128', - 'float64', - 'uint32', - 'int16', - 'generic' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'output' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=promoted)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'complex64' - ]; - dt2 = [ - 'float64', - 'int16', - 'int32', - 'float64', - 'float64' - ]; - dt3 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'float32' - ]; - expected = [ - 'float64', - 'int16', - 'int32', - 'complex128', - 'complex128' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'promoted' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=accumulation)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int16', - 'generic', - 'complex64', - 'uint16', - 'bool' - ]; - dt2 = [ - 'float16', - 'float64', - 'uint8c', - 'float64', - 'int32', - 'float32', - 'float32', - 'uint8', - 'bool' - ]; - dt3 = [ - 'int8', - 'float64', - 'float16', - 'int16', - 'int32', - 'int32', - 'int16', - 'uint32', - 'bool' - ]; - expected = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int32', - 'generic', - 'complex64', - 'uint32', - 'float64' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'accumulation' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'int8' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], dt3[ i ] ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); From e71e6137de9797ba4c4fb73b0c73a212e79e89c9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 03:28:49 +0000 Subject: [PATCH 03/36] Transform error messages --- lib/main.js | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/main.js b/lib/main.js index 3530917..c43ed91 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); var defaults = require( '@stdlib/ndarray-defaults' ); var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // diff --git a/package.json b/package.json index 981609c..b578a1c 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.0", "@stdlib/ndarray-base-promote-dtypes": "^0.1.0", "@stdlib/ndarray-defaults": "^0.4.0", - "@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 fdf0af0ba4d8e407ab2107657a989023ad86a2d7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 05:12:13 +0000 Subject: [PATCH 04/36] Remove files --- index.d.ts | 43 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4890 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 5e11c50..0000000 --- a/index.d.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param idtype1 - input ndarray data type -* @param idtype2 - additional input ndarray data type -* @param odtype - output ndarray data type -* @param policy - input ndarray casting data type policy -* @returns input ndarray casting data type -* -* @example -* var dt = outputDataType( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ -declare function outputDataType( idtype1: DataType, idtype2: DataType, odtype: DataType, policy: InputCastingPolicy | DataType ): DataType; - - -// EXPORTS // - -export = outputDataType; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 30bcddb..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 t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index ea3b324..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;+xBAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 5cf5940..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From a0c39fc7108bbda79429bd4193244408d789131e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 05:12:30 +0000 Subject: [PATCH 05/36] Auto-generated commit --- .editorconfig | 180 - .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 | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 108 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 49 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 160 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 33 - docs/types/test.ts | 84 - examples/index.js | 60 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 40 - lib/main.js | 102 - package.json | 65 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 328 -- 43 files changed, 4869 insertions(+), 4445 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 .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 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 (94%) 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/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a9bf37b..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/base/binary-input-casting-dtype) 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 12cd77e..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/base/binary-input-casting-dtype) 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 a9decd9..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: '19 7 * * 4' - - # 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 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +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 notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # 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 + + ```
@@ -199,7 +190,7 @@ logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ] ## 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]. @@ -262,9 +253,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-binary-input-casting-dtype/main/LICENSE -[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes +[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes/tree/esm -[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies +[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies/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 ee0b109..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var dtypes = require( '@stdlib/ndarray-dtypes' ); -var pkg = require( './../package.json' ).name; -var resolve = require( './../lib' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'numeric' ); - - -// MAIN // - -bench( pkg+':policy=none', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'none' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=promoted', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'promoted' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=accumulation', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'accumulation' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=output', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'output' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'int32' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1799fb0..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/base/binary-input-casting-dtype" -%% click B href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/binary-input-casting-dtype -[production-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/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 c73d928..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import outputDataType from '../docs/types/index'; -export = outputDataType; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f057822..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var g=v(function(F,o){ -var T=require('@stdlib/ndarray-base-assert-is-floating-point-data-type/dist'),E=require('@stdlib/ndarray-base-assert-is-signed-integer-data-type/dist'),_=require('@stdlib/ndarray-base-assert-is-unsigned-integer-data-type/dist'),f=require('@stdlib/ndarray-base-assert-is-data-type/dist'),u=require('@stdlib/ndarray-base-promote-dtypes/dist'),i=require('@stdlib/ndarray-defaults/dist'),D=require('@stdlib/array-base-join/dist'),s=require('@stdlib/error-tools-fmtprodmsg/dist'),m=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),q=i.get("dtypes.real_floating_point");function I(r,e,a,t){var n;if(t==="none")return r;if(t==="output")return a;if(t==="promoted"){if(n=u([r,e,a]),n===null)throw new Error(s('2VTJR',D([r,e],", "),a));return n}if(t==="accumulation")return T(r)||r==="generic"?r:_(r)?u([r,p]):E(r)?u([r,m]):q;if(f(t))return t;throw new TypeError(s('2VTJS',t))}o.exports=I -});var l=g();module.exports=l; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 256ac28..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nvar isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' );\nvar isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' );\nvar isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' );\nvar isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );\nvar promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' );\nvar defaults = require( '@stdlib/ndarray-defaults' );\nvar join = require( '@stdlib/array-base-join' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = resolve;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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* Resolve the casting data type for an input ndarray provided to a binary function.\n*\n* @module @stdlib/ndarray-base-binary-input-casting-dtype\n*\n* @example\n* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' );\n*\n* var dt = resolve( 'float64', 'float64', 'float64', 'none' );\n* // returns \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,cAwBA,IAAIC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA4B,QAAS,2DAA4D,EACjGC,EAAa,QAAS,0CAA2C,EACjEC,EAAmB,QAAS,qCAAsC,EAClEC,EAAW,QAAS,0BAA2B,EAC/CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAS,QAAS,uBAAwB,EAK1CC,EAA+BH,EAAS,IAAK,uBAAwB,EACrEI,EAAiCJ,EAAS,IAAK,yBAA0B,EACzEK,EAAoCL,EAAS,IAAK,4BAA6B,EAoBnF,SAASM,EAASC,EAASC,EAASC,EAAQC,EAAS,CACpD,IAAIC,EACJ,GAAKD,IAAW,OAEf,OAAOH,EAER,GAAKG,IAAW,SACf,OAAOD,EAER,GAAKC,IAAW,WAAa,CAE5B,GADAC,EAAKZ,EAAkB,CAAEQ,EAASC,EAASC,CAAO,CAAE,EAC/CE,IAAO,KACX,MAAM,IAAI,MAAOT,EAAQ,sHAAuHD,EAAM,CAAEM,EAASC,CAAQ,EAAG,IAAK,EAAGC,CAAO,CAAE,EAE9L,OAAOE,CACR,CACA,GAAKD,IAAW,eAIf,OAAKf,EAAyBY,CAAQ,GAAKA,IAAY,UAC/CA,EAGHV,EAA2BU,CAAQ,EAChCR,EAAkB,CAAEQ,EAASH,CAA+B,CAAE,EAEjER,EAAyBW,CAAQ,EAC9BR,EAAkB,CAAEQ,EAASJ,CAA6B,CAAE,EAG7DE,EAGR,GAAKP,EAAYY,CAAO,EACvB,OAAOA,EAER,MAAM,IAAI,UAAWR,EAAQ,qFAAsFQ,CAAO,CAAE,CAC7H,CAKAhB,EAAO,QAAUY,ICnEjB,IAAIM,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isFloatingPointDataType", "isSignedIntegerDataType", "isUnsignedIntegerDataType", "isDataType", "promoteDataTypes", "defaults", "join", "format", "DEFAULT_SIGNED_INTEGER_DTYPE", "DEFAULT_UNSIGNED_INTEGER_DTYPE", "DEFAULT_REAL_FLOATING_POINT_DTYPE", "resolve", "idtype1", "idtype2", "odtype", "policy", "dt", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8eb71cc..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,33 +0,0 @@ - -{{alias}}( idtype1, idtype2, odtype, policy ) - Resolves the casting data type for an input ndarray provided to a binary - function. - - Parameters - ---------- - idtype1: string - Input ndarray data type. - - idtype2: string - Additional input ndarray data type. - - odtype: string - Output ndarray data type. - - policy: string - Input ndarray casting data type policy. If `policy` is a data type, the - function returns the `policy` value. - - Returns - ------- - out: string - Input ndarray casting data type. - - Examples - -------- - > var out = {{alias}}( 'float64', 'float64', 'float64', 'none' ) - 'float64' - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 29c87a8..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 inputCastingDataType = require( './index' ); - - -// TESTS // - -// The function returns a data type... -{ - inputCastingDataType( 'float64', 'float64', 'float64', 'none' ); // $ExpectType DataType -} - -// The compiler throws an error if not provided a first argument which is a data type... -{ - inputCastingDataType( '10', 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( true, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( false, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( null, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( undefined, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( [], 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( {}, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( ( x: number ): number => x, 'float64', 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a second argument which is a data type... -{ - inputCastingDataType( 'float64', '10', 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', true, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', false, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', null, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', undefined, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', [], 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', {}, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', ( x: number ): number => x, 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a third argument which is a data type... -{ - inputCastingDataType( 'float64', 'float64', '10', 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', true, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', false, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', null, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', undefined, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', [], 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', {}, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', ( x: number ): number => x, 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a fourth argument which is either a data type or data type policy... -{ - inputCastingDataType( 'float64', 'float64', 'float64', '10' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', true ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', false ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', null ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', undefined ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', [] ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', {} ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - inputCastingDataType(); // $ExpectError - inputCastingDataType( 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', 'none', 'foo' ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 8c7ef88..0000000 --- a/examples/index.js +++ /dev/null @@ -1,60 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var unzip = require( '@stdlib/utils-unzip' ); -var nCartesianProduct = require( '@stdlib/array-base-n-cartesian-product' ); -var logEachMap = require( '@stdlib/console-log-each-map' ); -var inputCastingDataType = require( './../lib' ); - -var idt1 = [ - 'float32', - 'float64' -]; - -var idt2 = [ - 'int8', - 'uint8', - 'uint16', - 'uint32' -]; - -var odt = [ - 'float32', - 'float64', - 'complex64', - 'complex128' -]; - -// Define a list of casting policies: -var policies = [ - 'promoted', - 'accumulation', - 'output' -]; - -// Generate dtype-policy argument groups: -var args = nCartesianProduct( idt1, idt2, odt, policies ); - -// Unzip the argument arrays: -args = unzip( args ); - -// Resolve casting data types: -logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ], args[ 1 ], args[ 2 ], args[ 3 ], naryFunction( inputCastingDataType, 4 ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 94% rename from docs/types/index.d.ts rename to index.d.ts index 80fe519..5e11c50 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..798815a --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.0-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8314587 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 69b2434..0000000 --- a/lib/index.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Resolve the casting data type for an input ndarray provided to a binary function. -* -* @module @stdlib/ndarray-base-binary-input-casting-dtype -* -* @example -* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' ); -* -* var dt = resolve( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ - -// 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 c43ed91..0000000 --- a/lib/main.js +++ /dev/null @@ -1,102 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable id-length, max-len */ - -'use strict'; - -// MODULES // - -var isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' ); -var isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' ); -var isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' ); -var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); -var defaults = require( '@stdlib/ndarray-defaults' ); -var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' ); -var DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' ); -var DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' ); - - -// MAIN // - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param {string} idtype1 - input ndarray data type -* @param {string} idtype2 - additional input ndarray data type -* @param {string} odtype - output ndarray data type -* @param {string} policy - input ndarray data type casting policy -* @throws {TypeError} fourth argument must be a recognized data type policy -* @throws {Error} unexpected error -* @returns {string} data type -* -* @example -* var dt = resolve( 'float32', 'float32', 'float64', 'none' ); -* // returns -*/ -function resolve( idtype1, idtype2, odtype, policy ) { - var dt; - if ( policy === 'none' ) { - // When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is... - return idtype1; - } - if ( policy === 'output' ) { - return odtype; - } - if ( policy === 'promoted' ) { - dt = promoteDataTypes( [ idtype1, idtype2, odtype ] ); - if ( dt === null ) { - throw new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) ); - } - return dt; - } - if ( policy === 'accumulation' ) { - // When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays... - - // If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type... - if ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited - return idtype1; - } - // Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements... - if ( isUnsignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] ); - } - if ( isSignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] ); - } - // For all other input data types, accumulate in the default real-valued floating-point data type... - return DEFAULT_REAL_FLOATING_POINT_DTYPE; - } - // Check for an explicit data type... - if ( isDataType( policy ) ) { - return policy; - } - throw new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) ); -} - - -// EXPORTS // - -module.exports = resolve; diff --git a/package.json b/package.json index b578a1c..97ba42a 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Resolve the casting data type for an input ndarray provided to a binary function.", "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/array-base-join": "^0.1.1", - "@stdlib/ndarray-base-assert-is-data-type": "^0.2.2", - "@stdlib/ndarray-base-assert-is-floating-point-data-type": "^0.3.0", - "@stdlib/ndarray-base-assert-is-signed-integer-data-type": "^0.3.0", - "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.0", - "@stdlib/ndarray-base-promote-dtypes": "^0.1.0", - "@stdlib/ndarray-defaults": "^0.4.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-n-cartesian-product": "^0.2.2", - "@stdlib/console-log-each-map": "^0.1.0", - "@stdlib/ndarray-dtypes": "^0.3.0", - "@stdlib/utils-nary-function": "^0.2.3", - "@stdlib/utils-unzip": "^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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..adbdecd --- /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 6a8c99f..0000000 --- a/test/test.js +++ /dev/null @@ -1,328 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 resolve = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof resolve, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an unsupported/unrecognized casting policy', function test( t ) { - var values; - var i; - - values = [ - 'float', - 'cmplx', - 'beep', - 'boop', - '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() { - resolve( 'float64', 'float64', 'float64', value ); - }; - } -}); - -tape( 'the function throws an error if provided data types which do not promote when the casting policy is "promoted"', function test( t ) { - var dt1; - var dt2; - var dt3; - var i; - - dt1 = [ - 'binary', - 'bool', - 'int32', - 'uint32', - 'binary' - ]; - dt2 = [ - 'generic', - 'float32', - 'bool', - 'int8', - 'int32' - ]; - dt3 = [ - 'float32', - 'int16', - 'float64', - 'bool', - 'float64' - ]; - for ( i = 0; i < dt1.length; i++ ) { - t.throws( badValue( dt1[ i ], dt2[ i ], dt3[ i ] ), Error, 'throws an error when provided '+dt1[ i ]+' and '+dt2[ i ]+' and '+dt3[ i ] ); - } - t.end(); - - function badValue( v1, v2, v3 ) { - return function badValue() { - resolve( v1, v2, v3, 'promoted' ); - }; - } -}); - -tape( 'the function resolves a casting data type (policy=none)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64' - ]; - - expected = dt1; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'none' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=output)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'complex128', - 'float64', - 'uint32', - 'int16', - 'generic' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'output' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=promoted)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'complex64' - ]; - dt2 = [ - 'float64', - 'int16', - 'int32', - 'float64', - 'float64' - ]; - dt3 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'float32' - ]; - expected = [ - 'float64', - 'int16', - 'int32', - 'complex128', - 'complex128' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'promoted' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=accumulation)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int16', - 'generic', - 'complex64', - 'uint16', - 'bool' - ]; - dt2 = [ - 'float16', - 'float64', - 'uint8c', - 'float64', - 'int32', - 'float32', - 'float32', - 'uint8', - 'bool' - ]; - dt3 = [ - 'int8', - 'float64', - 'float16', - 'int16', - 'int32', - 'int32', - 'int16', - 'uint32', - 'bool' - ]; - expected = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int32', - 'generic', - 'complex64', - 'uint32', - 'float64' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'accumulation' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'int8' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], dt3[ i ] ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); From 00f78470e322bda1a5c5ba33146a5e88eb23f2c7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 05:52:12 +0000 Subject: [PATCH 06/36] 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 4bca2a7..282751d 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ limitations under the License. ```javascript -import binaryInputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@esm/index.mjs'; +import binaryInputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@v0.1.0-esm/index.mjs'; ``` #### binaryInputCastingDataType( idtype1, idtype2, odtype, policy ) @@ -119,7 +119,7 @@ import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-funct import unzip from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-unzip@esm/index.mjs'; import nCartesianProduct from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-n-cartesian-product@esm/index.mjs'; import logEachMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/console-log-each-map@esm/index.mjs'; -import inputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@esm/index.mjs'; +import inputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@v0.1.0-esm/index.mjs'; var idt1 = [ 'float32', From 7d68f935d38753625efb2ae36b7ba69ef11ed2b3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 05:52:13 +0000 Subject: [PATCH 07/36] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 282751d..34a6223 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,11 @@ limitations under the License. +```javascript +import binaryInputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@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-base-binary-input-casting-dtype/tags). For example, + ```javascript import binaryInputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@v0.1.0-esm/index.mjs'; ``` @@ -119,7 +124,7 @@ import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-funct import unzip from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-unzip@esm/index.mjs'; import nCartesianProduct from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-n-cartesian-product@esm/index.mjs'; import logEachMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/console-log-each-map@esm/index.mjs'; -import inputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@v0.1.0-esm/index.mjs'; +import inputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@esm/index.mjs'; var idt1 = [ 'float32', From d72635f184c1678d9bcc2178adf15514bdf824fd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 20:34:37 +0000 Subject: [PATCH 08/36] Transform error messages --- lib/main.js | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/main.js b/lib/main.js index 3530917..c43ed91 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); var defaults = require( '@stdlib/ndarray-defaults' ); var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // diff --git a/package.json b/package.json index 263f971..c3ebac9 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.4.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, From d0d41391b44872d32de3bc12fa653b45a7eaaba8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 21:44:52 +0000 Subject: [PATCH 09/36] Remove files --- index.d.ts | 43 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4890 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 5e11c50..0000000 --- a/index.d.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param idtype1 - input ndarray data type -* @param idtype2 - additional input ndarray data type -* @param odtype - output ndarray data type -* @param policy - input ndarray casting data type policy -* @returns input ndarray casting data type -* -* @example -* var dt = outputDataType( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ -declare function outputDataType( idtype1: DataType, idtype2: DataType, odtype: DataType, policy: InputCastingPolicy | DataType ): DataType; - - -// EXPORTS // - -export = outputDataType; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 798815a..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.0-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 8314587..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index adbdecd..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 7a44ce2edbdef1bb8135edd946253964201c1bbf Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 21:45:12 +0000 Subject: [PATCH 10/36] Auto-generated commit --- .editorconfig | 180 - .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 | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 59 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 160 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 33 - docs/types/test.ts | 84 - examples/index.js | 60 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 40 - lib/main.js | 102 - package.json | 65 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 328 -- 43 files changed, 4869 insertions(+), 4448 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 .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 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 (94%) 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/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a9bf37b..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/base/binary-input-casting-dtype) 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 12cd77e..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/base/binary-input-casting-dtype) 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 a9decd9..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: '19 7 * * 4' - - # 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 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +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 notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # 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 + + ```
@@ -199,7 +190,7 @@ logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ] ## 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]. @@ -262,9 +253,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-binary-input-casting-dtype/main/LICENSE -[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes +[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes/tree/esm -[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies +[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies/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 ee0b109..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var dtypes = require( '@stdlib/ndarray-dtypes' ); -var pkg = require( './../package.json' ).name; -var resolve = require( './../lib' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'numeric' ); - - -// MAIN // - -bench( pkg+':policy=none', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'none' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=promoted', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'promoted' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=accumulation', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'accumulation' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=output', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'output' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'int32' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1799fb0..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/base/binary-input-casting-dtype" -%% click B href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/binary-input-casting-dtype -[production-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/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 c73d928..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import outputDataType from '../docs/types/index'; -export = outputDataType; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f057822..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var g=v(function(F,o){ -var T=require('@stdlib/ndarray-base-assert-is-floating-point-data-type/dist'),E=require('@stdlib/ndarray-base-assert-is-signed-integer-data-type/dist'),_=require('@stdlib/ndarray-base-assert-is-unsigned-integer-data-type/dist'),f=require('@stdlib/ndarray-base-assert-is-data-type/dist'),u=require('@stdlib/ndarray-base-promote-dtypes/dist'),i=require('@stdlib/ndarray-defaults/dist'),D=require('@stdlib/array-base-join/dist'),s=require('@stdlib/error-tools-fmtprodmsg/dist'),m=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),q=i.get("dtypes.real_floating_point");function I(r,e,a,t){var n;if(t==="none")return r;if(t==="output")return a;if(t==="promoted"){if(n=u([r,e,a]),n===null)throw new Error(s('2VTJR',D([r,e],", "),a));return n}if(t==="accumulation")return T(r)||r==="generic"?r:_(r)?u([r,p]):E(r)?u([r,m]):q;if(f(t))return t;throw new TypeError(s('2VTJS',t))}o.exports=I -});var l=g();module.exports=l; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 256ac28..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nvar isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' );\nvar isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' );\nvar isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' );\nvar isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );\nvar promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' );\nvar defaults = require( '@stdlib/ndarray-defaults' );\nvar join = require( '@stdlib/array-base-join' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = resolve;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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* Resolve the casting data type for an input ndarray provided to a binary function.\n*\n* @module @stdlib/ndarray-base-binary-input-casting-dtype\n*\n* @example\n* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' );\n*\n* var dt = resolve( 'float64', 'float64', 'float64', 'none' );\n* // returns \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,cAwBA,IAAIC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA4B,QAAS,2DAA4D,EACjGC,EAAa,QAAS,0CAA2C,EACjEC,EAAmB,QAAS,qCAAsC,EAClEC,EAAW,QAAS,0BAA2B,EAC/CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAS,QAAS,uBAAwB,EAK1CC,EAA+BH,EAAS,IAAK,uBAAwB,EACrEI,EAAiCJ,EAAS,IAAK,yBAA0B,EACzEK,EAAoCL,EAAS,IAAK,4BAA6B,EAoBnF,SAASM,EAASC,EAASC,EAASC,EAAQC,EAAS,CACpD,IAAIC,EACJ,GAAKD,IAAW,OAEf,OAAOH,EAER,GAAKG,IAAW,SACf,OAAOD,EAER,GAAKC,IAAW,WAAa,CAE5B,GADAC,EAAKZ,EAAkB,CAAEQ,EAASC,EAASC,CAAO,CAAE,EAC/CE,IAAO,KACX,MAAM,IAAI,MAAOT,EAAQ,sHAAuHD,EAAM,CAAEM,EAASC,CAAQ,EAAG,IAAK,EAAGC,CAAO,CAAE,EAE9L,OAAOE,CACR,CACA,GAAKD,IAAW,eAIf,OAAKf,EAAyBY,CAAQ,GAAKA,IAAY,UAC/CA,EAGHV,EAA2BU,CAAQ,EAChCR,EAAkB,CAAEQ,EAASH,CAA+B,CAAE,EAEjER,EAAyBW,CAAQ,EAC9BR,EAAkB,CAAEQ,EAASJ,CAA6B,CAAE,EAG7DE,EAGR,GAAKP,EAAYY,CAAO,EACvB,OAAOA,EAER,MAAM,IAAI,UAAWR,EAAQ,qFAAsFQ,CAAO,CAAE,CAC7H,CAKAhB,EAAO,QAAUY,ICnEjB,IAAIM,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isFloatingPointDataType", "isSignedIntegerDataType", "isUnsignedIntegerDataType", "isDataType", "promoteDataTypes", "defaults", "join", "format", "DEFAULT_SIGNED_INTEGER_DTYPE", "DEFAULT_UNSIGNED_INTEGER_DTYPE", "DEFAULT_REAL_FLOATING_POINT_DTYPE", "resolve", "idtype1", "idtype2", "odtype", "policy", "dt", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8eb71cc..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,33 +0,0 @@ - -{{alias}}( idtype1, idtype2, odtype, policy ) - Resolves the casting data type for an input ndarray provided to a binary - function. - - Parameters - ---------- - idtype1: string - Input ndarray data type. - - idtype2: string - Additional input ndarray data type. - - odtype: string - Output ndarray data type. - - policy: string - Input ndarray casting data type policy. If `policy` is a data type, the - function returns the `policy` value. - - Returns - ------- - out: string - Input ndarray casting data type. - - Examples - -------- - > var out = {{alias}}( 'float64', 'float64', 'float64', 'none' ) - 'float64' - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 29c87a8..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 inputCastingDataType = require( './index' ); - - -// TESTS // - -// The function returns a data type... -{ - inputCastingDataType( 'float64', 'float64', 'float64', 'none' ); // $ExpectType DataType -} - -// The compiler throws an error if not provided a first argument which is a data type... -{ - inputCastingDataType( '10', 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( true, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( false, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( null, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( undefined, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( [], 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( {}, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( ( x: number ): number => x, 'float64', 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a second argument which is a data type... -{ - inputCastingDataType( 'float64', '10', 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', true, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', false, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', null, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', undefined, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', [], 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', {}, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', ( x: number ): number => x, 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a third argument which is a data type... -{ - inputCastingDataType( 'float64', 'float64', '10', 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', true, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', false, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', null, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', undefined, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', [], 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', {}, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', ( x: number ): number => x, 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a fourth argument which is either a data type or data type policy... -{ - inputCastingDataType( 'float64', 'float64', 'float64', '10' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', true ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', false ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', null ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', undefined ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', [] ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', {} ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - inputCastingDataType(); // $ExpectError - inputCastingDataType( 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', 'none', 'foo' ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 8c7ef88..0000000 --- a/examples/index.js +++ /dev/null @@ -1,60 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var unzip = require( '@stdlib/utils-unzip' ); -var nCartesianProduct = require( '@stdlib/array-base-n-cartesian-product' ); -var logEachMap = require( '@stdlib/console-log-each-map' ); -var inputCastingDataType = require( './../lib' ); - -var idt1 = [ - 'float32', - 'float64' -]; - -var idt2 = [ - 'int8', - 'uint8', - 'uint16', - 'uint32' -]; - -var odt = [ - 'float32', - 'float64', - 'complex64', - 'complex128' -]; - -// Define a list of casting policies: -var policies = [ - 'promoted', - 'accumulation', - 'output' -]; - -// Generate dtype-policy argument groups: -var args = nCartesianProduct( idt1, idt2, odt, policies ); - -// Unzip the argument arrays: -args = unzip( args ); - -// Resolve casting data types: -logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ], args[ 1 ], args[ 2 ], args[ 3 ], naryFunction( inputCastingDataType, 4 ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 94% rename from docs/types/index.d.ts rename to index.d.ts index 80fe519..5e11c50 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6687c07 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8314587 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 69b2434..0000000 --- a/lib/index.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Resolve the casting data type for an input ndarray provided to a binary function. -* -* @module @stdlib/ndarray-base-binary-input-casting-dtype -* -* @example -* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' ); -* -* var dt = resolve( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ - -// 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 c43ed91..0000000 --- a/lib/main.js +++ /dev/null @@ -1,102 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable id-length, max-len */ - -'use strict'; - -// MODULES // - -var isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' ); -var isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' ); -var isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' ); -var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); -var defaults = require( '@stdlib/ndarray-defaults' ); -var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' ); -var DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' ); -var DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' ); - - -// MAIN // - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param {string} idtype1 - input ndarray data type -* @param {string} idtype2 - additional input ndarray data type -* @param {string} odtype - output ndarray data type -* @param {string} policy - input ndarray data type casting policy -* @throws {TypeError} fourth argument must be a recognized data type policy -* @throws {Error} unexpected error -* @returns {string} data type -* -* @example -* var dt = resolve( 'float32', 'float32', 'float64', 'none' ); -* // returns -*/ -function resolve( idtype1, idtype2, odtype, policy ) { - var dt; - if ( policy === 'none' ) { - // When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is... - return idtype1; - } - if ( policy === 'output' ) { - return odtype; - } - if ( policy === 'promoted' ) { - dt = promoteDataTypes( [ idtype1, idtype2, odtype ] ); - if ( dt === null ) { - throw new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) ); - } - return dt; - } - if ( policy === 'accumulation' ) { - // When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays... - - // If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type... - if ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited - return idtype1; - } - // Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements... - if ( isUnsignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] ); - } - if ( isSignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] ); - } - // For all other input data types, accumulate in the default real-valued floating-point data type... - return DEFAULT_REAL_FLOATING_POINT_DTYPE; - } - // Check for an explicit data type... - if ( isDataType( policy ) ) { - return policy; - } - throw new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) ); -} - - -// EXPORTS // - -module.exports = resolve; diff --git a/package.json b/package.json index c3ebac9..f5a10c6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Resolve the casting data type for an input ndarray provided to a binary function.", "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/array-base-join": "^0.1.1", - "@stdlib/ndarray-base-assert-is-data-type": "^0.2.3", - "@stdlib/ndarray-base-assert-is-floating-point-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-signed-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", - "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-n-cartesian-product": "^0.2.3", - "@stdlib/console-log-each-map": "^0.1.1", - "@stdlib/ndarray-dtypes": "^0.4.1", - "@stdlib/utils-nary-function": "^0.2.4", - "@stdlib/utils-unzip": "^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.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..aac7650 --- /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 6a8c99f..0000000 --- a/test/test.js +++ /dev/null @@ -1,328 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 resolve = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof resolve, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an unsupported/unrecognized casting policy', function test( t ) { - var values; - var i; - - values = [ - 'float', - 'cmplx', - 'beep', - 'boop', - '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() { - resolve( 'float64', 'float64', 'float64', value ); - }; - } -}); - -tape( 'the function throws an error if provided data types which do not promote when the casting policy is "promoted"', function test( t ) { - var dt1; - var dt2; - var dt3; - var i; - - dt1 = [ - 'binary', - 'bool', - 'int32', - 'uint32', - 'binary' - ]; - dt2 = [ - 'generic', - 'float32', - 'bool', - 'int8', - 'int32' - ]; - dt3 = [ - 'float32', - 'int16', - 'float64', - 'bool', - 'float64' - ]; - for ( i = 0; i < dt1.length; i++ ) { - t.throws( badValue( dt1[ i ], dt2[ i ], dt3[ i ] ), Error, 'throws an error when provided '+dt1[ i ]+' and '+dt2[ i ]+' and '+dt3[ i ] ); - } - t.end(); - - function badValue( v1, v2, v3 ) { - return function badValue() { - resolve( v1, v2, v3, 'promoted' ); - }; - } -}); - -tape( 'the function resolves a casting data type (policy=none)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64' - ]; - - expected = dt1; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'none' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=output)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'complex128', - 'float64', - 'uint32', - 'int16', - 'generic' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'output' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=promoted)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'complex64' - ]; - dt2 = [ - 'float64', - 'int16', - 'int32', - 'float64', - 'float64' - ]; - dt3 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'float32' - ]; - expected = [ - 'float64', - 'int16', - 'int32', - 'complex128', - 'complex128' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'promoted' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=accumulation)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int16', - 'generic', - 'complex64', - 'uint16', - 'bool' - ]; - dt2 = [ - 'float16', - 'float64', - 'uint8c', - 'float64', - 'int32', - 'float32', - 'float32', - 'uint8', - 'bool' - ]; - dt3 = [ - 'int8', - 'float64', - 'float16', - 'int16', - 'int32', - 'int32', - 'int16', - 'uint32', - 'bool' - ]; - expected = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int32', - 'generic', - 'complex64', - 'uint32', - 'float64' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'accumulation' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'int8' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], dt3[ i ] ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); From 96d447858ba5b4d5fa37062207eadba423ccac14 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 22:20:28 +0000 Subject: [PATCH 11/36] Update README.md for ESM bundle v0.1.1 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 488f118..3998a93 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ limitations under the License. ```javascript -import binaryInputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@esm/index.mjs'; +import binaryInputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@v0.1.1-esm/index.mjs'; ``` #### binaryInputCastingDataType( idtype1, idtype2, odtype, policy ) @@ -119,7 +119,7 @@ import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-funct import unzip from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-unzip@esm/index.mjs'; import nCartesianProduct from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-n-cartesian-product@esm/index.mjs'; import logEachMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/console-log-each-map@esm/index.mjs'; -import inputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@esm/index.mjs'; +import inputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@v0.1.1-esm/index.mjs'; var idt1 = [ 'float32', From 2709b9bbbdee8ad982bb4d11220f409df562af11 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 22:20:29 +0000 Subject: [PATCH 12/36] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3998a93..944dc5e 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,11 @@ limitations under the License. +```javascript +import binaryInputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@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-base-binary-input-casting-dtype/tags). For example, + ```javascript import binaryInputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@v0.1.1-esm/index.mjs'; ``` @@ -119,7 +124,7 @@ import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-funct import unzip from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-unzip@esm/index.mjs'; import nCartesianProduct from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-n-cartesian-product@esm/index.mjs'; import logEachMap from 'https://cdn.jsdelivr.net/gh/stdlib-js/console-log-each-map@esm/index.mjs'; -import inputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@v0.1.1-esm/index.mjs'; +import inputCastingDataType from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-binary-input-casting-dtype@esm/index.mjs'; var idt1 = [ 'float32', From f8c8b7e6d2db39d59aefe81d742a045d993cbe1e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Mar 2026 03:08:02 +0000 Subject: [PATCH 13/36] Transform error messages --- lib/main.js | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/main.js b/lib/main.js index 3530917..c43ed91 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); var defaults = require( '@stdlib/ndarray-defaults' ); var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // diff --git a/package.json b/package.json index 3782dc6..86fafb9 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.4.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, From bcbab31b121784339e34e90b3f8f2ea45b48b488 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Mar 2026 04:45:59 +0000 Subject: [PATCH 14/36] Remove files --- index.d.ts | 43 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4890 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 5e11c50..0000000 --- a/index.d.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param idtype1 - input ndarray data type -* @param idtype2 - additional input ndarray data type -* @param odtype - output ndarray data type -* @param policy - input ndarray casting data type policy -* @returns input ndarray casting data type -* -* @example -* var dt = outputDataType( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ -declare function outputDataType( idtype1: DataType, idtype2: DataType, odtype: DataType, policy: InputCastingPolicy | DataType ): DataType; - - -// EXPORTS // - -export = outputDataType; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6687c07..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 8314587..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index aac7650..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From dc8a6184b00b88961f3e1e0d29aabdddad9c525a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Mar 2026 04:46:32 +0000 Subject: [PATCH 15/36] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .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 | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 59 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 160 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 33 - docs/types/test.ts | 84 - examples/index.js | 60 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 40 - lib/main.js | 102 - package.json | 65 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 328 -- 44 files changed, 4869 insertions(+), 4460 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 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 (94%) 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 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +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 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# 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 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +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 - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index eed59f7..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-03-23T02:25:58.517Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a9bf37b..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/base/binary-input-casting-dtype) 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 12cd77e..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/base/binary-input-casting-dtype) 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 a9decd9..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: '19 7 * * 4' - - # 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 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +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 notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # 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 + + ```
@@ -199,7 +190,7 @@ logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ] ## 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]. @@ -262,9 +253,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-binary-input-casting-dtype/main/LICENSE -[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes +[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes/tree/esm -[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies +[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies/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 ee0b109..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var dtypes = require( '@stdlib/ndarray-dtypes' ); -var pkg = require( './../package.json' ).name; -var resolve = require( './../lib' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'numeric' ); - - -// MAIN // - -bench( pkg+':policy=none', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'none' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=promoted', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'promoted' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=accumulation', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'accumulation' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=output', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'output' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'int32' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1799fb0..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/base/binary-input-casting-dtype" -%% click B href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/binary-input-casting-dtype -[production-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/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 c73d928..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import outputDataType from '../docs/types/index'; -export = outputDataType; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f057822..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var g=v(function(F,o){ -var T=require('@stdlib/ndarray-base-assert-is-floating-point-data-type/dist'),E=require('@stdlib/ndarray-base-assert-is-signed-integer-data-type/dist'),_=require('@stdlib/ndarray-base-assert-is-unsigned-integer-data-type/dist'),f=require('@stdlib/ndarray-base-assert-is-data-type/dist'),u=require('@stdlib/ndarray-base-promote-dtypes/dist'),i=require('@stdlib/ndarray-defaults/dist'),D=require('@stdlib/array-base-join/dist'),s=require('@stdlib/error-tools-fmtprodmsg/dist'),m=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),q=i.get("dtypes.real_floating_point");function I(r,e,a,t){var n;if(t==="none")return r;if(t==="output")return a;if(t==="promoted"){if(n=u([r,e,a]),n===null)throw new Error(s('2VTJR',D([r,e],", "),a));return n}if(t==="accumulation")return T(r)||r==="generic"?r:_(r)?u([r,p]):E(r)?u([r,m]):q;if(f(t))return t;throw new TypeError(s('2VTJS',t))}o.exports=I -});var l=g();module.exports=l; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 256ac28..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nvar isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' );\nvar isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' );\nvar isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' );\nvar isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );\nvar promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' );\nvar defaults = require( '@stdlib/ndarray-defaults' );\nvar join = require( '@stdlib/array-base-join' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = resolve;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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* Resolve the casting data type for an input ndarray provided to a binary function.\n*\n* @module @stdlib/ndarray-base-binary-input-casting-dtype\n*\n* @example\n* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' );\n*\n* var dt = resolve( 'float64', 'float64', 'float64', 'none' );\n* // returns \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,cAwBA,IAAIC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA4B,QAAS,2DAA4D,EACjGC,EAAa,QAAS,0CAA2C,EACjEC,EAAmB,QAAS,qCAAsC,EAClEC,EAAW,QAAS,0BAA2B,EAC/CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAS,QAAS,uBAAwB,EAK1CC,EAA+BH,EAAS,IAAK,uBAAwB,EACrEI,EAAiCJ,EAAS,IAAK,yBAA0B,EACzEK,EAAoCL,EAAS,IAAK,4BAA6B,EAoBnF,SAASM,EAASC,EAASC,EAASC,EAAQC,EAAS,CACpD,IAAIC,EACJ,GAAKD,IAAW,OAEf,OAAOH,EAER,GAAKG,IAAW,SACf,OAAOD,EAER,GAAKC,IAAW,WAAa,CAE5B,GADAC,EAAKZ,EAAkB,CAAEQ,EAASC,EAASC,CAAO,CAAE,EAC/CE,IAAO,KACX,MAAM,IAAI,MAAOT,EAAQ,sHAAuHD,EAAM,CAAEM,EAASC,CAAQ,EAAG,IAAK,EAAGC,CAAO,CAAE,EAE9L,OAAOE,CACR,CACA,GAAKD,IAAW,eAIf,OAAKf,EAAyBY,CAAQ,GAAKA,IAAY,UAC/CA,EAGHV,EAA2BU,CAAQ,EAChCR,EAAkB,CAAEQ,EAASH,CAA+B,CAAE,EAEjER,EAAyBW,CAAQ,EAC9BR,EAAkB,CAAEQ,EAASJ,CAA6B,CAAE,EAG7DE,EAGR,GAAKP,EAAYY,CAAO,EACvB,OAAOA,EAER,MAAM,IAAI,UAAWR,EAAQ,qFAAsFQ,CAAO,CAAE,CAC7H,CAKAhB,EAAO,QAAUY,ICnEjB,IAAIM,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isFloatingPointDataType", "isSignedIntegerDataType", "isUnsignedIntegerDataType", "isDataType", "promoteDataTypes", "defaults", "join", "format", "DEFAULT_SIGNED_INTEGER_DTYPE", "DEFAULT_UNSIGNED_INTEGER_DTYPE", "DEFAULT_REAL_FLOATING_POINT_DTYPE", "resolve", "idtype1", "idtype2", "odtype", "policy", "dt", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8eb71cc..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,33 +0,0 @@ - -{{alias}}( idtype1, idtype2, odtype, policy ) - Resolves the casting data type for an input ndarray provided to a binary - function. - - Parameters - ---------- - idtype1: string - Input ndarray data type. - - idtype2: string - Additional input ndarray data type. - - odtype: string - Output ndarray data type. - - policy: string - Input ndarray casting data type policy. If `policy` is a data type, the - function returns the `policy` value. - - Returns - ------- - out: string - Input ndarray casting data type. - - Examples - -------- - > var out = {{alias}}( 'float64', 'float64', 'float64', 'none' ) - 'float64' - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 29c87a8..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 inputCastingDataType = require( './index' ); - - -// TESTS // - -// The function returns a data type... -{ - inputCastingDataType( 'float64', 'float64', 'float64', 'none' ); // $ExpectType DataType -} - -// The compiler throws an error if not provided a first argument which is a data type... -{ - inputCastingDataType( '10', 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( true, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( false, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( null, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( undefined, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( [], 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( {}, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( ( x: number ): number => x, 'float64', 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a second argument which is a data type... -{ - inputCastingDataType( 'float64', '10', 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', true, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', false, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', null, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', undefined, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', [], 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', {}, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', ( x: number ): number => x, 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a third argument which is a data type... -{ - inputCastingDataType( 'float64', 'float64', '10', 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', true, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', false, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', null, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', undefined, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', [], 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', {}, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', ( x: number ): number => x, 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a fourth argument which is either a data type or data type policy... -{ - inputCastingDataType( 'float64', 'float64', 'float64', '10' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', true ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', false ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', null ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', undefined ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', [] ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', {} ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - inputCastingDataType(); // $ExpectError - inputCastingDataType( 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', 'none', 'foo' ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 8c7ef88..0000000 --- a/examples/index.js +++ /dev/null @@ -1,60 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var unzip = require( '@stdlib/utils-unzip' ); -var nCartesianProduct = require( '@stdlib/array-base-n-cartesian-product' ); -var logEachMap = require( '@stdlib/console-log-each-map' ); -var inputCastingDataType = require( './../lib' ); - -var idt1 = [ - 'float32', - 'float64' -]; - -var idt2 = [ - 'int8', - 'uint8', - 'uint16', - 'uint32' -]; - -var odt = [ - 'float32', - 'float64', - 'complex64', - 'complex128' -]; - -// Define a list of casting policies: -var policies = [ - 'promoted', - 'accumulation', - 'output' -]; - -// Generate dtype-policy argument groups: -var args = nCartesianProduct( idt1, idt2, odt, policies ); - -// Unzip the argument arrays: -args = unzip( args ); - -// Resolve casting data types: -logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ], args[ 1 ], args[ 2 ], args[ 3 ], naryFunction( inputCastingDataType, 4 ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 94% rename from docs/types/index.d.ts rename to index.d.ts index 80fe519..5e11c50 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d08ed3c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8314587 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 69b2434..0000000 --- a/lib/index.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Resolve the casting data type for an input ndarray provided to a binary function. -* -* @module @stdlib/ndarray-base-binary-input-casting-dtype -* -* @example -* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' ); -* -* var dt = resolve( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ - -// 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 c43ed91..0000000 --- a/lib/main.js +++ /dev/null @@ -1,102 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable id-length, max-len */ - -'use strict'; - -// MODULES // - -var isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' ); -var isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' ); -var isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' ); -var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); -var defaults = require( '@stdlib/ndarray-defaults' ); -var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' ); -var DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' ); -var DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' ); - - -// MAIN // - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param {string} idtype1 - input ndarray data type -* @param {string} idtype2 - additional input ndarray data type -* @param {string} odtype - output ndarray data type -* @param {string} policy - input ndarray data type casting policy -* @throws {TypeError} fourth argument must be a recognized data type policy -* @throws {Error} unexpected error -* @returns {string} data type -* -* @example -* var dt = resolve( 'float32', 'float32', 'float64', 'none' ); -* // returns -*/ -function resolve( idtype1, idtype2, odtype, policy ) { - var dt; - if ( policy === 'none' ) { - // When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is... - return idtype1; - } - if ( policy === 'output' ) { - return odtype; - } - if ( policy === 'promoted' ) { - dt = promoteDataTypes( [ idtype1, idtype2, odtype ] ); - if ( dt === null ) { - throw new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) ); - } - return dt; - } - if ( policy === 'accumulation' ) { - // When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays... - - // If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type... - if ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited - return idtype1; - } - // Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements... - if ( isUnsignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] ); - } - if ( isSignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] ); - } - // For all other input data types, accumulate in the default real-valued floating-point data type... - return DEFAULT_REAL_FLOATING_POINT_DTYPE; - } - // Check for an explicit data type... - if ( isDataType( policy ) ) { - return policy; - } - throw new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) ); -} - - -// EXPORTS // - -module.exports = resolve; diff --git a/package.json b/package.json index 86fafb9..f5a10c6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Resolve the casting data type for an input ndarray provided to a binary function.", "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/array-base-join": "^0.1.2", - "@stdlib/ndarray-base-assert-is-data-type": "^0.2.3", - "@stdlib/ndarray-base-assert-is-floating-point-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-signed-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", - "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-n-cartesian-product": "^0.2.3", - "@stdlib/console-log-each-map": "^0.1.1", - "@stdlib/ndarray-dtypes": "^0.4.1", - "@stdlib/utils-nary-function": "^0.2.4", - "@stdlib/utils-unzip": "^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.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1acb2b4 --- /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 6a8c99f..0000000 --- a/test/test.js +++ /dev/null @@ -1,328 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 resolve = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof resolve, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an unsupported/unrecognized casting policy', function test( t ) { - var values; - var i; - - values = [ - 'float', - 'cmplx', - 'beep', - 'boop', - '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() { - resolve( 'float64', 'float64', 'float64', value ); - }; - } -}); - -tape( 'the function throws an error if provided data types which do not promote when the casting policy is "promoted"', function test( t ) { - var dt1; - var dt2; - var dt3; - var i; - - dt1 = [ - 'binary', - 'bool', - 'int32', - 'uint32', - 'binary' - ]; - dt2 = [ - 'generic', - 'float32', - 'bool', - 'int8', - 'int32' - ]; - dt3 = [ - 'float32', - 'int16', - 'float64', - 'bool', - 'float64' - ]; - for ( i = 0; i < dt1.length; i++ ) { - t.throws( badValue( dt1[ i ], dt2[ i ], dt3[ i ] ), Error, 'throws an error when provided '+dt1[ i ]+' and '+dt2[ i ]+' and '+dt3[ i ] ); - } - t.end(); - - function badValue( v1, v2, v3 ) { - return function badValue() { - resolve( v1, v2, v3, 'promoted' ); - }; - } -}); - -tape( 'the function resolves a casting data type (policy=none)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64' - ]; - - expected = dt1; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'none' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=output)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'complex128', - 'float64', - 'uint32', - 'int16', - 'generic' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'output' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=promoted)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'complex64' - ]; - dt2 = [ - 'float64', - 'int16', - 'int32', - 'float64', - 'float64' - ]; - dt3 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'float32' - ]; - expected = [ - 'float64', - 'int16', - 'int32', - 'complex128', - 'complex128' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'promoted' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=accumulation)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int16', - 'generic', - 'complex64', - 'uint16', - 'bool' - ]; - dt2 = [ - 'float16', - 'float64', - 'uint8c', - 'float64', - 'int32', - 'float32', - 'float32', - 'uint8', - 'bool' - ]; - dt3 = [ - 'int8', - 'float64', - 'float16', - 'int16', - 'int32', - 'int32', - 'int16', - 'uint32', - 'bool' - ]; - expected = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int32', - 'generic', - 'complex64', - 'uint32', - 'float64' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'accumulation' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'int8' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], dt3[ i ] ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); From cd2afe47a542db85333124f847125059eda3ecff Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 6 Apr 2026 03:32:29 +0000 Subject: [PATCH 16/36] Transform error messages --- lib/main.js | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/main.js b/lib/main.js index 3530917..c43ed91 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); var defaults = require( '@stdlib/ndarray-defaults' ); var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // diff --git a/package.json b/package.json index 3782dc6..86fafb9 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.4.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, From d872ce0f038e6a8442fa3f41b43fe140405f845c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 6 Apr 2026 03:41:08 +0000 Subject: [PATCH 17/36] Remove files --- index.d.ts | 43 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4890 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 5e11c50..0000000 --- a/index.d.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param idtype1 - input ndarray data type -* @param idtype2 - additional input ndarray data type -* @param odtype - output ndarray data type -* @param policy - input ndarray casting data type policy -* @returns input ndarray casting data type -* -* @example -* var dt = outputDataType( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ -declare function outputDataType( idtype1: DataType, idtype2: DataType, odtype: DataType, policy: InputCastingPolicy | DataType ): DataType; - - -// EXPORTS // - -export = outputDataType; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d08ed3c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 8314587..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1acb2b4..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 6af615a47fd86b6f82684a2868920b176a5f1342 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 6 Apr 2026 03:41:28 +0000 Subject: [PATCH 18/36] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .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 | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 59 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 160 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 33 - docs/types/test.ts | 84 - examples/index.js | 60 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 40 - lib/main.js | 102 - package.json | 65 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 328 -- 44 files changed, 4869 insertions(+), 4460 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 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 (94%) 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 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +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 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# 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 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +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 - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 0bc7aa1..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-04-06T03:28:23.147Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a9bf37b..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/base/binary-input-casting-dtype) 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 12cd77e..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/base/binary-input-casting-dtype) 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 a9decd9..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: '19 7 * * 4' - - # 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 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +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 notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # 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 + + ```
@@ -199,7 +190,7 @@ logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ] ## 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]. @@ -262,9 +253,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-binary-input-casting-dtype/main/LICENSE -[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes +[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes/tree/esm -[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies +[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies/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 ee0b109..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var dtypes = require( '@stdlib/ndarray-dtypes' ); -var pkg = require( './../package.json' ).name; -var resolve = require( './../lib' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'numeric' ); - - -// MAIN // - -bench( pkg+':policy=none', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'none' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=promoted', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'promoted' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=accumulation', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'accumulation' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=output', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'output' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'int32' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1799fb0..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/base/binary-input-casting-dtype" -%% click B href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/binary-input-casting-dtype -[production-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/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 c73d928..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import outputDataType from '../docs/types/index'; -export = outputDataType; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f057822..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var g=v(function(F,o){ -var T=require('@stdlib/ndarray-base-assert-is-floating-point-data-type/dist'),E=require('@stdlib/ndarray-base-assert-is-signed-integer-data-type/dist'),_=require('@stdlib/ndarray-base-assert-is-unsigned-integer-data-type/dist'),f=require('@stdlib/ndarray-base-assert-is-data-type/dist'),u=require('@stdlib/ndarray-base-promote-dtypes/dist'),i=require('@stdlib/ndarray-defaults/dist'),D=require('@stdlib/array-base-join/dist'),s=require('@stdlib/error-tools-fmtprodmsg/dist'),m=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),q=i.get("dtypes.real_floating_point");function I(r,e,a,t){var n;if(t==="none")return r;if(t==="output")return a;if(t==="promoted"){if(n=u([r,e,a]),n===null)throw new Error(s('2VTJR',D([r,e],", "),a));return n}if(t==="accumulation")return T(r)||r==="generic"?r:_(r)?u([r,p]):E(r)?u([r,m]):q;if(f(t))return t;throw new TypeError(s('2VTJS',t))}o.exports=I -});var l=g();module.exports=l; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 256ac28..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nvar isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' );\nvar isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' );\nvar isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' );\nvar isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );\nvar promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' );\nvar defaults = require( '@stdlib/ndarray-defaults' );\nvar join = require( '@stdlib/array-base-join' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = resolve;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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* Resolve the casting data type for an input ndarray provided to a binary function.\n*\n* @module @stdlib/ndarray-base-binary-input-casting-dtype\n*\n* @example\n* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' );\n*\n* var dt = resolve( 'float64', 'float64', 'float64', 'none' );\n* // returns \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,cAwBA,IAAIC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA4B,QAAS,2DAA4D,EACjGC,EAAa,QAAS,0CAA2C,EACjEC,EAAmB,QAAS,qCAAsC,EAClEC,EAAW,QAAS,0BAA2B,EAC/CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAS,QAAS,uBAAwB,EAK1CC,EAA+BH,EAAS,IAAK,uBAAwB,EACrEI,EAAiCJ,EAAS,IAAK,yBAA0B,EACzEK,EAAoCL,EAAS,IAAK,4BAA6B,EAoBnF,SAASM,EAASC,EAASC,EAASC,EAAQC,EAAS,CACpD,IAAIC,EACJ,GAAKD,IAAW,OAEf,OAAOH,EAER,GAAKG,IAAW,SACf,OAAOD,EAER,GAAKC,IAAW,WAAa,CAE5B,GADAC,EAAKZ,EAAkB,CAAEQ,EAASC,EAASC,CAAO,CAAE,EAC/CE,IAAO,KACX,MAAM,IAAI,MAAOT,EAAQ,sHAAuHD,EAAM,CAAEM,EAASC,CAAQ,EAAG,IAAK,EAAGC,CAAO,CAAE,EAE9L,OAAOE,CACR,CACA,GAAKD,IAAW,eAIf,OAAKf,EAAyBY,CAAQ,GAAKA,IAAY,UAC/CA,EAGHV,EAA2BU,CAAQ,EAChCR,EAAkB,CAAEQ,EAASH,CAA+B,CAAE,EAEjER,EAAyBW,CAAQ,EAC9BR,EAAkB,CAAEQ,EAASJ,CAA6B,CAAE,EAG7DE,EAGR,GAAKP,EAAYY,CAAO,EACvB,OAAOA,EAER,MAAM,IAAI,UAAWR,EAAQ,qFAAsFQ,CAAO,CAAE,CAC7H,CAKAhB,EAAO,QAAUY,ICnEjB,IAAIM,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isFloatingPointDataType", "isSignedIntegerDataType", "isUnsignedIntegerDataType", "isDataType", "promoteDataTypes", "defaults", "join", "format", "DEFAULT_SIGNED_INTEGER_DTYPE", "DEFAULT_UNSIGNED_INTEGER_DTYPE", "DEFAULT_REAL_FLOATING_POINT_DTYPE", "resolve", "idtype1", "idtype2", "odtype", "policy", "dt", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8eb71cc..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,33 +0,0 @@ - -{{alias}}( idtype1, idtype2, odtype, policy ) - Resolves the casting data type for an input ndarray provided to a binary - function. - - Parameters - ---------- - idtype1: string - Input ndarray data type. - - idtype2: string - Additional input ndarray data type. - - odtype: string - Output ndarray data type. - - policy: string - Input ndarray casting data type policy. If `policy` is a data type, the - function returns the `policy` value. - - Returns - ------- - out: string - Input ndarray casting data type. - - Examples - -------- - > var out = {{alias}}( 'float64', 'float64', 'float64', 'none' ) - 'float64' - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 29c87a8..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 inputCastingDataType = require( './index' ); - - -// TESTS // - -// The function returns a data type... -{ - inputCastingDataType( 'float64', 'float64', 'float64', 'none' ); // $ExpectType DataType -} - -// The compiler throws an error if not provided a first argument which is a data type... -{ - inputCastingDataType( '10', 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( true, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( false, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( null, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( undefined, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( [], 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( {}, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( ( x: number ): number => x, 'float64', 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a second argument which is a data type... -{ - inputCastingDataType( 'float64', '10', 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', true, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', false, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', null, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', undefined, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', [], 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', {}, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', ( x: number ): number => x, 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a third argument which is a data type... -{ - inputCastingDataType( 'float64', 'float64', '10', 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', true, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', false, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', null, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', undefined, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', [], 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', {}, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', ( x: number ): number => x, 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a fourth argument which is either a data type or data type policy... -{ - inputCastingDataType( 'float64', 'float64', 'float64', '10' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', true ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', false ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', null ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', undefined ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', [] ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', {} ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - inputCastingDataType(); // $ExpectError - inputCastingDataType( 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', 'none', 'foo' ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 8c7ef88..0000000 --- a/examples/index.js +++ /dev/null @@ -1,60 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var unzip = require( '@stdlib/utils-unzip' ); -var nCartesianProduct = require( '@stdlib/array-base-n-cartesian-product' ); -var logEachMap = require( '@stdlib/console-log-each-map' ); -var inputCastingDataType = require( './../lib' ); - -var idt1 = [ - 'float32', - 'float64' -]; - -var idt2 = [ - 'int8', - 'uint8', - 'uint16', - 'uint32' -]; - -var odt = [ - 'float32', - 'float64', - 'complex64', - 'complex128' -]; - -// Define a list of casting policies: -var policies = [ - 'promoted', - 'accumulation', - 'output' -]; - -// Generate dtype-policy argument groups: -var args = nCartesianProduct( idt1, idt2, odt, policies ); - -// Unzip the argument arrays: -args = unzip( args ); - -// Resolve casting data types: -logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ], args[ 1 ], args[ 2 ], args[ 3 ], naryFunction( inputCastingDataType, 4 ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 94% rename from docs/types/index.d.ts rename to index.d.ts index 80fe519..5e11c50 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d08ed3c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8314587 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 69b2434..0000000 --- a/lib/index.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Resolve the casting data type for an input ndarray provided to a binary function. -* -* @module @stdlib/ndarray-base-binary-input-casting-dtype -* -* @example -* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' ); -* -* var dt = resolve( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ - -// 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 c43ed91..0000000 --- a/lib/main.js +++ /dev/null @@ -1,102 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable id-length, max-len */ - -'use strict'; - -// MODULES // - -var isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' ); -var isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' ); -var isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' ); -var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); -var defaults = require( '@stdlib/ndarray-defaults' ); -var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' ); -var DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' ); -var DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' ); - - -// MAIN // - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param {string} idtype1 - input ndarray data type -* @param {string} idtype2 - additional input ndarray data type -* @param {string} odtype - output ndarray data type -* @param {string} policy - input ndarray data type casting policy -* @throws {TypeError} fourth argument must be a recognized data type policy -* @throws {Error} unexpected error -* @returns {string} data type -* -* @example -* var dt = resolve( 'float32', 'float32', 'float64', 'none' ); -* // returns -*/ -function resolve( idtype1, idtype2, odtype, policy ) { - var dt; - if ( policy === 'none' ) { - // When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is... - return idtype1; - } - if ( policy === 'output' ) { - return odtype; - } - if ( policy === 'promoted' ) { - dt = promoteDataTypes( [ idtype1, idtype2, odtype ] ); - if ( dt === null ) { - throw new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) ); - } - return dt; - } - if ( policy === 'accumulation' ) { - // When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays... - - // If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type... - if ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited - return idtype1; - } - // Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements... - if ( isUnsignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] ); - } - if ( isSignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] ); - } - // For all other input data types, accumulate in the default real-valued floating-point data type... - return DEFAULT_REAL_FLOATING_POINT_DTYPE; - } - // Check for an explicit data type... - if ( isDataType( policy ) ) { - return policy; - } - throw new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) ); -} - - -// EXPORTS // - -module.exports = resolve; diff --git a/package.json b/package.json index 86fafb9..f5a10c6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Resolve the casting data type for an input ndarray provided to a binary function.", "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/array-base-join": "^0.1.2", - "@stdlib/ndarray-base-assert-is-data-type": "^0.2.3", - "@stdlib/ndarray-base-assert-is-floating-point-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-signed-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", - "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-n-cartesian-product": "^0.2.3", - "@stdlib/console-log-each-map": "^0.1.1", - "@stdlib/ndarray-dtypes": "^0.4.1", - "@stdlib/utils-nary-function": "^0.2.4", - "@stdlib/utils-unzip": "^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.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1acb2b4 --- /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 6a8c99f..0000000 --- a/test/test.js +++ /dev/null @@ -1,328 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 resolve = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof resolve, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an unsupported/unrecognized casting policy', function test( t ) { - var values; - var i; - - values = [ - 'float', - 'cmplx', - 'beep', - 'boop', - '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() { - resolve( 'float64', 'float64', 'float64', value ); - }; - } -}); - -tape( 'the function throws an error if provided data types which do not promote when the casting policy is "promoted"', function test( t ) { - var dt1; - var dt2; - var dt3; - var i; - - dt1 = [ - 'binary', - 'bool', - 'int32', - 'uint32', - 'binary' - ]; - dt2 = [ - 'generic', - 'float32', - 'bool', - 'int8', - 'int32' - ]; - dt3 = [ - 'float32', - 'int16', - 'float64', - 'bool', - 'float64' - ]; - for ( i = 0; i < dt1.length; i++ ) { - t.throws( badValue( dt1[ i ], dt2[ i ], dt3[ i ] ), Error, 'throws an error when provided '+dt1[ i ]+' and '+dt2[ i ]+' and '+dt3[ i ] ); - } - t.end(); - - function badValue( v1, v2, v3 ) { - return function badValue() { - resolve( v1, v2, v3, 'promoted' ); - }; - } -}); - -tape( 'the function resolves a casting data type (policy=none)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64' - ]; - - expected = dt1; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'none' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=output)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'complex128', - 'float64', - 'uint32', - 'int16', - 'generic' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'output' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=promoted)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'complex64' - ]; - dt2 = [ - 'float64', - 'int16', - 'int32', - 'float64', - 'float64' - ]; - dt3 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'float32' - ]; - expected = [ - 'float64', - 'int16', - 'int32', - 'complex128', - 'complex128' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'promoted' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=accumulation)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int16', - 'generic', - 'complex64', - 'uint16', - 'bool' - ]; - dt2 = [ - 'float16', - 'float64', - 'uint8c', - 'float64', - 'int32', - 'float32', - 'float32', - 'uint8', - 'bool' - ]; - dt3 = [ - 'int8', - 'float64', - 'float16', - 'int16', - 'int32', - 'int32', - 'int16', - 'uint32', - 'bool' - ]; - expected = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int32', - 'generic', - 'complex64', - 'uint32', - 'float64' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'accumulation' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'int8' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], dt3[ i ] ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); From 814d6be31096d8e8a73d727c9c60da70f76103ed Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 14 May 2026 03:27:08 +0000 Subject: [PATCH 19/36] Transform error messages --- lib/main.js | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/main.js b/lib/main.js index 3530917..c43ed91 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); var defaults = require( '@stdlib/ndarray-defaults' ); var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // diff --git a/package.json b/package.json index 3782dc6..86fafb9 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.4.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, From 96c093da6927eb2ae892ebc2eb763da1f3ccf00d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 14 May 2026 03:30:27 +0000 Subject: [PATCH 20/36] Remove files --- index.d.ts | 43 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4890 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 5e11c50..0000000 --- a/index.d.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param idtype1 - input ndarray data type -* @param idtype2 - additional input ndarray data type -* @param odtype - output ndarray data type -* @param policy - input ndarray casting data type policy -* @returns input ndarray casting data type -* -* @example -* var dt = outputDataType( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ -declare function outputDataType( idtype1: DataType, idtype2: DataType, odtype: DataType, policy: InputCastingPolicy | DataType ): DataType; - - -// EXPORTS // - -export = outputDataType; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d08ed3c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 8314587..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1acb2b4..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From d353b43e9be08870d00fd32045f8ba6e43f21fe0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 14 May 2026 03:30:45 +0000 Subject: [PATCH 21/36] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .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 | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 59 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 160 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 33 - docs/types/test.ts | 84 - examples/index.js | 60 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 40 - lib/main.js | 102 - package.json | 65 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 328 -- 44 files changed, 4869 insertions(+), 4465 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 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 (94%) 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 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +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 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# 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 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +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 - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index e705223..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-05-14T03:24:42.116Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a9bf37b..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/base/binary-input-casting-dtype) 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 12cd77e..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/base/binary-input-casting-dtype) 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 a9decd9..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: '19 7 * * 4' - - # 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 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +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 notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # 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 + + ```
@@ -199,7 +190,7 @@ logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ] ## 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]. @@ -262,9 +253,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-binary-input-casting-dtype/main/LICENSE -[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes +[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes/tree/esm -[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies +[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies/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 ee0b109..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var dtypes = require( '@stdlib/ndarray-dtypes' ); -var pkg = require( './../package.json' ).name; -var resolve = require( './../lib' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'numeric' ); - - -// MAIN // - -bench( pkg+':policy=none', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'none' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=promoted', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'promoted' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=accumulation', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'accumulation' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=output', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'output' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':policy=', function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'int32' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1799fb0..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/base/binary-input-casting-dtype" -%% click B href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/binary-input-casting-dtype -[production-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/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 c73d928..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import outputDataType from '../docs/types/index'; -export = outputDataType; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f057822..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var g=v(function(F,o){ -var T=require('@stdlib/ndarray-base-assert-is-floating-point-data-type/dist'),E=require('@stdlib/ndarray-base-assert-is-signed-integer-data-type/dist'),_=require('@stdlib/ndarray-base-assert-is-unsigned-integer-data-type/dist'),f=require('@stdlib/ndarray-base-assert-is-data-type/dist'),u=require('@stdlib/ndarray-base-promote-dtypes/dist'),i=require('@stdlib/ndarray-defaults/dist'),D=require('@stdlib/array-base-join/dist'),s=require('@stdlib/error-tools-fmtprodmsg/dist'),m=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),q=i.get("dtypes.real_floating_point");function I(r,e,a,t){var n;if(t==="none")return r;if(t==="output")return a;if(t==="promoted"){if(n=u([r,e,a]),n===null)throw new Error(s('2VTJR',D([r,e],", "),a));return n}if(t==="accumulation")return T(r)||r==="generic"?r:_(r)?u([r,p]):E(r)?u([r,m]):q;if(f(t))return t;throw new TypeError(s('2VTJS',t))}o.exports=I -});var l=g();module.exports=l; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 256ac28..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nvar isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' );\nvar isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' );\nvar isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' );\nvar isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );\nvar promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' );\nvar defaults = require( '@stdlib/ndarray-defaults' );\nvar join = require( '@stdlib/array-base-join' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = resolve;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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* Resolve the casting data type for an input ndarray provided to a binary function.\n*\n* @module @stdlib/ndarray-base-binary-input-casting-dtype\n*\n* @example\n* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' );\n*\n* var dt = resolve( 'float64', 'float64', 'float64', 'none' );\n* // returns \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,cAwBA,IAAIC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA4B,QAAS,2DAA4D,EACjGC,EAAa,QAAS,0CAA2C,EACjEC,EAAmB,QAAS,qCAAsC,EAClEC,EAAW,QAAS,0BAA2B,EAC/CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAS,QAAS,uBAAwB,EAK1CC,EAA+BH,EAAS,IAAK,uBAAwB,EACrEI,EAAiCJ,EAAS,IAAK,yBAA0B,EACzEK,EAAoCL,EAAS,IAAK,4BAA6B,EAoBnF,SAASM,EAASC,EAASC,EAASC,EAAQC,EAAS,CACpD,IAAIC,EACJ,GAAKD,IAAW,OAEf,OAAOH,EAER,GAAKG,IAAW,SACf,OAAOD,EAER,GAAKC,IAAW,WAAa,CAE5B,GADAC,EAAKZ,EAAkB,CAAEQ,EAASC,EAASC,CAAO,CAAE,EAC/CE,IAAO,KACX,MAAM,IAAI,MAAOT,EAAQ,sHAAuHD,EAAM,CAAEM,EAASC,CAAQ,EAAG,IAAK,EAAGC,CAAO,CAAE,EAE9L,OAAOE,CACR,CACA,GAAKD,IAAW,eAIf,OAAKf,EAAyBY,CAAQ,GAAKA,IAAY,UAC/CA,EAGHV,EAA2BU,CAAQ,EAChCR,EAAkB,CAAEQ,EAASH,CAA+B,CAAE,EAEjER,EAAyBW,CAAQ,EAC9BR,EAAkB,CAAEQ,EAASJ,CAA6B,CAAE,EAG7DE,EAGR,GAAKP,EAAYY,CAAO,EACvB,OAAOA,EAER,MAAM,IAAI,UAAWR,EAAQ,qFAAsFQ,CAAO,CAAE,CAC7H,CAKAhB,EAAO,QAAUY,ICnEjB,IAAIM,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isFloatingPointDataType", "isSignedIntegerDataType", "isUnsignedIntegerDataType", "isDataType", "promoteDataTypes", "defaults", "join", "format", "DEFAULT_SIGNED_INTEGER_DTYPE", "DEFAULT_UNSIGNED_INTEGER_DTYPE", "DEFAULT_REAL_FLOATING_POINT_DTYPE", "resolve", "idtype1", "idtype2", "odtype", "policy", "dt", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8eb71cc..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,33 +0,0 @@ - -{{alias}}( idtype1, idtype2, odtype, policy ) - Resolves the casting data type for an input ndarray provided to a binary - function. - - Parameters - ---------- - idtype1: string - Input ndarray data type. - - idtype2: string - Additional input ndarray data type. - - odtype: string - Output ndarray data type. - - policy: string - Input ndarray casting data type policy. If `policy` is a data type, the - function returns the `policy` value. - - Returns - ------- - out: string - Input ndarray casting data type. - - Examples - -------- - > var out = {{alias}}( 'float64', 'float64', 'float64', 'none' ) - 'float64' - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 29c87a8..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 inputCastingDataType = require( './index' ); - - -// TESTS // - -// The function returns a data type... -{ - inputCastingDataType( 'float64', 'float64', 'float64', 'none' ); // $ExpectType DataType -} - -// The compiler throws an error if not provided a first argument which is a data type... -{ - inputCastingDataType( '10', 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( true, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( false, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( null, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( undefined, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( [], 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( {}, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( ( x: number ): number => x, 'float64', 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a second argument which is a data type... -{ - inputCastingDataType( 'float64', '10', 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', true, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', false, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', null, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', undefined, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', [], 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', {}, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', ( x: number ): number => x, 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a third argument which is a data type... -{ - inputCastingDataType( 'float64', 'float64', '10', 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', true, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', false, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', null, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', undefined, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', [], 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', {}, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', ( x: number ): number => x, 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a fourth argument which is either a data type or data type policy... -{ - inputCastingDataType( 'float64', 'float64', 'float64', '10' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', true ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', false ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', null ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', undefined ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', [] ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', {} ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - inputCastingDataType(); // $ExpectError - inputCastingDataType( 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', 'none', 'foo' ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 8c7ef88..0000000 --- a/examples/index.js +++ /dev/null @@ -1,60 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var unzip = require( '@stdlib/utils-unzip' ); -var nCartesianProduct = require( '@stdlib/array-base-n-cartesian-product' ); -var logEachMap = require( '@stdlib/console-log-each-map' ); -var inputCastingDataType = require( './../lib' ); - -var idt1 = [ - 'float32', - 'float64' -]; - -var idt2 = [ - 'int8', - 'uint8', - 'uint16', - 'uint32' -]; - -var odt = [ - 'float32', - 'float64', - 'complex64', - 'complex128' -]; - -// Define a list of casting policies: -var policies = [ - 'promoted', - 'accumulation', - 'output' -]; - -// Generate dtype-policy argument groups: -var args = nCartesianProduct( idt1, idt2, odt, policies ); - -// Unzip the argument arrays: -args = unzip( args ); - -// Resolve casting data types: -logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ], args[ 1 ], args[ 2 ], args[ 3 ], naryFunction( inputCastingDataType, 4 ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 94% rename from docs/types/index.d.ts rename to index.d.ts index 80fe519..5e11c50 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d08ed3c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8314587 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 69b2434..0000000 --- a/lib/index.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Resolve the casting data type for an input ndarray provided to a binary function. -* -* @module @stdlib/ndarray-base-binary-input-casting-dtype -* -* @example -* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' ); -* -* var dt = resolve( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ - -// 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 c43ed91..0000000 --- a/lib/main.js +++ /dev/null @@ -1,102 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable id-length, max-len */ - -'use strict'; - -// MODULES // - -var isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' ); -var isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' ); -var isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' ); -var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); -var defaults = require( '@stdlib/ndarray-defaults' ); -var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' ); -var DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' ); -var DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' ); - - -// MAIN // - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param {string} idtype1 - input ndarray data type -* @param {string} idtype2 - additional input ndarray data type -* @param {string} odtype - output ndarray data type -* @param {string} policy - input ndarray data type casting policy -* @throws {TypeError} fourth argument must be a recognized data type policy -* @throws {Error} unexpected error -* @returns {string} data type -* -* @example -* var dt = resolve( 'float32', 'float32', 'float64', 'none' ); -* // returns -*/ -function resolve( idtype1, idtype2, odtype, policy ) { - var dt; - if ( policy === 'none' ) { - // When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is... - return idtype1; - } - if ( policy === 'output' ) { - return odtype; - } - if ( policy === 'promoted' ) { - dt = promoteDataTypes( [ idtype1, idtype2, odtype ] ); - if ( dt === null ) { - throw new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) ); - } - return dt; - } - if ( policy === 'accumulation' ) { - // When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays... - - // If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type... - if ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited - return idtype1; - } - // Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements... - if ( isUnsignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] ); - } - if ( isSignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] ); - } - // For all other input data types, accumulate in the default real-valued floating-point data type... - return DEFAULT_REAL_FLOATING_POINT_DTYPE; - } - // Check for an explicit data type... - if ( isDataType( policy ) ) { - return policy; - } - throw new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) ); -} - - -// EXPORTS // - -module.exports = resolve; diff --git a/package.json b/package.json index 86fafb9..f5a10c6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Resolve the casting data type for an input ndarray provided to a binary function.", "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/array-base-join": "^0.1.2", - "@stdlib/ndarray-base-assert-is-data-type": "^0.2.3", - "@stdlib/ndarray-base-assert-is-floating-point-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-signed-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", - "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-n-cartesian-product": "^0.2.3", - "@stdlib/console-log-each-map": "^0.1.1", - "@stdlib/ndarray-dtypes": "^0.4.1", - "@stdlib/utils-nary-function": "^0.2.4", - "@stdlib/utils-unzip": "^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.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1acb2b4 --- /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 6a8c99f..0000000 --- a/test/test.js +++ /dev/null @@ -1,328 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 resolve = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof resolve, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an unsupported/unrecognized casting policy', function test( t ) { - var values; - var i; - - values = [ - 'float', - 'cmplx', - 'beep', - 'boop', - '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() { - resolve( 'float64', 'float64', 'float64', value ); - }; - } -}); - -tape( 'the function throws an error if provided data types which do not promote when the casting policy is "promoted"', function test( t ) { - var dt1; - var dt2; - var dt3; - var i; - - dt1 = [ - 'binary', - 'bool', - 'int32', - 'uint32', - 'binary' - ]; - dt2 = [ - 'generic', - 'float32', - 'bool', - 'int8', - 'int32' - ]; - dt3 = [ - 'float32', - 'int16', - 'float64', - 'bool', - 'float64' - ]; - for ( i = 0; i < dt1.length; i++ ) { - t.throws( badValue( dt1[ i ], dt2[ i ], dt3[ i ] ), Error, 'throws an error when provided '+dt1[ i ]+' and '+dt2[ i ]+' and '+dt3[ i ] ); - } - t.end(); - - function badValue( v1, v2, v3 ) { - return function badValue() { - resolve( v1, v2, v3, 'promoted' ); - }; - } -}); - -tape( 'the function resolves a casting data type (policy=none)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64' - ]; - - expected = dt1; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'none' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=output)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'complex128', - 'float64', - 'uint32', - 'int16', - 'generic' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'output' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=promoted)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'complex64' - ]; - dt2 = [ - 'float64', - 'int16', - 'int32', - 'float64', - 'float64' - ]; - dt3 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'float32' - ]; - expected = [ - 'float64', - 'int16', - 'int32', - 'complex128', - 'complex128' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'promoted' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=accumulation)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int16', - 'generic', - 'complex64', - 'uint16', - 'bool' - ]; - dt2 = [ - 'float16', - 'float64', - 'uint8c', - 'float64', - 'int32', - 'float32', - 'float32', - 'uint8', - 'bool' - ]; - dt3 = [ - 'int8', - 'float64', - 'float16', - 'int16', - 'int32', - 'int32', - 'int16', - 'uint32', - 'bool' - ]; - expected = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int32', - 'generic', - 'complex64', - 'uint32', - 'float64' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'accumulation' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'int8' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], dt3[ i ] ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); From 3b6c79b6fd3e8db1b50deda3f27a9a729c201348 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 20 May 2026 07:50:09 +0000 Subject: [PATCH 22/36] Transform error messages --- lib/main.js | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/main.js b/lib/main.js index 3530917..c43ed91 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); var defaults = require( '@stdlib/ndarray-defaults' ); var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // diff --git a/package.json b/package.json index 3782dc6..86fafb9 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.4.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, From f2dfbbe67b28aa882ff5e264bdf27dcca6481f9c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 20 May 2026 07:50:32 +0000 Subject: [PATCH 23/36] Remove files --- index.d.ts | 43 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4890 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 5e11c50..0000000 --- a/index.d.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param idtype1 - input ndarray data type -* @param idtype2 - additional input ndarray data type -* @param odtype - output ndarray data type -* @param policy - input ndarray casting data type policy -* @returns input ndarray casting data type -* -* @example -* var dt = outputDataType( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ -declare function outputDataType( idtype1: DataType, idtype2: DataType, odtype: DataType, policy: InputCastingPolicy | DataType ): DataType; - - -// EXPORTS // - -export = outputDataType; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d08ed3c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 8314587..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1acb2b4..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From c2246e137bcc27b95898aac7d8950e0d4c54b656 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 20 May 2026 07:50:53 +0000 Subject: [PATCH 24/36] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .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 | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 93 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 161 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 33 - docs/types/test.ts | 84 - examples/index.js | 60 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 40 - lib/main.js | 102 - package.json | 65 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 328 -- 43 files changed, 4869 insertions(+), 4512 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 .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 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 (94%) 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 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +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 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# 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 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +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 - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a9bf37b..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/base/binary-input-casting-dtype) 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 12cd77e..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/base/binary-input-casting-dtype) 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 a9decd9..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: '19 7 * * 4' - - # 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 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +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 notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # 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 + + ```
@@ -199,7 +190,7 @@ logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ] ## 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]. @@ -262,9 +253,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-binary-input-casting-dtype/main/LICENSE -[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes +[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes/tree/esm -[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies +[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies/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 a9221f1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,161 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var dtypes = require( '@stdlib/ndarray-dtypes' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var resolve = require( './../lib' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'numeric' ); - - -// MAIN // - -bench( format( '%s:policy=none', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'none' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=promoted', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'promoted' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=accumulation', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'accumulation' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=output', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'output' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'int32' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1799fb0..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/base/binary-input-casting-dtype" -%% click B href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/binary-input-casting-dtype -[production-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/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 c73d928..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import outputDataType from '../docs/types/index'; -export = outputDataType; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f057822..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var g=v(function(F,o){ -var T=require('@stdlib/ndarray-base-assert-is-floating-point-data-type/dist'),E=require('@stdlib/ndarray-base-assert-is-signed-integer-data-type/dist'),_=require('@stdlib/ndarray-base-assert-is-unsigned-integer-data-type/dist'),f=require('@stdlib/ndarray-base-assert-is-data-type/dist'),u=require('@stdlib/ndarray-base-promote-dtypes/dist'),i=require('@stdlib/ndarray-defaults/dist'),D=require('@stdlib/array-base-join/dist'),s=require('@stdlib/error-tools-fmtprodmsg/dist'),m=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),q=i.get("dtypes.real_floating_point");function I(r,e,a,t){var n;if(t==="none")return r;if(t==="output")return a;if(t==="promoted"){if(n=u([r,e,a]),n===null)throw new Error(s('2VTJR',D([r,e],", "),a));return n}if(t==="accumulation")return T(r)||r==="generic"?r:_(r)?u([r,p]):E(r)?u([r,m]):q;if(f(t))return t;throw new TypeError(s('2VTJS',t))}o.exports=I -});var l=g();module.exports=l; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 256ac28..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nvar isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' );\nvar isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' );\nvar isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' );\nvar isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );\nvar promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' );\nvar defaults = require( '@stdlib/ndarray-defaults' );\nvar join = require( '@stdlib/array-base-join' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = resolve;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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* Resolve the casting data type for an input ndarray provided to a binary function.\n*\n* @module @stdlib/ndarray-base-binary-input-casting-dtype\n*\n* @example\n* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' );\n*\n* var dt = resolve( 'float64', 'float64', 'float64', 'none' );\n* // returns \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,cAwBA,IAAIC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA4B,QAAS,2DAA4D,EACjGC,EAAa,QAAS,0CAA2C,EACjEC,EAAmB,QAAS,qCAAsC,EAClEC,EAAW,QAAS,0BAA2B,EAC/CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAS,QAAS,uBAAwB,EAK1CC,EAA+BH,EAAS,IAAK,uBAAwB,EACrEI,EAAiCJ,EAAS,IAAK,yBAA0B,EACzEK,EAAoCL,EAAS,IAAK,4BAA6B,EAoBnF,SAASM,EAASC,EAASC,EAASC,EAAQC,EAAS,CACpD,IAAIC,EACJ,GAAKD,IAAW,OAEf,OAAOH,EAER,GAAKG,IAAW,SACf,OAAOD,EAER,GAAKC,IAAW,WAAa,CAE5B,GADAC,EAAKZ,EAAkB,CAAEQ,EAASC,EAASC,CAAO,CAAE,EAC/CE,IAAO,KACX,MAAM,IAAI,MAAOT,EAAQ,sHAAuHD,EAAM,CAAEM,EAASC,CAAQ,EAAG,IAAK,EAAGC,CAAO,CAAE,EAE9L,OAAOE,CACR,CACA,GAAKD,IAAW,eAIf,OAAKf,EAAyBY,CAAQ,GAAKA,IAAY,UAC/CA,EAGHV,EAA2BU,CAAQ,EAChCR,EAAkB,CAAEQ,EAASH,CAA+B,CAAE,EAEjER,EAAyBW,CAAQ,EAC9BR,EAAkB,CAAEQ,EAASJ,CAA6B,CAAE,EAG7DE,EAGR,GAAKP,EAAYY,CAAO,EACvB,OAAOA,EAER,MAAM,IAAI,UAAWR,EAAQ,qFAAsFQ,CAAO,CAAE,CAC7H,CAKAhB,EAAO,QAAUY,ICnEjB,IAAIM,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isFloatingPointDataType", "isSignedIntegerDataType", "isUnsignedIntegerDataType", "isDataType", "promoteDataTypes", "defaults", "join", "format", "DEFAULT_SIGNED_INTEGER_DTYPE", "DEFAULT_UNSIGNED_INTEGER_DTYPE", "DEFAULT_REAL_FLOATING_POINT_DTYPE", "resolve", "idtype1", "idtype2", "odtype", "policy", "dt", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8eb71cc..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,33 +0,0 @@ - -{{alias}}( idtype1, idtype2, odtype, policy ) - Resolves the casting data type for an input ndarray provided to a binary - function. - - Parameters - ---------- - idtype1: string - Input ndarray data type. - - idtype2: string - Additional input ndarray data type. - - odtype: string - Output ndarray data type. - - policy: string - Input ndarray casting data type policy. If `policy` is a data type, the - function returns the `policy` value. - - Returns - ------- - out: string - Input ndarray casting data type. - - Examples - -------- - > var out = {{alias}}( 'float64', 'float64', 'float64', 'none' ) - 'float64' - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 29c87a8..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 inputCastingDataType = require( './index' ); - - -// TESTS // - -// The function returns a data type... -{ - inputCastingDataType( 'float64', 'float64', 'float64', 'none' ); // $ExpectType DataType -} - -// The compiler throws an error if not provided a first argument which is a data type... -{ - inputCastingDataType( '10', 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( true, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( false, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( null, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( undefined, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( [], 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( {}, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( ( x: number ): number => x, 'float64', 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a second argument which is a data type... -{ - inputCastingDataType( 'float64', '10', 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', true, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', false, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', null, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', undefined, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', [], 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', {}, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', ( x: number ): number => x, 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a third argument which is a data type... -{ - inputCastingDataType( 'float64', 'float64', '10', 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', true, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', false, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', null, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', undefined, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', [], 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', {}, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', ( x: number ): number => x, 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a fourth argument which is either a data type or data type policy... -{ - inputCastingDataType( 'float64', 'float64', 'float64', '10' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', true ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', false ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', null ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', undefined ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', [] ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', {} ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - inputCastingDataType(); // $ExpectError - inputCastingDataType( 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', 'none', 'foo' ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 8c7ef88..0000000 --- a/examples/index.js +++ /dev/null @@ -1,60 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var unzip = require( '@stdlib/utils-unzip' ); -var nCartesianProduct = require( '@stdlib/array-base-n-cartesian-product' ); -var logEachMap = require( '@stdlib/console-log-each-map' ); -var inputCastingDataType = require( './../lib' ); - -var idt1 = [ - 'float32', - 'float64' -]; - -var idt2 = [ - 'int8', - 'uint8', - 'uint16', - 'uint32' -]; - -var odt = [ - 'float32', - 'float64', - 'complex64', - 'complex128' -]; - -// Define a list of casting policies: -var policies = [ - 'promoted', - 'accumulation', - 'output' -]; - -// Generate dtype-policy argument groups: -var args = nCartesianProduct( idt1, idt2, odt, policies ); - -// Unzip the argument arrays: -args = unzip( args ); - -// Resolve casting data types: -logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ], args[ 1 ], args[ 2 ], args[ 3 ], naryFunction( inputCastingDataType, 4 ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 94% rename from docs/types/index.d.ts rename to index.d.ts index 80fe519..5e11c50 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d08ed3c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8314587 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 69b2434..0000000 --- a/lib/index.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Resolve the casting data type for an input ndarray provided to a binary function. -* -* @module @stdlib/ndarray-base-binary-input-casting-dtype -* -* @example -* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' ); -* -* var dt = resolve( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ - -// 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 c43ed91..0000000 --- a/lib/main.js +++ /dev/null @@ -1,102 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable id-length, max-len */ - -'use strict'; - -// MODULES // - -var isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' ); -var isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' ); -var isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' ); -var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); -var defaults = require( '@stdlib/ndarray-defaults' ); -var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' ); -var DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' ); -var DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' ); - - -// MAIN // - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param {string} idtype1 - input ndarray data type -* @param {string} idtype2 - additional input ndarray data type -* @param {string} odtype - output ndarray data type -* @param {string} policy - input ndarray data type casting policy -* @throws {TypeError} fourth argument must be a recognized data type policy -* @throws {Error} unexpected error -* @returns {string} data type -* -* @example -* var dt = resolve( 'float32', 'float32', 'float64', 'none' ); -* // returns -*/ -function resolve( idtype1, idtype2, odtype, policy ) { - var dt; - if ( policy === 'none' ) { - // When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is... - return idtype1; - } - if ( policy === 'output' ) { - return odtype; - } - if ( policy === 'promoted' ) { - dt = promoteDataTypes( [ idtype1, idtype2, odtype ] ); - if ( dt === null ) { - throw new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) ); - } - return dt; - } - if ( policy === 'accumulation' ) { - // When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays... - - // If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type... - if ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited - return idtype1; - } - // Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements... - if ( isUnsignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] ); - } - if ( isSignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] ); - } - // For all other input data types, accumulate in the default real-valued floating-point data type... - return DEFAULT_REAL_FLOATING_POINT_DTYPE; - } - // Check for an explicit data type... - if ( isDataType( policy ) ) { - return policy; - } - throw new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) ); -} - - -// EXPORTS // - -module.exports = resolve; diff --git a/package.json b/package.json index 86fafb9..f5a10c6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Resolve the casting data type for an input ndarray provided to a binary function.", "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/array-base-join": "^0.1.2", - "@stdlib/ndarray-base-assert-is-data-type": "^0.2.3", - "@stdlib/ndarray-base-assert-is-floating-point-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-signed-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", - "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-n-cartesian-product": "^0.2.3", - "@stdlib/console-log-each-map": "^0.1.1", - "@stdlib/ndarray-dtypes": "^0.4.1", - "@stdlib/utils-nary-function": "^0.2.4", - "@stdlib/utils-unzip": "^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.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1acb2b4 --- /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 6a8c99f..0000000 --- a/test/test.js +++ /dev/null @@ -1,328 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 resolve = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof resolve, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an unsupported/unrecognized casting policy', function test( t ) { - var values; - var i; - - values = [ - 'float', - 'cmplx', - 'beep', - 'boop', - '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() { - resolve( 'float64', 'float64', 'float64', value ); - }; - } -}); - -tape( 'the function throws an error if provided data types which do not promote when the casting policy is "promoted"', function test( t ) { - var dt1; - var dt2; - var dt3; - var i; - - dt1 = [ - 'binary', - 'bool', - 'int32', - 'uint32', - 'binary' - ]; - dt2 = [ - 'generic', - 'float32', - 'bool', - 'int8', - 'int32' - ]; - dt3 = [ - 'float32', - 'int16', - 'float64', - 'bool', - 'float64' - ]; - for ( i = 0; i < dt1.length; i++ ) { - t.throws( badValue( dt1[ i ], dt2[ i ], dt3[ i ] ), Error, 'throws an error when provided '+dt1[ i ]+' and '+dt2[ i ]+' and '+dt3[ i ] ); - } - t.end(); - - function badValue( v1, v2, v3 ) { - return function badValue() { - resolve( v1, v2, v3, 'promoted' ); - }; - } -}); - -tape( 'the function resolves a casting data type (policy=none)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64' - ]; - - expected = dt1; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'none' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=output)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'complex128', - 'float64', - 'uint32', - 'int16', - 'generic' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'output' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=promoted)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'complex64' - ]; - dt2 = [ - 'float64', - 'int16', - 'int32', - 'float64', - 'float64' - ]; - dt3 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'float32' - ]; - expected = [ - 'float64', - 'int16', - 'int32', - 'complex128', - 'complex128' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'promoted' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=accumulation)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int16', - 'generic', - 'complex64', - 'uint16', - 'bool' - ]; - dt2 = [ - 'float16', - 'float64', - 'uint8c', - 'float64', - 'int32', - 'float32', - 'float32', - 'uint8', - 'bool' - ]; - dt3 = [ - 'int8', - 'float64', - 'float16', - 'int16', - 'int32', - 'int32', - 'int16', - 'uint32', - 'bool' - ]; - expected = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int32', - 'generic', - 'complex64', - 'uint32', - 'float64' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'accumulation' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'int8' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], dt3[ i ] ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); From f9a71033e1511687775bf36a6dcf3c3811e1a36b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jun 2026 06:25:20 +0000 Subject: [PATCH 25/36] Transform error messages --- lib/main.js | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/main.js b/lib/main.js index 3530917..c43ed91 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); var defaults = require( '@stdlib/ndarray-defaults' ); var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // diff --git a/package.json b/package.json index cd170c8..be29b38 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.5.1", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, From 48d8e983b521770d48ff09e702f2dadbfa864710 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jun 2026 06:26:25 +0000 Subject: [PATCH 26/36] Remove files --- index.d.ts | 43 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4890 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 5e11c50..0000000 --- a/index.d.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param idtype1 - input ndarray data type -* @param idtype2 - additional input ndarray data type -* @param odtype - output ndarray data type -* @param policy - input ndarray casting data type policy -* @returns input ndarray casting data type -* -* @example -* var dt = outputDataType( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ -declare function outputDataType( idtype1: DataType, idtype2: DataType, odtype: DataType, policy: InputCastingPolicy | DataType ): DataType; - - -// EXPORTS // - -export = outputDataType; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d08ed3c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 8314587..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1acb2b4..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From b35414ffdb107d7dd33181cc902d26fb519cc5cd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jun 2026 06:27:00 +0000 Subject: [PATCH 27/36] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .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 | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 106 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 161 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 33 - docs/types/test.ts | 84 - examples/index.js | 60 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 40 - lib/main.js | 102 - package.json | 65 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 328 -- 43 files changed, 4869 insertions(+), 4525 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 .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 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 (94%) 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 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +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 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# 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 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +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 - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a9bf37b..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/base/binary-input-casting-dtype) 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 12cd77e..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/base/binary-input-casting-dtype) 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 a9decd9..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: '19 7 * * 4' - - # 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 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +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 notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # 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 + + ```
@@ -199,7 +190,7 @@ logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ] ## 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]. @@ -262,9 +253,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-binary-input-casting-dtype/main/LICENSE -[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes +[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes/tree/esm -[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies +[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies/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 a9221f1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,161 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var dtypes = require( '@stdlib/ndarray-dtypes' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var resolve = require( './../lib' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'numeric' ); - - -// MAIN // - -bench( format( '%s:policy=none', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'none' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=promoted', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'promoted' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=accumulation', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'accumulation' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=output', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'output' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'int32' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1799fb0..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/base/binary-input-casting-dtype" -%% click B href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/binary-input-casting-dtype -[production-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/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 29916aa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import inputCastingDataType from '../docs/types/index'; -export = inputCastingDataType; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f057822..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var g=v(function(F,o){ -var T=require('@stdlib/ndarray-base-assert-is-floating-point-data-type/dist'),E=require('@stdlib/ndarray-base-assert-is-signed-integer-data-type/dist'),_=require('@stdlib/ndarray-base-assert-is-unsigned-integer-data-type/dist'),f=require('@stdlib/ndarray-base-assert-is-data-type/dist'),u=require('@stdlib/ndarray-base-promote-dtypes/dist'),i=require('@stdlib/ndarray-defaults/dist'),D=require('@stdlib/array-base-join/dist'),s=require('@stdlib/error-tools-fmtprodmsg/dist'),m=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),q=i.get("dtypes.real_floating_point");function I(r,e,a,t){var n;if(t==="none")return r;if(t==="output")return a;if(t==="promoted"){if(n=u([r,e,a]),n===null)throw new Error(s('2VTJR',D([r,e],", "),a));return n}if(t==="accumulation")return T(r)||r==="generic"?r:_(r)?u([r,p]):E(r)?u([r,m]):q;if(f(t))return t;throw new TypeError(s('2VTJS',t))}o.exports=I -});var l=g();module.exports=l; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 256ac28..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nvar isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' );\nvar isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' );\nvar isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' );\nvar isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );\nvar promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' );\nvar defaults = require( '@stdlib/ndarray-defaults' );\nvar join = require( '@stdlib/array-base-join' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = resolve;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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* Resolve the casting data type for an input ndarray provided to a binary function.\n*\n* @module @stdlib/ndarray-base-binary-input-casting-dtype\n*\n* @example\n* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' );\n*\n* var dt = resolve( 'float64', 'float64', 'float64', 'none' );\n* // returns \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,cAwBA,IAAIC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA4B,QAAS,2DAA4D,EACjGC,EAAa,QAAS,0CAA2C,EACjEC,EAAmB,QAAS,qCAAsC,EAClEC,EAAW,QAAS,0BAA2B,EAC/CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAS,QAAS,uBAAwB,EAK1CC,EAA+BH,EAAS,IAAK,uBAAwB,EACrEI,EAAiCJ,EAAS,IAAK,yBAA0B,EACzEK,EAAoCL,EAAS,IAAK,4BAA6B,EAoBnF,SAASM,EAASC,EAASC,EAASC,EAAQC,EAAS,CACpD,IAAIC,EACJ,GAAKD,IAAW,OAEf,OAAOH,EAER,GAAKG,IAAW,SACf,OAAOD,EAER,GAAKC,IAAW,WAAa,CAE5B,GADAC,EAAKZ,EAAkB,CAAEQ,EAASC,EAASC,CAAO,CAAE,EAC/CE,IAAO,KACX,MAAM,IAAI,MAAOT,EAAQ,sHAAuHD,EAAM,CAAEM,EAASC,CAAQ,EAAG,IAAK,EAAGC,CAAO,CAAE,EAE9L,OAAOE,CACR,CACA,GAAKD,IAAW,eAIf,OAAKf,EAAyBY,CAAQ,GAAKA,IAAY,UAC/CA,EAGHV,EAA2BU,CAAQ,EAChCR,EAAkB,CAAEQ,EAASH,CAA+B,CAAE,EAEjER,EAAyBW,CAAQ,EAC9BR,EAAkB,CAAEQ,EAASJ,CAA6B,CAAE,EAG7DE,EAGR,GAAKP,EAAYY,CAAO,EACvB,OAAOA,EAER,MAAM,IAAI,UAAWR,EAAQ,qFAAsFQ,CAAO,CAAE,CAC7H,CAKAhB,EAAO,QAAUY,ICnEjB,IAAIM,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isFloatingPointDataType", "isSignedIntegerDataType", "isUnsignedIntegerDataType", "isDataType", "promoteDataTypes", "defaults", "join", "format", "DEFAULT_SIGNED_INTEGER_DTYPE", "DEFAULT_UNSIGNED_INTEGER_DTYPE", "DEFAULT_REAL_FLOATING_POINT_DTYPE", "resolve", "idtype1", "idtype2", "odtype", "policy", "dt", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8eb71cc..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,33 +0,0 @@ - -{{alias}}( idtype1, idtype2, odtype, policy ) - Resolves the casting data type for an input ndarray provided to a binary - function. - - Parameters - ---------- - idtype1: string - Input ndarray data type. - - idtype2: string - Additional input ndarray data type. - - odtype: string - Output ndarray data type. - - policy: string - Input ndarray casting data type policy. If `policy` is a data type, the - function returns the `policy` value. - - Returns - ------- - out: string - Input ndarray casting data type. - - Examples - -------- - > var out = {{alias}}( 'float64', 'float64', 'float64', 'none' ) - 'float64' - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 29c87a8..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 inputCastingDataType = require( './index' ); - - -// TESTS // - -// The function returns a data type... -{ - inputCastingDataType( 'float64', 'float64', 'float64', 'none' ); // $ExpectType DataType -} - -// The compiler throws an error if not provided a first argument which is a data type... -{ - inputCastingDataType( '10', 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( true, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( false, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( null, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( undefined, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( [], 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( {}, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( ( x: number ): number => x, 'float64', 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a second argument which is a data type... -{ - inputCastingDataType( 'float64', '10', 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', true, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', false, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', null, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', undefined, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', [], 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', {}, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', ( x: number ): number => x, 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a third argument which is a data type... -{ - inputCastingDataType( 'float64', 'float64', '10', 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', true, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', false, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', null, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', undefined, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', [], 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', {}, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', ( x: number ): number => x, 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a fourth argument which is either a data type or data type policy... -{ - inputCastingDataType( 'float64', 'float64', 'float64', '10' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', true ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', false ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', null ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', undefined ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', [] ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', {} ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - inputCastingDataType(); // $ExpectError - inputCastingDataType( 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', 'none', 'foo' ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 8c7ef88..0000000 --- a/examples/index.js +++ /dev/null @@ -1,60 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var unzip = require( '@stdlib/utils-unzip' ); -var nCartesianProduct = require( '@stdlib/array-base-n-cartesian-product' ); -var logEachMap = require( '@stdlib/console-log-each-map' ); -var inputCastingDataType = require( './../lib' ); - -var idt1 = [ - 'float32', - 'float64' -]; - -var idt2 = [ - 'int8', - 'uint8', - 'uint16', - 'uint32' -]; - -var odt = [ - 'float32', - 'float64', - 'complex64', - 'complex128' -]; - -// Define a list of casting policies: -var policies = [ - 'promoted', - 'accumulation', - 'output' -]; - -// Generate dtype-policy argument groups: -var args = nCartesianProduct( idt1, idt2, odt, policies ); - -// Unzip the argument arrays: -args = unzip( args ); - -// Resolve casting data types: -logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ], args[ 1 ], args[ 2 ], args[ 3 ], naryFunction( inputCastingDataType, 4 ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 94% rename from docs/types/index.d.ts rename to index.d.ts index 42ccea6..49c9fa5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d08ed3c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8314587 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 69b2434..0000000 --- a/lib/index.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Resolve the casting data type for an input ndarray provided to a binary function. -* -* @module @stdlib/ndarray-base-binary-input-casting-dtype -* -* @example -* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' ); -* -* var dt = resolve( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ - -// 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 c43ed91..0000000 --- a/lib/main.js +++ /dev/null @@ -1,102 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable id-length, max-len */ - -'use strict'; - -// MODULES // - -var isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' ); -var isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' ); -var isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' ); -var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); -var defaults = require( '@stdlib/ndarray-defaults' ); -var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' ); -var DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' ); -var DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' ); - - -// MAIN // - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param {string} idtype1 - input ndarray data type -* @param {string} idtype2 - additional input ndarray data type -* @param {string} odtype - output ndarray data type -* @param {string} policy - input ndarray data type casting policy -* @throws {TypeError} fourth argument must be a recognized data type policy -* @throws {Error} unexpected error -* @returns {string} data type -* -* @example -* var dt = resolve( 'float32', 'float32', 'float64', 'none' ); -* // returns -*/ -function resolve( idtype1, idtype2, odtype, policy ) { - var dt; - if ( policy === 'none' ) { - // When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is... - return idtype1; - } - if ( policy === 'output' ) { - return odtype; - } - if ( policy === 'promoted' ) { - dt = promoteDataTypes( [ idtype1, idtype2, odtype ] ); - if ( dt === null ) { - throw new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) ); - } - return dt; - } - if ( policy === 'accumulation' ) { - // When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays... - - // If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type... - if ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited - return idtype1; - } - // Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements... - if ( isUnsignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] ); - } - if ( isSignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] ); - } - // For all other input data types, accumulate in the default real-valued floating-point data type... - return DEFAULT_REAL_FLOATING_POINT_DTYPE; - } - // Check for an explicit data type... - if ( isDataType( policy ) ) { - return policy; - } - throw new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) ); -} - - -// EXPORTS // - -module.exports = resolve; diff --git a/package.json b/package.json index be29b38..f5a10c6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Resolve the casting data type for an input ndarray provided to a binary function.", "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/array-base-join": "^0.1.2", - "@stdlib/ndarray-base-assert-is-data-type": "^0.2.3", - "@stdlib/ndarray-base-assert-is-floating-point-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-signed-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", - "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.5.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-n-cartesian-product": "^0.2.3", - "@stdlib/console-log-each-map": "^0.1.1", - "@stdlib/ndarray-dtypes": "^0.4.1", - "@stdlib/utils-nary-function": "^0.2.4", - "@stdlib/utils-unzip": "^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.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1acb2b4 --- /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 6a8c99f..0000000 --- a/test/test.js +++ /dev/null @@ -1,328 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 resolve = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof resolve, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an unsupported/unrecognized casting policy', function test( t ) { - var values; - var i; - - values = [ - 'float', - 'cmplx', - 'beep', - 'boop', - '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() { - resolve( 'float64', 'float64', 'float64', value ); - }; - } -}); - -tape( 'the function throws an error if provided data types which do not promote when the casting policy is "promoted"', function test( t ) { - var dt1; - var dt2; - var dt3; - var i; - - dt1 = [ - 'binary', - 'bool', - 'int32', - 'uint32', - 'binary' - ]; - dt2 = [ - 'generic', - 'float32', - 'bool', - 'int8', - 'int32' - ]; - dt3 = [ - 'float32', - 'int16', - 'float64', - 'bool', - 'float64' - ]; - for ( i = 0; i < dt1.length; i++ ) { - t.throws( badValue( dt1[ i ], dt2[ i ], dt3[ i ] ), Error, 'throws an error when provided '+dt1[ i ]+' and '+dt2[ i ]+' and '+dt3[ i ] ); - } - t.end(); - - function badValue( v1, v2, v3 ) { - return function badValue() { - resolve( v1, v2, v3, 'promoted' ); - }; - } -}); - -tape( 'the function resolves a casting data type (policy=none)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64' - ]; - - expected = dt1; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'none' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=output)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'complex128', - 'float64', - 'uint32', - 'int16', - 'generic' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'output' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=promoted)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'complex64' - ]; - dt2 = [ - 'float64', - 'int16', - 'int32', - 'float64', - 'float64' - ]; - dt3 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'float32' - ]; - expected = [ - 'float64', - 'int16', - 'int32', - 'complex128', - 'complex128' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'promoted' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=accumulation)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int16', - 'generic', - 'complex64', - 'uint16', - 'bool' - ]; - dt2 = [ - 'float16', - 'float64', - 'uint8c', - 'float64', - 'int32', - 'float32', - 'float32', - 'uint8', - 'bool' - ]; - dt3 = [ - 'int8', - 'float64', - 'float16', - 'int16', - 'int32', - 'int32', - 'int16', - 'uint32', - 'bool' - ]; - expected = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int32', - 'generic', - 'complex64', - 'uint32', - 'float64' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'accumulation' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'int8' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], dt3[ i ] ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); From 195b3664477550a7fc50558840d9fad7c040725f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 27 Jun 2026 03:28:23 +0000 Subject: [PATCH 28/36] Transform error messages --- lib/main.js | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/main.js b/lib/main.js index 3530917..c43ed91 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); var defaults = require( '@stdlib/ndarray-defaults' ); var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // diff --git a/package.json b/package.json index cd170c8..be29b38 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.5.1", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, From 1143c9047b55a92b771c8b0e265b068a866d3997 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 27 Jun 2026 03:38:14 +0000 Subject: [PATCH 29/36] Remove files --- index.d.ts | 43 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4890 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 49c9fa5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param idtype1 - input ndarray data type -* @param idtype2 - additional input ndarray data type -* @param odtype - output ndarray data type -* @param policy - input ndarray casting data type policy -* @returns input ndarray casting data type -* -* @example -* var dt = inputCastingDataType( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ -declare function inputCastingDataType( idtype1: DataType, idtype2: DataType, odtype: DataType, policy: InputCastingPolicy | DataType ): DataType; - - -// EXPORTS // - -export = inputCastingDataType; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d08ed3c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 8314587..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1acb2b4..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From a158d516ade621db7284508a65d2b36b508208ba Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 27 Jun 2026 03:38:32 +0000 Subject: [PATCH 30/36] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .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 | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 106 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 161 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 33 - docs/types/test.ts | 84 - examples/index.js | 60 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 40 - lib/main.js | 102 - package.json | 65 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 328 -- 44 files changed, 4869 insertions(+), 4526 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 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 (94%) 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 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +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 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# 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 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +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 - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 965aac5..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-06-27T03:25:03.571Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a9bf37b..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/base/binary-input-casting-dtype) 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 12cd77e..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/base/binary-input-casting-dtype) 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 a9decd9..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: '19 7 * * 4' - - # 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 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +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 notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # 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 + + ```
@@ -199,7 +190,7 @@ logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ] ## 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]. @@ -262,9 +253,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-binary-input-casting-dtype/main/LICENSE -[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes +[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes/tree/esm -[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies +[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies/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 a9221f1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,161 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var dtypes = require( '@stdlib/ndarray-dtypes' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var resolve = require( './../lib' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'numeric' ); - - -// MAIN // - -bench( format( '%s:policy=none', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'none' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=promoted', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'promoted' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=accumulation', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'accumulation' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=output', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'output' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'int32' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1799fb0..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/base/binary-input-casting-dtype" -%% click B href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/binary-input-casting-dtype -[production-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/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 29916aa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import inputCastingDataType from '../docs/types/index'; -export = inputCastingDataType; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cf866e5..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(r,e){return function(){try{return e||r((e={exports:{}}).exports,e),e.exports}catch(a){throw (e=0, a)}};};var g=v(function(F,o){ -var T=require('@stdlib/ndarray-base-assert-is-floating-point-data-type/dist'),E=require('@stdlib/ndarray-base-assert-is-signed-integer-data-type/dist'),_=require('@stdlib/ndarray-base-assert-is-unsigned-integer-data-type/dist'),f=require('@stdlib/ndarray-base-assert-is-data-type/dist'),u=require('@stdlib/ndarray-base-promote-dtypes/dist'),i=require('@stdlib/ndarray-defaults/dist'),D=require('@stdlib/array-base-join/dist'),s=require('@stdlib/error-tools-fmtprodmsg/dist'),m=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),q=i.get("dtypes.real_floating_point");function I(r,e,a,t){var n;if(t==="none")return r;if(t==="output")return a;if(t==="promoted"){if(n=u([r,e,a]),n===null)throw new Error(s('2VTJR',D([r,e],", "),a));return n}if(t==="accumulation")return T(r)||r==="generic"?r:_(r)?u([r,p]):E(r)?u([r,m]):q;if(f(t))return t;throw new TypeError(s('2VTJS',t))}o.exports=I -});var l=g();module.exports=l; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 2158cd8..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nvar isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' );\nvar isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' );\nvar isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' );\nvar isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );\nvar promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' );\nvar defaults = require( '@stdlib/ndarray-defaults' );\nvar join = require( '@stdlib/array-base-join' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = resolve;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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* Resolve the casting data type for an input ndarray provided to a binary function.\n*\n* @module @stdlib/ndarray-base-binary-input-casting-dtype\n*\n* @example\n* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' );\n*\n* var dt = resolve( 'float64', 'float64', 'float64', 'none' );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA4B,QAAS,2DAA4D,EACjGC,EAAa,QAAS,0CAA2C,EACjEC,EAAmB,QAAS,qCAAsC,EAClEC,EAAW,QAAS,0BAA2B,EAC/CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAS,QAAS,uBAAwB,EAK1CC,EAA+BH,EAAS,IAAK,uBAAwB,EACrEI,EAAiCJ,EAAS,IAAK,yBAA0B,EACzEK,EAAoCL,EAAS,IAAK,4BAA6B,EAoBnF,SAASM,EAASC,EAASC,EAASC,EAAQC,EAAS,CACpD,IAAIC,EACJ,GAAKD,IAAW,OAEf,OAAOH,EAER,GAAKG,IAAW,SACf,OAAOD,EAER,GAAKC,IAAW,WAAa,CAE5B,GADAC,EAAKZ,EAAkB,CAAEQ,EAASC,EAASC,CAAO,CAAE,EAC/CE,IAAO,KACX,MAAM,IAAI,MAAOT,EAAQ,sHAAuHD,EAAM,CAAEM,EAASC,CAAQ,EAAG,IAAK,EAAGC,CAAO,CAAE,EAE9L,OAAOE,CACR,CACA,GAAKD,IAAW,eAIf,OAAKf,EAAyBY,CAAQ,GAAKA,IAAY,UAC/CA,EAGHV,EAA2BU,CAAQ,EAChCR,EAAkB,CAAEQ,EAASH,CAA+B,CAAE,EAEjER,EAAyBW,CAAQ,EAC9BR,EAAkB,CAAEQ,EAASJ,CAA6B,CAAE,EAG7DE,EAGR,GAAKP,EAAYY,CAAO,EACvB,OAAOA,EAER,MAAM,IAAI,UAAWR,EAAQ,qFAAsFQ,CAAO,CAAE,CAC7H,CAKAhB,EAAO,QAAUY,ICnEjB,IAAIM,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isFloatingPointDataType", "isSignedIntegerDataType", "isUnsignedIntegerDataType", "isDataType", "promoteDataTypes", "defaults", "join", "format", "DEFAULT_SIGNED_INTEGER_DTYPE", "DEFAULT_UNSIGNED_INTEGER_DTYPE", "DEFAULT_REAL_FLOATING_POINT_DTYPE", "resolve", "idtype1", "idtype2", "odtype", "policy", "dt", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8eb71cc..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,33 +0,0 @@ - -{{alias}}( idtype1, idtype2, odtype, policy ) - Resolves the casting data type for an input ndarray provided to a binary - function. - - Parameters - ---------- - idtype1: string - Input ndarray data type. - - idtype2: string - Additional input ndarray data type. - - odtype: string - Output ndarray data type. - - policy: string - Input ndarray casting data type policy. If `policy` is a data type, the - function returns the `policy` value. - - Returns - ------- - out: string - Input ndarray casting data type. - - Examples - -------- - > var out = {{alias}}( 'float64', 'float64', 'float64', 'none' ) - 'float64' - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 29c87a8..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 inputCastingDataType = require( './index' ); - - -// TESTS // - -// The function returns a data type... -{ - inputCastingDataType( 'float64', 'float64', 'float64', 'none' ); // $ExpectType DataType -} - -// The compiler throws an error if not provided a first argument which is a data type... -{ - inputCastingDataType( '10', 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( true, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( false, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( null, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( undefined, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( [], 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( {}, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( ( x: number ): number => x, 'float64', 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a second argument which is a data type... -{ - inputCastingDataType( 'float64', '10', 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', true, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', false, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', null, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', undefined, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', [], 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', {}, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', ( x: number ): number => x, 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a third argument which is a data type... -{ - inputCastingDataType( 'float64', 'float64', '10', 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', true, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', false, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', null, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', undefined, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', [], 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', {}, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', ( x: number ): number => x, 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a fourth argument which is either a data type or data type policy... -{ - inputCastingDataType( 'float64', 'float64', 'float64', '10' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', true ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', false ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', null ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', undefined ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', [] ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', {} ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - inputCastingDataType(); // $ExpectError - inputCastingDataType( 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', 'none', 'foo' ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 8c7ef88..0000000 --- a/examples/index.js +++ /dev/null @@ -1,60 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var unzip = require( '@stdlib/utils-unzip' ); -var nCartesianProduct = require( '@stdlib/array-base-n-cartesian-product' ); -var logEachMap = require( '@stdlib/console-log-each-map' ); -var inputCastingDataType = require( './../lib' ); - -var idt1 = [ - 'float32', - 'float64' -]; - -var idt2 = [ - 'int8', - 'uint8', - 'uint16', - 'uint32' -]; - -var odt = [ - 'float32', - 'float64', - 'complex64', - 'complex128' -]; - -// Define a list of casting policies: -var policies = [ - 'promoted', - 'accumulation', - 'output' -]; - -// Generate dtype-policy argument groups: -var args = nCartesianProduct( idt1, idt2, odt, policies ); - -// Unzip the argument arrays: -args = unzip( args ); - -// Resolve casting data types: -logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ], args[ 1 ], args[ 2 ], args[ 3 ], naryFunction( inputCastingDataType, 4 ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 94% rename from docs/types/index.d.ts rename to index.d.ts index 42ccea6..49c9fa5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d08ed3c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8314587 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 69b2434..0000000 --- a/lib/index.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Resolve the casting data type for an input ndarray provided to a binary function. -* -* @module @stdlib/ndarray-base-binary-input-casting-dtype -* -* @example -* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' ); -* -* var dt = resolve( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ - -// 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 c43ed91..0000000 --- a/lib/main.js +++ /dev/null @@ -1,102 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable id-length, max-len */ - -'use strict'; - -// MODULES // - -var isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' ); -var isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' ); -var isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' ); -var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); -var defaults = require( '@stdlib/ndarray-defaults' ); -var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' ); -var DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' ); -var DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' ); - - -// MAIN // - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param {string} idtype1 - input ndarray data type -* @param {string} idtype2 - additional input ndarray data type -* @param {string} odtype - output ndarray data type -* @param {string} policy - input ndarray data type casting policy -* @throws {TypeError} fourth argument must be a recognized data type policy -* @throws {Error} unexpected error -* @returns {string} data type -* -* @example -* var dt = resolve( 'float32', 'float32', 'float64', 'none' ); -* // returns -*/ -function resolve( idtype1, idtype2, odtype, policy ) { - var dt; - if ( policy === 'none' ) { - // When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is... - return idtype1; - } - if ( policy === 'output' ) { - return odtype; - } - if ( policy === 'promoted' ) { - dt = promoteDataTypes( [ idtype1, idtype2, odtype ] ); - if ( dt === null ) { - throw new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) ); - } - return dt; - } - if ( policy === 'accumulation' ) { - // When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays... - - // If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type... - if ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited - return idtype1; - } - // Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements... - if ( isUnsignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] ); - } - if ( isSignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] ); - } - // For all other input data types, accumulate in the default real-valued floating-point data type... - return DEFAULT_REAL_FLOATING_POINT_DTYPE; - } - // Check for an explicit data type... - if ( isDataType( policy ) ) { - return policy; - } - throw new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) ); -} - - -// EXPORTS // - -module.exports = resolve; diff --git a/package.json b/package.json index be29b38..f5a10c6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Resolve the casting data type for an input ndarray provided to a binary function.", "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/array-base-join": "^0.1.2", - "@stdlib/ndarray-base-assert-is-data-type": "^0.2.3", - "@stdlib/ndarray-base-assert-is-floating-point-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-signed-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", - "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.5.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-n-cartesian-product": "^0.2.3", - "@stdlib/console-log-each-map": "^0.1.1", - "@stdlib/ndarray-dtypes": "^0.4.1", - "@stdlib/utils-nary-function": "^0.2.4", - "@stdlib/utils-unzip": "^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.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1acb2b4 --- /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 6a8c99f..0000000 --- a/test/test.js +++ /dev/null @@ -1,328 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 resolve = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof resolve, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an unsupported/unrecognized casting policy', function test( t ) { - var values; - var i; - - values = [ - 'float', - 'cmplx', - 'beep', - 'boop', - '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() { - resolve( 'float64', 'float64', 'float64', value ); - }; - } -}); - -tape( 'the function throws an error if provided data types which do not promote when the casting policy is "promoted"', function test( t ) { - var dt1; - var dt2; - var dt3; - var i; - - dt1 = [ - 'binary', - 'bool', - 'int32', - 'uint32', - 'binary' - ]; - dt2 = [ - 'generic', - 'float32', - 'bool', - 'int8', - 'int32' - ]; - dt3 = [ - 'float32', - 'int16', - 'float64', - 'bool', - 'float64' - ]; - for ( i = 0; i < dt1.length; i++ ) { - t.throws( badValue( dt1[ i ], dt2[ i ], dt3[ i ] ), Error, 'throws an error when provided '+dt1[ i ]+' and '+dt2[ i ]+' and '+dt3[ i ] ); - } - t.end(); - - function badValue( v1, v2, v3 ) { - return function badValue() { - resolve( v1, v2, v3, 'promoted' ); - }; - } -}); - -tape( 'the function resolves a casting data type (policy=none)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64' - ]; - - expected = dt1; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'none' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=output)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'complex128', - 'float64', - 'uint32', - 'int16', - 'generic' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'output' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=promoted)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'complex64' - ]; - dt2 = [ - 'float64', - 'int16', - 'int32', - 'float64', - 'float64' - ]; - dt3 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'float32' - ]; - expected = [ - 'float64', - 'int16', - 'int32', - 'complex128', - 'complex128' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'promoted' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=accumulation)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int16', - 'generic', - 'complex64', - 'uint16', - 'bool' - ]; - dt2 = [ - 'float16', - 'float64', - 'uint8c', - 'float64', - 'int32', - 'float32', - 'float32', - 'uint8', - 'bool' - ]; - dt3 = [ - 'int8', - 'float64', - 'float16', - 'int16', - 'int32', - 'int32', - 'int16', - 'uint32', - 'bool' - ]; - expected = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int32', - 'generic', - 'complex64', - 'uint32', - 'float64' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'accumulation' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'int8' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], dt3[ i ] ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); From 21fb6d61b65b52148e3ef40fac094ce450cbffb8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 9 Aug 2026 03:14:34 +0000 Subject: [PATCH 31/36] Transform error messages --- lib/main.js | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/main.js b/lib/main.js index 3530917..c43ed91 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); var defaults = require( '@stdlib/ndarray-defaults' ); var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // diff --git a/package.json b/package.json index cd170c8..be29b38 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.5.1", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, From ab6a48775b44e8c94ce61bcae4fd9a4775df4c58 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 9 Aug 2026 03:33:19 +0000 Subject: [PATCH 32/36] Remove files --- index.d.ts | 43 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4890 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 49c9fa5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param idtype1 - input ndarray data type -* @param idtype2 - additional input ndarray data type -* @param odtype - output ndarray data type -* @param policy - input ndarray casting data type policy -* @returns input ndarray casting data type -* -* @example -* var dt = inputCastingDataType( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ -declare function inputCastingDataType( idtype1: DataType, idtype2: DataType, odtype: DataType, policy: InputCastingPolicy | DataType ): DataType; - - -// EXPORTS // - -export = inputCastingDataType; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d08ed3c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 8314587..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1acb2b4..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From fdbb295c74aa27d4bd11a7183bd025c4bc3a56bd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 9 Aug 2026 03:33:39 +0000 Subject: [PATCH 33/36] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .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 | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 106 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 161 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 33 - docs/types/test.ts | 84 - examples/index.js | 60 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 40 - lib/main.js | 102 - package.json | 65 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 328 -- 44 files changed, 4869 insertions(+), 4526 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 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 (94%) 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 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +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 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# 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 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +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 - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index a97a81d..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-08-09T03:06:27.866Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a9bf37b..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/base/binary-input-casting-dtype) 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 12cd77e..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/base/binary-input-casting-dtype) 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 a9decd9..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: '19 7 * * 4' - - # 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 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +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 notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # 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 + + ```
@@ -199,7 +190,7 @@ logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ] ## 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]. @@ -262,9 +253,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-binary-input-casting-dtype/main/LICENSE -[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes +[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes/tree/esm -[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies +[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies/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 a9221f1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,161 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var dtypes = require( '@stdlib/ndarray-dtypes' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var resolve = require( './../lib' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'numeric' ); - - -// MAIN // - -bench( format( '%s:policy=none', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'none' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=promoted', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'promoted' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=accumulation', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'accumulation' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=output', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'output' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'int32' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1799fb0..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/base/binary-input-casting-dtype" -%% click B href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/binary-input-casting-dtype -[production-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/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 29916aa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import inputCastingDataType from '../docs/types/index'; -export = inputCastingDataType; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cf866e5..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(r,e){return function(){try{return e||r((e={exports:{}}).exports,e),e.exports}catch(a){throw (e=0, a)}};};var g=v(function(F,o){ -var T=require('@stdlib/ndarray-base-assert-is-floating-point-data-type/dist'),E=require('@stdlib/ndarray-base-assert-is-signed-integer-data-type/dist'),_=require('@stdlib/ndarray-base-assert-is-unsigned-integer-data-type/dist'),f=require('@stdlib/ndarray-base-assert-is-data-type/dist'),u=require('@stdlib/ndarray-base-promote-dtypes/dist'),i=require('@stdlib/ndarray-defaults/dist'),D=require('@stdlib/array-base-join/dist'),s=require('@stdlib/error-tools-fmtprodmsg/dist'),m=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),q=i.get("dtypes.real_floating_point");function I(r,e,a,t){var n;if(t==="none")return r;if(t==="output")return a;if(t==="promoted"){if(n=u([r,e,a]),n===null)throw new Error(s('2VTJR',D([r,e],", "),a));return n}if(t==="accumulation")return T(r)||r==="generic"?r:_(r)?u([r,p]):E(r)?u([r,m]):q;if(f(t))return t;throw new TypeError(s('2VTJS',t))}o.exports=I -});var l=g();module.exports=l; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 2158cd8..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nvar isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' );\nvar isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' );\nvar isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' );\nvar isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );\nvar promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' );\nvar defaults = require( '@stdlib/ndarray-defaults' );\nvar join = require( '@stdlib/array-base-join' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = resolve;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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* Resolve the casting data type for an input ndarray provided to a binary function.\n*\n* @module @stdlib/ndarray-base-binary-input-casting-dtype\n*\n* @example\n* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' );\n*\n* var dt = resolve( 'float64', 'float64', 'float64', 'none' );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA4B,QAAS,2DAA4D,EACjGC,EAAa,QAAS,0CAA2C,EACjEC,EAAmB,QAAS,qCAAsC,EAClEC,EAAW,QAAS,0BAA2B,EAC/CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAS,QAAS,uBAAwB,EAK1CC,EAA+BH,EAAS,IAAK,uBAAwB,EACrEI,EAAiCJ,EAAS,IAAK,yBAA0B,EACzEK,EAAoCL,EAAS,IAAK,4BAA6B,EAoBnF,SAASM,EAASC,EAASC,EAASC,EAAQC,EAAS,CACpD,IAAIC,EACJ,GAAKD,IAAW,OAEf,OAAOH,EAER,GAAKG,IAAW,SACf,OAAOD,EAER,GAAKC,IAAW,WAAa,CAE5B,GADAC,EAAKZ,EAAkB,CAAEQ,EAASC,EAASC,CAAO,CAAE,EAC/CE,IAAO,KACX,MAAM,IAAI,MAAOT,EAAQ,sHAAuHD,EAAM,CAAEM,EAASC,CAAQ,EAAG,IAAK,EAAGC,CAAO,CAAE,EAE9L,OAAOE,CACR,CACA,GAAKD,IAAW,eAIf,OAAKf,EAAyBY,CAAQ,GAAKA,IAAY,UAC/CA,EAGHV,EAA2BU,CAAQ,EAChCR,EAAkB,CAAEQ,EAASH,CAA+B,CAAE,EAEjER,EAAyBW,CAAQ,EAC9BR,EAAkB,CAAEQ,EAASJ,CAA6B,CAAE,EAG7DE,EAGR,GAAKP,EAAYY,CAAO,EACvB,OAAOA,EAER,MAAM,IAAI,UAAWR,EAAQ,qFAAsFQ,CAAO,CAAE,CAC7H,CAKAhB,EAAO,QAAUY,ICnEjB,IAAIM,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isFloatingPointDataType", "isSignedIntegerDataType", "isUnsignedIntegerDataType", "isDataType", "promoteDataTypes", "defaults", "join", "format", "DEFAULT_SIGNED_INTEGER_DTYPE", "DEFAULT_UNSIGNED_INTEGER_DTYPE", "DEFAULT_REAL_FLOATING_POINT_DTYPE", "resolve", "idtype1", "idtype2", "odtype", "policy", "dt", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8eb71cc..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,33 +0,0 @@ - -{{alias}}( idtype1, idtype2, odtype, policy ) - Resolves the casting data type for an input ndarray provided to a binary - function. - - Parameters - ---------- - idtype1: string - Input ndarray data type. - - idtype2: string - Additional input ndarray data type. - - odtype: string - Output ndarray data type. - - policy: string - Input ndarray casting data type policy. If `policy` is a data type, the - function returns the `policy` value. - - Returns - ------- - out: string - Input ndarray casting data type. - - Examples - -------- - > var out = {{alias}}( 'float64', 'float64', 'float64', 'none' ) - 'float64' - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 29c87a8..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 inputCastingDataType = require( './index' ); - - -// TESTS // - -// The function returns a data type... -{ - inputCastingDataType( 'float64', 'float64', 'float64', 'none' ); // $ExpectType DataType -} - -// The compiler throws an error if not provided a first argument which is a data type... -{ - inputCastingDataType( '10', 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( true, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( false, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( null, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( undefined, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( [], 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( {}, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( ( x: number ): number => x, 'float64', 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a second argument which is a data type... -{ - inputCastingDataType( 'float64', '10', 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', true, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', false, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', null, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', undefined, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', [], 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', {}, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', ( x: number ): number => x, 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a third argument which is a data type... -{ - inputCastingDataType( 'float64', 'float64', '10', 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', true, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', false, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', null, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', undefined, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', [], 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', {}, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', ( x: number ): number => x, 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a fourth argument which is either a data type or data type policy... -{ - inputCastingDataType( 'float64', 'float64', 'float64', '10' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', true ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', false ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', null ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', undefined ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', [] ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', {} ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - inputCastingDataType(); // $ExpectError - inputCastingDataType( 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', 'none', 'foo' ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 8c7ef88..0000000 --- a/examples/index.js +++ /dev/null @@ -1,60 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var unzip = require( '@stdlib/utils-unzip' ); -var nCartesianProduct = require( '@stdlib/array-base-n-cartesian-product' ); -var logEachMap = require( '@stdlib/console-log-each-map' ); -var inputCastingDataType = require( './../lib' ); - -var idt1 = [ - 'float32', - 'float64' -]; - -var idt2 = [ - 'int8', - 'uint8', - 'uint16', - 'uint32' -]; - -var odt = [ - 'float32', - 'float64', - 'complex64', - 'complex128' -]; - -// Define a list of casting policies: -var policies = [ - 'promoted', - 'accumulation', - 'output' -]; - -// Generate dtype-policy argument groups: -var args = nCartesianProduct( idt1, idt2, odt, policies ); - -// Unzip the argument arrays: -args = unzip( args ); - -// Resolve casting data types: -logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ], args[ 1 ], args[ 2 ], args[ 3 ], naryFunction( inputCastingDataType, 4 ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 94% rename from docs/types/index.d.ts rename to index.d.ts index 42ccea6..49c9fa5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d08ed3c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8314587 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 69b2434..0000000 --- a/lib/index.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Resolve the casting data type for an input ndarray provided to a binary function. -* -* @module @stdlib/ndarray-base-binary-input-casting-dtype -* -* @example -* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' ); -* -* var dt = resolve( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ - -// 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 c43ed91..0000000 --- a/lib/main.js +++ /dev/null @@ -1,102 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable id-length, max-len */ - -'use strict'; - -// MODULES // - -var isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' ); -var isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' ); -var isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' ); -var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); -var defaults = require( '@stdlib/ndarray-defaults' ); -var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' ); -var DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' ); -var DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' ); - - -// MAIN // - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param {string} idtype1 - input ndarray data type -* @param {string} idtype2 - additional input ndarray data type -* @param {string} odtype - output ndarray data type -* @param {string} policy - input ndarray data type casting policy -* @throws {TypeError} fourth argument must be a recognized data type policy -* @throws {Error} unexpected error -* @returns {string} data type -* -* @example -* var dt = resolve( 'float32', 'float32', 'float64', 'none' ); -* // returns -*/ -function resolve( idtype1, idtype2, odtype, policy ) { - var dt; - if ( policy === 'none' ) { - // When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is... - return idtype1; - } - if ( policy === 'output' ) { - return odtype; - } - if ( policy === 'promoted' ) { - dt = promoteDataTypes( [ idtype1, idtype2, odtype ] ); - if ( dt === null ) { - throw new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) ); - } - return dt; - } - if ( policy === 'accumulation' ) { - // When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays... - - // If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type... - if ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited - return idtype1; - } - // Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements... - if ( isUnsignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] ); - } - if ( isSignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] ); - } - // For all other input data types, accumulate in the default real-valued floating-point data type... - return DEFAULT_REAL_FLOATING_POINT_DTYPE; - } - // Check for an explicit data type... - if ( isDataType( policy ) ) { - return policy; - } - throw new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) ); -} - - -// EXPORTS // - -module.exports = resolve; diff --git a/package.json b/package.json index be29b38..f5a10c6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Resolve the casting data type for an input ndarray provided to a binary function.", "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/array-base-join": "^0.1.2", - "@stdlib/ndarray-base-assert-is-data-type": "^0.2.3", - "@stdlib/ndarray-base-assert-is-floating-point-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-signed-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", - "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.5.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-n-cartesian-product": "^0.2.3", - "@stdlib/console-log-each-map": "^0.1.1", - "@stdlib/ndarray-dtypes": "^0.4.1", - "@stdlib/utils-nary-function": "^0.2.4", - "@stdlib/utils-unzip": "^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.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1acb2b4 --- /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 6a8c99f..0000000 --- a/test/test.js +++ /dev/null @@ -1,328 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 resolve = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof resolve, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an unsupported/unrecognized casting policy', function test( t ) { - var values; - var i; - - values = [ - 'float', - 'cmplx', - 'beep', - 'boop', - '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() { - resolve( 'float64', 'float64', 'float64', value ); - }; - } -}); - -tape( 'the function throws an error if provided data types which do not promote when the casting policy is "promoted"', function test( t ) { - var dt1; - var dt2; - var dt3; - var i; - - dt1 = [ - 'binary', - 'bool', - 'int32', - 'uint32', - 'binary' - ]; - dt2 = [ - 'generic', - 'float32', - 'bool', - 'int8', - 'int32' - ]; - dt3 = [ - 'float32', - 'int16', - 'float64', - 'bool', - 'float64' - ]; - for ( i = 0; i < dt1.length; i++ ) { - t.throws( badValue( dt1[ i ], dt2[ i ], dt3[ i ] ), Error, 'throws an error when provided '+dt1[ i ]+' and '+dt2[ i ]+' and '+dt3[ i ] ); - } - t.end(); - - function badValue( v1, v2, v3 ) { - return function badValue() { - resolve( v1, v2, v3, 'promoted' ); - }; - } -}); - -tape( 'the function resolves a casting data type (policy=none)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64' - ]; - - expected = dt1; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'none' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=output)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'complex128', - 'float64', - 'uint32', - 'int16', - 'generic' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'output' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=promoted)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'complex64' - ]; - dt2 = [ - 'float64', - 'int16', - 'int32', - 'float64', - 'float64' - ]; - dt3 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'float32' - ]; - expected = [ - 'float64', - 'int16', - 'int32', - 'complex128', - 'complex128' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'promoted' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=accumulation)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int16', - 'generic', - 'complex64', - 'uint16', - 'bool' - ]; - dt2 = [ - 'float16', - 'float64', - 'uint8c', - 'float64', - 'int32', - 'float32', - 'float32', - 'uint8', - 'bool' - ]; - dt3 = [ - 'int8', - 'float64', - 'float16', - 'int16', - 'int32', - 'int32', - 'int16', - 'uint32', - 'bool' - ]; - expected = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int32', - 'generic', - 'complex64', - 'uint32', - 'float64' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'accumulation' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'int8' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], dt3[ i ] ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); From b6c51bb136547700919c60cb6c5061ec279bf684 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 15 Aug 2026 02:33:41 +0000 Subject: [PATCH 34/36] Transform error messages --- lib/main.js | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/main.js b/lib/main.js index 3530917..c43ed91 100644 --- a/lib/main.js +++ b/lib/main.js @@ -29,7 +29,7 @@ var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); var defaults = require( '@stdlib/ndarray-defaults' ); var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // diff --git a/package.json b/package.json index cd170c8..be29b38 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.5.1", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, From a0eedef370b7bb493fb5c0a807889add3d64109b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 15 Aug 2026 02:40:35 +0000 Subject: [PATCH 35/36] Remove files --- index.d.ts | 43 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4890 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 49c9fa5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,43 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param idtype1 - input ndarray data type -* @param idtype2 - additional input ndarray data type -* @param odtype - output ndarray data type -* @param policy - input ndarray casting data type policy -* @returns input ndarray casting data type -* -* @example -* var dt = inputCastingDataType( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ -declare function inputCastingDataType( idtype1: DataType, idtype2: DataType, odtype: DataType, policy: InputCastingPolicy | DataType ): DataType; - - -// EXPORTS // - -export = inputCastingDataType; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d08ed3c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 8314587..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1acb2b4..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 435647fc5facb4adcda0de6a1fe2c725aff2fec6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 15 Aug 2026 02:40:55 +0000 Subject: [PATCH 36/36] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .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 | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 205 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 106 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 161 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 33 - docs/types/test.ts | 84 - examples/index.js | 60 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 40 - lib/main.js | 102 - package.json | 65 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 328 -- 44 files changed, 4869 insertions(+), 4527 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 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 (94%) 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 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +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 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# 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 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +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 - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 00229cd..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-08-15T02:30:55.738Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a9bf37b..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/base/binary-input-casting-dtype) 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 12cd77e..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/base/binary-input-casting-dtype) 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 a9decd9..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: '19 7 * * 4' - - # 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 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +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 notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # 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 + + ```
@@ -199,7 +190,7 @@ logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ] ## 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]. @@ -262,9 +253,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-binary-input-casting-dtype/main/LICENSE -[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes +[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes/tree/esm -[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies +[@stdlib/ndarray/input-casting-policies]: https://github.com/stdlib-js/ndarray-input-casting-policies/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 a9221f1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,161 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var dtypes = require( '@stdlib/ndarray-dtypes' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var resolve = require( './../lib' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'numeric' ); - - -// MAIN // - -bench( format( '%s:policy=none', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'none' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=promoted', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'promoted' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=accumulation', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'accumulation' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=output', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'output' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:policy=', pkg ), function benchmark( b ) { - var out; - var dt1; - var dt2; - var dt3; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt1 = DTYPES[ i%DTYPES.length ]; - dt2 = DTYPES[ i%DTYPES.length ]; - dt3 = DTYPES[ (i+1)%DTYPES.length ]; - out = resolve( dt1, dt2, dt3, 'int32' ); - if ( typeof out !== 'string' ) { - b.fail( 'should return a string' ); - } - } - b.toc(); - if ( !isDataType( out ) ) { - b.fail( 'should return a data type' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1799fb0..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/base/binary-input-casting-dtype" -%% click B href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/binary-input-casting-dtype -[production-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-base-binary-input-casting-dtype/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 29916aa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import inputCastingDataType from '../docs/types/index'; -export = inputCastingDataType; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cf866e5..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var v=function(r,e){return function(){try{return e||r((e={exports:{}}).exports,e),e.exports}catch(a){throw (e=0, a)}};};var g=v(function(F,o){ -var T=require('@stdlib/ndarray-base-assert-is-floating-point-data-type/dist'),E=require('@stdlib/ndarray-base-assert-is-signed-integer-data-type/dist'),_=require('@stdlib/ndarray-base-assert-is-unsigned-integer-data-type/dist'),f=require('@stdlib/ndarray-base-assert-is-data-type/dist'),u=require('@stdlib/ndarray-base-promote-dtypes/dist'),i=require('@stdlib/ndarray-defaults/dist'),D=require('@stdlib/array-base-join/dist'),s=require('@stdlib/error-tools-fmtprodmsg/dist'),m=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),q=i.get("dtypes.real_floating_point");function I(r,e,a,t){var n;if(t==="none")return r;if(t==="output")return a;if(t==="promoted"){if(n=u([r,e,a]),n===null)throw new Error(s('2VTJR',D([r,e],", "),a));return n}if(t==="accumulation")return T(r)||r==="generic"?r:_(r)?u([r,p]):E(r)?u([r,m]):q;if(f(t))return t;throw new TypeError(s('2VTJS',t))}o.exports=I -});var l=g();module.exports=l; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 2158cd8..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nvar isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' );\nvar isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' );\nvar isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' );\nvar isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' );\nvar promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' );\nvar defaults = require( '@stdlib/ndarray-defaults' );\nvar join = require( '@stdlib/array-base-join' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = resolve;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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* Resolve the casting data type for an input ndarray provided to a binary function.\n*\n* @module @stdlib/ndarray-base-binary-input-casting-dtype\n*\n* @example\n* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' );\n*\n* var dt = resolve( 'float64', 'float64', 'float64', 'none' );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA4B,QAAS,2DAA4D,EACjGC,EAAa,QAAS,0CAA2C,EACjEC,EAAmB,QAAS,qCAAsC,EAClEC,EAAW,QAAS,0BAA2B,EAC/CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAS,QAAS,uBAAwB,EAK1CC,EAA+BH,EAAS,IAAK,uBAAwB,EACrEI,EAAiCJ,EAAS,IAAK,yBAA0B,EACzEK,EAAoCL,EAAS,IAAK,4BAA6B,EAoBnF,SAASM,EAASC,EAASC,EAASC,EAAQC,EAAS,CACpD,IAAIC,EACJ,GAAKD,IAAW,OAEf,OAAOH,EAER,GAAKG,IAAW,SACf,OAAOD,EAER,GAAKC,IAAW,WAAa,CAE5B,GADAC,EAAKZ,EAAkB,CAAEQ,EAASC,EAASC,CAAO,CAAE,EAC/CE,IAAO,KACX,MAAM,IAAI,MAAOT,EAAQ,sHAAuHD,EAAM,CAAEM,EAASC,CAAQ,EAAG,IAAK,EAAGC,CAAO,CAAE,EAE9L,OAAOE,CACR,CACA,GAAKD,IAAW,eAIf,OAAKf,EAAyBY,CAAQ,GAAKA,IAAY,UAC/CA,EAGHV,EAA2BU,CAAQ,EAChCR,EAAkB,CAAEQ,EAASH,CAA+B,CAAE,EAEjER,EAAyBW,CAAQ,EAC9BR,EAAkB,CAAEQ,EAASJ,CAA6B,CAAE,EAG7DE,EAGR,GAAKP,EAAYY,CAAO,EACvB,OAAOA,EAER,MAAM,IAAI,UAAWR,EAAQ,qFAAsFQ,CAAO,CAAE,CAC7H,CAKAhB,EAAO,QAAUY,ICnEjB,IAAIM,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isFloatingPointDataType", "isSignedIntegerDataType", "isUnsignedIntegerDataType", "isDataType", "promoteDataTypes", "defaults", "join", "format", "DEFAULT_SIGNED_INTEGER_DTYPE", "DEFAULT_UNSIGNED_INTEGER_DTYPE", "DEFAULT_REAL_FLOATING_POINT_DTYPE", "resolve", "idtype1", "idtype2", "odtype", "policy", "dt", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8eb71cc..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,33 +0,0 @@ - -{{alias}}( idtype1, idtype2, odtype, policy ) - Resolves the casting data type for an input ndarray provided to a binary - function. - - Parameters - ---------- - idtype1: string - Input ndarray data type. - - idtype2: string - Additional input ndarray data type. - - odtype: string - Output ndarray data type. - - policy: string - Input ndarray casting data type policy. If `policy` is a data type, the - function returns the `policy` value. - - Returns - ------- - out: string - Input ndarray casting data type. - - Examples - -------- - > var out = {{alias}}( 'float64', 'float64', 'float64', 'none' ) - 'float64' - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 29c87a8..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,84 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 inputCastingDataType = require( './index' ); - - -// TESTS // - -// The function returns a data type... -{ - inputCastingDataType( 'float64', 'float64', 'float64', 'none' ); // $ExpectType DataType -} - -// The compiler throws an error if not provided a first argument which is a data type... -{ - inputCastingDataType( '10', 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( true, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( false, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( null, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( undefined, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( [], 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( {}, 'float64', 'float64', 'none' ); // $ExpectError - inputCastingDataType( ( x: number ): number => x, 'float64', 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a second argument which is a data type... -{ - inputCastingDataType( 'float64', '10', 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', true, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', false, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', null, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', undefined, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', [], 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', {}, 'float64', 'none' ); // $ExpectError - inputCastingDataType( 'float64', ( x: number ): number => x, 'float64', 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a third argument which is a data type... -{ - inputCastingDataType( 'float64', 'float64', '10', 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', true, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', false, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', null, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', undefined, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', [], 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', {}, 'none' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', ( x: number ): number => x, 'none' ); // $ExpectError -} - -// The compiler throws an error if not provided a fourth argument which is either a data type or data type policy... -{ - inputCastingDataType( 'float64', 'float64', 'float64', '10' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', true ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', false ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', null ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', undefined ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', [] ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', {} ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - inputCastingDataType(); // $ExpectError - inputCastingDataType( 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64' ); // $ExpectError - inputCastingDataType( 'float64', 'float64', 'float64', 'none', 'foo' ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 8c7ef88..0000000 --- a/examples/index.js +++ /dev/null @@ -1,60 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var unzip = require( '@stdlib/utils-unzip' ); -var nCartesianProduct = require( '@stdlib/array-base-n-cartesian-product' ); -var logEachMap = require( '@stdlib/console-log-each-map' ); -var inputCastingDataType = require( './../lib' ); - -var idt1 = [ - 'float32', - 'float64' -]; - -var idt2 = [ - 'int8', - 'uint8', - 'uint16', - 'uint32' -]; - -var odt = [ - 'float32', - 'float64', - 'complex64', - 'complex128' -]; - -// Define a list of casting policies: -var policies = [ - 'promoted', - 'accumulation', - 'output' -]; - -// Generate dtype-policy argument groups: -var args = nCartesianProduct( idt1, idt2, odt, policies ); - -// Unzip the argument arrays: -args = unzip( args ); - -// Resolve casting data types: -logEachMap( 'dtypes: (%10s, %10s, %10s). policy: %20s. result: %10s.', args[ 0 ], args[ 1 ], args[ 2 ], args[ 3 ], naryFunction( inputCastingDataType, 4 ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 94% rename from docs/types/index.d.ts rename to index.d.ts index 42ccea6..49c9fa5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, InputCastingPolicy } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d08ed3c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.3.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.3.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.3.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.4.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";var o=i.get("dtypes.signed_integer"),p=i.get("dtypes.unsigned_integer"),m=i.get("dtypes.real_floating_point");function l(i,l,u,g){var j;if("none"===g)return i;if("output"===g)return u;if("promoted"===g){if(null===(j=n([i,l,u])))throw new Error(a("invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.",d([i,l],", "),u));return j}if("accumulation"===g)return t(i)||"generic"===i?i:s(i)?n([i,p]):e(i)?n([i,o]):m;if(r(g))return g;throw new TypeError(a("invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.",g))}export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..8314587 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 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/* eslint-disable id-length, max-len */\n\n'use strict';\n\n// MODULES //\n\nimport isFloatingPointDataType from '@stdlib/ndarray-base-assert-is-floating-point-data-type';\nimport isSignedIntegerDataType from '@stdlib/ndarray-base-assert-is-signed-integer-data-type';\nimport isUnsignedIntegerDataType from '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type';\nimport isDataType from '@stdlib/ndarray-base-assert-is-data-type';\nimport promoteDataTypes from '@stdlib/ndarray-base-promote-dtypes';\nimport defaults from '@stdlib/ndarray-defaults';\nimport join from '@stdlib/array-base-join';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' );\nvar DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' );\nvar DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' );\n\n\n// MAIN //\n\n/**\n* Resolves the casting data type for an input ndarray provided to a binary function.\n*\n* @param {string} idtype1 - input ndarray data type\n* @param {string} idtype2 - additional input ndarray data type\n* @param {string} odtype - output ndarray data type\n* @param {string} policy - input ndarray data type casting policy\n* @throws {TypeError} fourth argument must be a recognized data type policy\n* @throws {Error} unexpected error\n* @returns {string} data type\n*\n* @example\n* var dt = resolve( 'float32', 'float32', 'float64', 'none' );\n* // returns \n*/\nfunction resolve( idtype1, idtype2, odtype, policy ) {\n\tvar dt;\n\tif ( policy === 'none' ) {\n\t\t// When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is...\n\t\treturn idtype1;\n\t}\n\tif ( policy === 'output' ) {\n\t\treturn odtype;\n\t}\n\tif ( policy === 'promoted' ) {\n\t\tdt = promoteDataTypes( [ idtype1, idtype2, odtype ] );\n\t\tif ( dt === null ) {\n\t\t\tthrow new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) );\n\t\t}\n\t\treturn dt;\n\t}\n\tif ( policy === 'accumulation' ) {\n\t\t// When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays...\n\n\t\t// If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type...\n\t\tif ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited\n\t\t\treturn idtype1;\n\t\t}\n\t\t// Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements...\n\t\tif ( isUnsignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\tif ( isSignedIntegerDataType( idtype1 ) ) {\n\t\t\treturn promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] );\n\t\t}\n\t\t// For all other input data types, accumulate in the default real-valued floating-point data type...\n\t\treturn DEFAULT_REAL_FLOATING_POINT_DTYPE;\n\t}\n\t// Check for an explicit data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\tthrow new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_SIGNED_INTEGER_DTYPE","defaults","get","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","resolve","idtype1","idtype2","odtype","policy","dt","promoteDataTypes","Error","format","join","isFloatingPointDataType","isUnsignedIntegerDataType","isSignedIntegerDataType","isDataType","TypeError"],"mappings":";;u1BAoCA,IAAIA,EAA+BC,EAASC,IAAK,yBAC7CC,EAAiCF,EAASC,IAAK,2BAC/CE,EAAoCH,EAASC,IAAK,8BAoBtD,SAASG,EAASC,EAASC,EAASC,EAAQC,GAC3C,IAAIC,EACJ,GAAgB,SAAXD,EAEJ,OAAOH,EAER,GAAgB,WAAXG,EACJ,OAAOD,EAER,GAAgB,aAAXC,EAAwB,CAE5B,GAAY,QADZC,EAAKC,EAAkB,CAAEL,EAASC,EAASC,KAE1C,MAAM,IAAII,MAAOC,EAAQ,sHAAuHC,EAAM,CAAER,EAASC,GAAW,MAAQC,IAErL,OAAOE,CACP,CACD,GAAgB,iBAAXD,EAIJ,OAAKM,EAAyBT,IAAyB,YAAZA,EACnCA,EAGHU,EAA2BV,GACxBK,EAAkB,CAAEL,EAASH,IAEhCc,EAAyBX,GACtBK,EAAkB,CAAEL,EAASN,IAG9BI,EAGR,GAAKc,EAAYT,GAChB,OAAOA,EAER,MAAM,IAAIU,UAAWN,EAAQ,qFAAsFJ,GACpH"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 69b2434..0000000 --- a/lib/index.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Resolve the casting data type for an input ndarray provided to a binary function. -* -* @module @stdlib/ndarray-base-binary-input-casting-dtype -* -* @example -* var resolve = require( '@stdlib/ndarray-base-binary-input-casting-dtype' ); -* -* var dt = resolve( 'float64', 'float64', 'float64', 'none' ); -* // returns -*/ - -// 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 c43ed91..0000000 --- a/lib/main.js +++ /dev/null @@ -1,102 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable id-length, max-len */ - -'use strict'; - -// MODULES // - -var isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' ); -var isSignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-signed-integer-data-type' ); -var isUnsignedIntegerDataType = require( '@stdlib/ndarray-base-assert-is-unsigned-integer-data-type' ); -var isDataType = require( '@stdlib/ndarray-base-assert-is-data-type' ); -var promoteDataTypes = require( '@stdlib/ndarray-base-promote-dtypes' ); -var defaults = require( '@stdlib/ndarray-defaults' ); -var join = require( '@stdlib/array-base-join' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DEFAULT_SIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.signed_integer' ); -var DEFAULT_UNSIGNED_INTEGER_DTYPE = defaults.get( 'dtypes.unsigned_integer' ); -var DEFAULT_REAL_FLOATING_POINT_DTYPE = defaults.get( 'dtypes.real_floating_point' ); - - -// MAIN // - -/** -* Resolves the casting data type for an input ndarray provided to a binary function. -* -* @param {string} idtype1 - input ndarray data type -* @param {string} idtype2 - additional input ndarray data type -* @param {string} odtype - output ndarray data type -* @param {string} policy - input ndarray data type casting policy -* @throws {TypeError} fourth argument must be a recognized data type policy -* @throws {Error} unexpected error -* @returns {string} data type -* -* @example -* var dt = resolve( 'float32', 'float32', 'float64', 'none' ); -* // returns -*/ -function resolve( idtype1, idtype2, odtype, policy ) { - var dt; - if ( policy === 'none' ) { - // When the policy is 'none', casting behavior is implementation-defined, so we just return the input ndarray data type as is... - return idtype1; - } - if ( policy === 'output' ) { - return odtype; - } - if ( policy === 'promoted' ) { - dt = promoteDataTypes( [ idtype1, idtype2, odtype ] ); - if ( dt === null ) { - throw new Error( format( 'invalid operation. Unable to promote the input and output data types. Input data types: [%s]. Output data type: %s.', join( [ idtype1, idtype2 ], ', ' ), odtype ) ); - } - return dt; - } - if ( policy === 'accumulation' ) { - // When the casting policy is 'accumulation', we consider the input ndarray data type in isolation, irrespective of the output data type or the data types of additional input ndarrays... - - // If an input data type is floating-point, allow accumulation in that data type as overflow/underflow is handled naturally as a built-in feature of that data type... - if ( isFloatingPointDataType( idtype1 ) || idtype1 === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited - return idtype1; - } - // Unless an input data type value range is larger than the default un/signed integer data type, accumulate in the default un/signed integer data type, as accumulating in smaller range integer data types (e.g., `int8`) are at high risk for overflow, especially for ndarrays containing many elements... - if ( isUnsignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_UNSIGNED_INTEGER_DTYPE ] ); - } - if ( isSignedIntegerDataType( idtype1 ) ) { - return promoteDataTypes( [ idtype1, DEFAULT_SIGNED_INTEGER_DTYPE ] ); - } - // For all other input data types, accumulate in the default real-valued floating-point data type... - return DEFAULT_REAL_FLOATING_POINT_DTYPE; - } - // Check for an explicit data type... - if ( isDataType( policy ) ) { - return policy; - } - throw new TypeError( format( 'invalid argument. Fourth argument must be a supported casting policy. Value: `%s`.', policy ) ); -} - - -// EXPORTS // - -module.exports = resolve; diff --git a/package.json b/package.json index be29b38..f5a10c6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Resolve the casting data type for an input ndarray provided to a binary function.", "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/array-base-join": "^0.1.2", - "@stdlib/ndarray-base-assert-is-data-type": "^0.2.3", - "@stdlib/ndarray-base-assert-is-floating-point-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-signed-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-assert-is-unsigned-integer-data-type": "^0.3.1", - "@stdlib/ndarray-base-promote-dtypes": "^0.1.1", - "@stdlib/ndarray-defaults": "^0.4.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.5.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-n-cartesian-product": "^0.2.3", - "@stdlib/console-log-each-map": "^0.1.1", - "@stdlib/ndarray-dtypes": "^0.4.1", - "@stdlib/utils-nary-function": "^0.2.4", - "@stdlib/utils-unzip": "^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.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1acb2b4 --- /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 6a8c99f..0000000 --- a/test/test.js +++ /dev/null @@ -1,328 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 resolve = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof resolve, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an unsupported/unrecognized casting policy', function test( t ) { - var values; - var i; - - values = [ - 'float', - 'cmplx', - 'beep', - 'boop', - '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() { - resolve( 'float64', 'float64', 'float64', value ); - }; - } -}); - -tape( 'the function throws an error if provided data types which do not promote when the casting policy is "promoted"', function test( t ) { - var dt1; - var dt2; - var dt3; - var i; - - dt1 = [ - 'binary', - 'bool', - 'int32', - 'uint32', - 'binary' - ]; - dt2 = [ - 'generic', - 'float32', - 'bool', - 'int8', - 'int32' - ]; - dt3 = [ - 'float32', - 'int16', - 'float64', - 'bool', - 'float64' - ]; - for ( i = 0; i < dt1.length; i++ ) { - t.throws( badValue( dt1[ i ], dt2[ i ], dt3[ i ] ), Error, 'throws an error when provided '+dt1[ i ]+' and '+dt2[ i ]+' and '+dt3[ i ] ); - } - t.end(); - - function badValue( v1, v2, v3 ) { - return function badValue() { - resolve( v1, v2, v3, 'promoted' ); - }; - } -}); - -tape( 'the function resolves a casting data type (policy=none)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64' - ]; - - expected = dt1; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'none' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=output)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'complex64' - ]; - dt3 = [ - 'complex128', - 'float64', - 'uint32', - 'int16', - 'generic' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'output' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=promoted)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'complex64' - ]; - dt2 = [ - 'float64', - 'int16', - 'int32', - 'float64', - 'float64' - ]; - dt3 = [ - 'float32', - 'int8', - 'uint16', - 'complex64', - 'float32' - ]; - expected = [ - 'float64', - 'int16', - 'int32', - 'complex128', - 'complex128' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'promoted' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=accumulation)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int16', - 'generic', - 'complex64', - 'uint16', - 'bool' - ]; - dt2 = [ - 'float16', - 'float64', - 'uint8c', - 'float64', - 'int32', - 'float32', - 'float32', - 'uint8', - 'bool' - ]; - dt3 = [ - 'int8', - 'float64', - 'float16', - 'int16', - 'int32', - 'int32', - 'int16', - 'uint32', - 'bool' - ]; - expected = [ - 'float16', - 'float32', - 'float32', - 'float64', - 'int32', - 'generic', - 'complex64', - 'uint32', - 'float64' - ]; - - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], 'accumulation' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves a casting data type (policy=)', function test( t ) { - var expected; - var dt1; - var dt2; - var dt3; - var dt; - var i; - - dt1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt2 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - dt3 = [ - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'float64', - 'int8' - ]; - - expected = dt3; - for ( i = 0; i < dt1.length; i++ ) { - dt = resolve( dt1[ i ], dt2[ i ], dt3[ i ], dt3[ i ] ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -});