diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 45e49b8..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-05-26T00:56:35.218Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 29dec20..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/output-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 214eb95..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/output-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 b2dbcaf..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: '24 0 * * 3' - - # 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 + + ```
@@ -190,7 +181,7 @@ logEachMap( 'dtypes: (%15s). policy: %-24s. output dtype: %s.', args[ 0 ], args[ ## 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]. @@ -253,11 +244,11 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-output-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/output-dtype-policies]: https://github.com/stdlib-js/ndarray-output-dtype-policies +[@stdlib/ndarray/output-dtype-policies]: https://github.com/stdlib-js/ndarray-output-dtype-policies/tree/esm -[@stdlib/ndarray/promotion-rules]: https://github.com/stdlib-js/ndarray-promotion-rules +[@stdlib/ndarray/promotion-rules]: https://github.com/stdlib-js/ndarray-promotion-rules/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 712e5c7..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,287 +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=default', function benchmark( b ) { - var out; - var dt; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt = DTYPES[ i%DTYPES.length ]; - out = resolve( [ dt, dt ], 'default' ); - 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=same', function benchmark( b ) { - var out; - var dt; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt = DTYPES[ i%DTYPES.length ]; - out = resolve( [ dt, dt ], 'same' ); - 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 dt; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt = DTYPES[ i%DTYPES.length ]; - out = resolve( [ dt, dt ], '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=real', function benchmark( b ) { - var out; - var dt; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt = DTYPES[ i%DTYPES.length ]; - out = resolve( [ dt, dt ], 'real' ); - 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=floating_point', function benchmark( b ) { - var out; - var dt; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt = DTYPES[ i%DTYPES.length ]; - out = resolve( [ dt, dt ], 'floating_point' ); - 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=real_floating_point', function benchmark( b ) { - var out; - var dt; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt = DTYPES[ i%DTYPES.length ]; - out = resolve( [ dt, dt ], 'real_floating_point' ); - 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=complex_floating_point', function benchmark( b ) { - var out; - var dt; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt = DTYPES[ i%DTYPES.length ]; - out = resolve( [ dt, dt ], 'complex_floating_point' ); - 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=integer', function benchmark( b ) { - var out; - var dt; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt = DTYPES[ i%DTYPES.length ]; - out = resolve( [ dt, dt ], 'integer' ); - 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=signed_integer', function benchmark( b ) { - var out; - var dt; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt = DTYPES[ i%DTYPES.length ]; - out = resolve( [ dt, dt ], 'signed_integer' ); - 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=unsigned_integer', function benchmark( b ) { - var out; - var dt; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt = DTYPES[ i%DTYPES.length ]; - out = resolve( [ dt, dt ], 'unsigned_integer' ); - 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=numeric', function benchmark( b ) { - var out; - var dt; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt = DTYPES[ i%DTYPES.length ]; - out = resolve( [ dt, dt ], 'numeric' ); - 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 dt; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - dt = DTYPES[ i%DTYPES.length ]; - out = resolve( [ dt, dt ], '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 f924107..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/output-dtype" -%% click B href "https://github.com/stdlib-js/ndarray-base-output-dtype/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-base-output-dtype/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-base-output-dtype/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-base-output-dtype/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-base-output-dtype/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/output-dtype -[production-url]: https://github.com/stdlib-js/ndarray-base-output-dtype/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-base-output-dtype/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-base-output-dtype/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-base-output-dtype/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-base-output-dtype/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-base-output-dtype/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-base-output-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 e66b43c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var L=function(n,e){return function(){return e||n((e={exports:{}}).exports,e),e.exports}};var b=L(function(S,P){ -var o=require('@stdlib/ndarray-base-assert-is-floating-point-data-type/dist'),c=require('@stdlib/ndarray-base-assert-is-real-floating-point-data-type/dist'),f=require('@stdlib/ndarray-base-assert-is-complex-floating-point-data-type/dist'),v=require('@stdlib/ndarray-base-assert-is-integer-data-type/dist'),d=require('@stdlib/ndarray-base-assert-is-signed-integer-data-type/dist'),g=require('@stdlib/ndarray-base-assert-is-unsigned-integer-data-type/dist'),T=require('@stdlib/ndarray-base-assert-is-real-data-type/dist'),m=require('@stdlib/ndarray-base-assert-is-numeric-data-type/dist'),D=require('@stdlib/ndarray-base-assert-is-boolean-data-type/dist'),x=require('@stdlib/ndarray-base-assert-is-integer-index-data-type/dist'),E=require('@stdlib/ndarray-base-assert-is-boolean-index-data-type/dist'),q=require('@stdlib/ndarray-base-assert-is-mask-index-data-type/dist'),h=require('@stdlib/ndarray-base-assert-is-data-type/dist'),_=require('@stdlib/ndarray-base-promote-dtypes/dist'),t=require('@stdlib/ndarray-defaults/dist'),I=require('@stdlib/array-base-join/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist'),w=t.get("dtypes.default"),A=t.get("dtypes.default_index"),u=t.get("dtypes.signed_integer"),p=t.get("dtypes.unsigned_integer"),s=t.get("dtypes.real_floating_point"),F={default:U,default_index:Y,same:k,promoted:y,accumulation:G},N={floating_point:[o,t.get("dtypes.floating_point")],floating_point_and_generic:[r(o),t.get("dtypes.floating_point")],real_floating_point:[c,s],real_floating_point_and_generic:[r(c),s],complex_floating_point:[f,t.get("dtypes.complex_floating_point")],complex_floating_point_and_generic:[r(f),t.get("dtypes.complex_floating_point")],integer:[v,t.get("dtypes.integer")],integer_and_generic:[r(v),t.get("dtypes.integer")],signed_integer:[d,u],signed_integer_and_generic:[r(d),u],unsigned_integer:[g,p],unsigned_integer_and_generic:[r(g),p],real:[T,t.get("dtypes.real")],real_and_generic:[r(T),t.get("dtypes.real")],numeric:[m,t.get("dtypes.numeric")],numeric_and_generic:[r(m),t.get("dtypes.numeric")],boolean:[D,t.get("dtypes.boolean")],boolean_and_generic:[r(D),t.get("dtypes.boolean")],integer_index:[x,t.get("dtypes.integer_index")],integer_index_and_generic:[r(x),t.get("dtypes.integer_index")],boolean_index:[E,t.get("dtypes.boolean_index")],boolean_index_and_generic:[r(E),t.get("dtypes.boolean_index")],mask_index:[q,t.get("dtypes.mask_index")],mask_index_and_generic:[r(q),t.get("dtypes.mask_index")]};function r(n){return e;function e(a){return a==="generic"||n(a)}}function U(){return w}function Y(){return A}function k(n){var e,a;for(e=n[0],a=1;a\n*/\nfunction resolve( dtypes, policy ) {\n\tvar dt;\n\tvar p;\n\n\t// First, check whether the policy mandates that the output data type always be a specific data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\t// Next, check whether the policy is one in which we may be able to avoid type promotion...\n\tp = POLICY_TABLE1[ policy ];\n\tif ( p !== void 0 ) {\n\t\treturn p( dtypes );\n\t}\n\t// For all other policies, we always apply type promotion rules...\n\tdt = promotedPolicy( dtypes );\n\n\t// Check whether the policy requires determining the data type \"kind\"...\n\tp = POLICY_TABLE2[ policy ];\n\tif ( p !== void 0 ) {\n\t\t// Check whether the promoted data type belongs to the data type \"kind\"...\n\t\tif ( p[ 0 ]( dt ) ) {\n\t\t\t// If so, we can just return the promoted data type:\n\t\t\treturn dt;\n\t\t}\n\t\t// Otherwise, we need to fallback to a default data type belonging to that \"kind\":\n\t\treturn p[ 1 ];\n\t}\n\tthrow new TypeError( format( 'invalid argument. Second argument must be a supported data type 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 output data type from a list of input ndarray data types.\n*\n* @module @stdlib/ndarray-base-output-dtype\n*\n* @example\n* var resolve = require( '@stdlib/ndarray-base-output-dtype' );\n*\n* var dt = resolve( [ 'float64' ], 'complex_floating_point' );\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,EAA8B,QAAS,8DAA+D,EACtGC,EAAiC,QAAS,iEAAkE,EAC5GC,EAAoB,QAAS,kDAAmD,EAChFC,EAA0B,QAAS,yDAA0D,EAC7FC,EAA4B,QAAS,2DAA4D,EACjGC,EAAiB,QAAS,+CAAgD,EAC1EC,EAAoB,QAAS,kDAAmD,EAChFC,EAAoB,QAAS,kDAAmD,EAChFC,EAAyB,QAAS,wDAAyD,EAC3FC,EAAyB,QAAS,wDAAyD,EAC3FC,EAAsB,QAAS,qDAAsD,EACrFC,EAAa,QAAS,0CAA2C,EACjEC,EAAmB,QAAS,qCAAsC,EAClEC,EAAW,QAAS,0BAA2B,EAC/CC,EAAO,QAAS,yBAA0B,EAC1CC,EAAS,QAAS,uBAAwB,EAK1CC,EAAgBH,EAAS,IAAK,gBAAiB,EAC/CI,EAAsBJ,EAAS,IAAK,sBAAuB,EAC3DK,EAA+BL,EAAS,IAAK,uBAAwB,EACrEM,EAAiCN,EAAS,IAAK,yBAA0B,EACzEO,EAAoCP,EAAS,IAAK,4BAA6B,EAG/EQ,EAAgB,CACnB,QAAWC,EACX,cAAiBC,EACjB,KAAQC,EACR,SAAYC,EACZ,aAAgBC,CACjB,EAGIC,EAAgB,CAEnB,eAAkB,CACjB5B,EACAc,EAAS,IAAK,uBAAwB,CACvC,EACA,2BAA8B,CAC7Be,EAAM7B,CAAwB,EAC9Bc,EAAS,IAAK,uBAAwB,CACvC,EACA,oBAAuB,CACtBb,EACAoB,CACD,EACA,gCAAmC,CAClCQ,EAAM5B,CAA4B,EAClCoB,CACD,EACA,uBAA0B,CACzBnB,EACAY,EAAS,IAAK,+BAAgC,CAC/C,EACA,mCAAsC,CACrCe,EAAM3B,CAA+B,EACrCY,EAAS,IAAK,+BAAgC,CAC/C,EAGA,QAAW,CACVX,EACAW,EAAS,IAAK,gBAAiB,CAChC,EACA,oBAAuB,CACtBe,EAAM1B,CAAkB,EACxBW,EAAS,IAAK,gBAAiB,CAChC,EACA,eAAkB,CACjBV,EACAe,CACD,EACA,2BAA8B,CAC7BU,EAAMzB,CAAwB,EAC9Be,CACD,EACA,iBAAoB,CACnBd,EACAe,CACD,EACA,6BAAgC,CAC/BS,EAAMxB,CAA0B,EAChCe,CACD,EAGA,KAAQ,CACPd,EACAQ,EAAS,IAAK,aAAc,CAC7B,EACA,iBAAoB,CACnBe,EAAMvB,CAAe,EACrBQ,EAAS,IAAK,aAAc,CAC7B,EAGA,QAAW,CACVP,EACAO,EAAS,IAAK,gBAAiB,CAChC,EACA,oBAAuB,CACtBe,EAAMtB,CAAkB,EACxBO,EAAS,IAAK,gBAAiB,CAChC,EAGA,QAAW,CACVN,EACAM,EAAS,IAAK,gBAAiB,CAChC,EACA,oBAAuB,CACtBe,EAAMrB,CAAkB,EACxBM,EAAS,IAAK,gBAAiB,CAChC,EAGA,cAAiB,CAChBL,EACAK,EAAS,IAAK,sBAAuB,CACtC,EACA,0BAA6B,CAC5Be,EAAMpB,CAAuB,EAC7BK,EAAS,IAAK,sBAAuB,CACtC,EACA,cAAiB,CAChBJ,EACAI,EAAS,IAAK,sBAAuB,CACtC,EACA,0BAA6B,CAC5Be,EAAMnB,CAAuB,EAC7BI,EAAS,IAAK,sBAAuB,CACtC,EACA,WAAc,CACbH,EACAG,EAAS,IAAK,mBAAoB,CACnC,EACA,uBAA0B,CACzBe,EAAMlB,CAAoB,EAC1BG,EAAS,IAAK,mBAAoB,CACnC,CACD,EAYA,SAASe,EAAMC,EAAM,CACpB,OAAOC,EASP,SAASA,EAASC,EAAQ,CACzB,OAASA,IAAU,WAAeF,EAAKE,CAAM,CAC9C,CACD,CAQA,SAAST,GAAgB,CAExB,OAAON,CACR,CAQA,SAASO,GAAqB,CAE7B,OAAON,CACR,CAUA,SAASO,EAAYQ,EAAS,CAC7B,IAAIC,EACAC,EAGJ,IADAD,EAAKD,EAAQ,CAAE,EACTE,EAAI,EAAGA,EAAIF,EAAO,OAAQE,IAE/B,GAAKF,EAAQE,CAAE,IAAMD,EACpB,MAAM,IAAI,MAAOlB,EAAQ,+JAAgKD,EAAMkB,EAAQ,IAAK,CAAE,CAAE,EAGlN,OAAOC,CACR,CAUA,SAASR,EAAgBO,EAAS,CACjC,IAAIC,EAAKrB,EAAkBoB,CAAO,EAClC,GAAKC,IAAO,KACX,MAAM,IAAI,MAAOlB,EAAQ,wJAAyJD,EAAMkB,EAAQ,IAAK,CAAE,CAAE,EAE1M,OAAOC,CACR,CAUA,SAASP,EAAoBM,EAAS,CACrC,IAAIC,EAAKR,EAAgBO,CAAO,EAGhC,OAAKjC,EAAyBkC,CAAG,GAAKA,IAAO,UACrCA,EAGH7B,EAA2B6B,CAAG,EAC3BrB,EAAkB,CAAEqB,EAAId,CAA+B,CAAE,EAE5DhB,EAAyB8B,CAAG,EACzBrB,EAAkB,CAAEqB,EAAIf,CAA6B,CAAE,EAGxDE,CACR,CAkBA,SAASe,EAASH,EAAQI,EAAS,CAClC,IAAIH,EACAI,EAGJ,GAAK1B,EAAYyB,CAAO,EACvB,OAAOA,EAIR,GADAC,EAAIhB,EAAee,CAAO,EACrBC,IAAM,OACV,OAAOA,EAAGL,CAAO,EAOlB,GAJAC,EAAKR,EAAgBO,CAAO,EAG5BK,EAAIV,EAAeS,CAAO,EACrBC,IAAM,OAEV,OAAKA,EAAG,CAAE,EAAGJ,CAAG,EAERA,EAGDI,EAAG,CAAE,EAEb,MAAM,IAAI,UAAWtB,EAAQ,uFAAwFqB,CAAO,CAAE,CAC/H,CAKAtC,EAAO,QAAUqC,ICzSjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "isFloatingPointDataType", "isRealFloatingPointDataType", "isComplexFloatingPointDataType", "isIntegerDataType", "isSignedIntegerDataType", "isUnsignedIntegerDataType", "isRealDataType", "isNumericDataType", "isBooleanDataType", "isIntegerIndexDataType", "isBooleanIndexDataType", "isMaskIndexDataType", "isDataType", "promoteDataTypes", "defaults", "join", "format", "DEFAULT_DTYPE", "DEFAULT_INDEX_DTYPE", "DEFAULT_SIGNED_INTEGER_DTYPE", "DEFAULT_UNSIGNED_INTEGER_DTYPE", "DEFAULT_REAL_FLOATING_POINT_DTYPE", "POLICY_TABLE1", "defaultPolicy", "defaultIndexPolicy", "samePolicy", "promotedPolicy", "accumulationPolicy", "POLICY_TABLE2", "wrap", "fcn", "wrapper", "value", "dtypes", "dt", "i", "resolve", "policy", "p", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8500bf0..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,26 +0,0 @@ - -{{alias}}( dtypes, policy ) - Resolves the output data type from a list of input ndarray data types. - - Parameters - ---------- - dtypes: Array - Input ndarray data types. - - policy: string - Output ndarray data type policy. If `policy` is a data type, the - function returns the `policy` value. - - Returns - ------- - out: string - Output ndarray data type. - - Examples - -------- - > var out = {{alias}}( [ 'float64' ], 'real' ) - 'float64' - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index d7a325b..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,57 +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 outputDataType = require( './index' ); - - -// TESTS // - -// The function returns a data type... -{ - outputDataType( [ 'float64' ], 'real' ); // $ExpectType DataType -} - -// The compiler throws an error if not provided a first argument which is an array of data types... -{ - outputDataType( '10', 'real' ); // $ExpectError - outputDataType( true, 'real' ); // $ExpectError - outputDataType( false, 'real' ); // $ExpectError - outputDataType( null, 'real' ); // $ExpectError - outputDataType( undefined, 'real' ); // $ExpectError - outputDataType( [ 'foo' ], 'real' ); // $ExpectError - outputDataType( {}, 'real' ); // $ExpectError - outputDataType( ( x: number ): number => x, 'real' ); // $ExpectError -} - -// The compiler throws an error if not provided a second argument which is either a data type or data type policy... -{ - outputDataType( [ 'float64' ], '10' ); // $ExpectError - outputDataType( [ 'float64' ], true ); // $ExpectError - outputDataType( [ 'float64' ], false ); // $ExpectError - outputDataType( [ 'float64' ], null ); // $ExpectError - outputDataType( [ 'float64' ], undefined ); // $ExpectError - outputDataType( [ 'float64' ], [] ); // $ExpectError - outputDataType( [ 'float64' ], {} ); // $ExpectError - outputDataType( [ 'float64' ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - outputDataType(); // $ExpectError - outputDataType( [ 'float64' ], 'real', 'foo' ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index e6afc50..0000000 --- a/examples/index.js +++ /dev/null @@ -1,50 +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 cartesianProduct = require( '@stdlib/array-base-cartesian-product' ); -var dtypes = require( '@stdlib/ndarray-dtypes' ); -var logEachMap = require( '@stdlib/console-log-each-map' ); -var outputDataType = require( './../lib' ); - -// Get the list of real-valued data types: -var dt = dtypes( 'real' ); - -// Define a list of output data type policies: -var policies = [ - 'default', - 'real', - 'floating_point', - 'complex_floating_point', - 'promoted' -]; - -// Generate data type pairs: -var pairs = cartesianProduct( dt, dt ); - -// Generate argument pairs: -var args = cartesianProduct( pairs, policies ); - -// Unzip the argument pair array: -args = unzip( args ); - -// Resolve output data types: -logEachMap( 'dtypes: (%15s). policy: %-24s. output dtype: %s.', args[ 0 ], args[ 1 ], naryFunction( outputDataType, 2 ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 93% rename from docs/types/index.d.ts rename to index.d.ts index 8d9f2a9..cdda113 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { ArrayLike } from '@stdlib/types/array'; import { DataType, OutputPolicy } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d8c909e --- /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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-floating-point-data-type@v0.2.2-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-real-floating-point-data-type@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-complex-floating-point-data-type@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-integer-data-type@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-signed-integer-data-type@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-unsigned-integer-data-type@v0.2.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-real-data-type@v0.2.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-numeric-data-type@v0.2.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-boolean-data-type@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-integer-index-data-type@esm/index.mjs";import g from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-boolean-index-data-type@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-mask-index-data-type@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-data-type@v0.2.2-esm/index.mjs";import y from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-promote-dtypes@esm/index.mjs";import _ from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-defaults@v0.3.0-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-join@v0.1.1-esm/index.mjs";import c from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";var j=_.get("dtypes.default"),u=_.get("dtypes.default_index"),b=_.get("dtypes.signed_integer"),h=_.get("dtypes.unsigned_integer"),v=_.get("dtypes.real_floating_point"),x={default:function(){return j},default_index:function(){return u},same:function(e){var t,n;for(t=e[0],n=1;n\n*/\nfunction resolve( dtypes, policy ) {\n\tvar dt;\n\tvar p;\n\n\t// First, check whether the policy mandates that the output data type always be a specific data type...\n\tif ( isDataType( policy ) ) {\n\t\treturn policy;\n\t}\n\t// Next, check whether the policy is one in which we may be able to avoid type promotion...\n\tp = POLICY_TABLE1[ policy ];\n\tif ( p !== void 0 ) {\n\t\treturn p( dtypes );\n\t}\n\t// For all other policies, we always apply type promotion rules...\n\tdt = promotedPolicy( dtypes );\n\n\t// Check whether the policy requires determining the data type \"kind\"...\n\tp = POLICY_TABLE2[ policy ];\n\tif ( p !== void 0 ) {\n\t\t// Check whether the promoted data type belongs to the data type \"kind\"...\n\t\tif ( p[ 0 ]( dt ) ) {\n\t\t\t// If so, we can just return the promoted data type:\n\t\t\treturn dt;\n\t\t}\n\t\t// Otherwise, we need to fallback to a default data type belonging to that \"kind\":\n\t\treturn p[ 1 ];\n\t}\n\tthrow new TypeError( format( 'nullDw', policy ) );\n}\n\n\n// EXPORTS //\n\nexport default resolve;\n"],"names":["DEFAULT_DTYPE","defaults","get","DEFAULT_INDEX_DTYPE","DEFAULT_SIGNED_INTEGER_DTYPE","DEFAULT_UNSIGNED_INTEGER_DTYPE","DEFAULT_REAL_FLOATING_POINT_DTYPE","POLICY_TABLE1","default","default_index","same","dtypes","dt","i","length","Error","format","join","promoted","promotedPolicy","accumulation","isFloatingPointDataType","isUnsignedIntegerDataType","promoteDataTypes","isSignedIntegerDataType","POLICY_TABLE2","floating_point","floating_point_and_generic","wrap","real_floating_point","isRealFloatingPointDataType","real_floating_point_and_generic","complex_floating_point","isComplexFloatingPointDataType","complex_floating_point_and_generic","integer","isIntegerDataType","integer_and_generic","signed_integer","signed_integer_and_generic","unsigned_integer","unsigned_integer_and_generic","real","isRealDataType","real_and_generic","numeric","isNumericDataType","numeric_and_generic","boolean","isBooleanDataType","boolean_and_generic","integer_index","isIntegerIndexDataType","integer_index_and_generic","boolean_index","isBooleanIndexDataType","boolean_index_and_generic","mask_index","isMaskIndexDataType","mask_index_and_generic","fcn","value","resolve","policy","p","isDataType","TypeError"],"mappings":";;62DA6CA,IAAIA,EAAgBC,EAASC,IAAK,kBAC9BC,EAAsBF,EAASC,IAAK,wBACpCE,EAA+BH,EAASC,IAAK,yBAC7CG,EAAiCJ,EAASC,IAAK,2BAC/CI,EAAoCL,EAASC,IAAK,8BAGlDK,EAAgB,CACnBC,QAqJD,WAEC,OAAOR,CACR,EAvJCS,cA+JD,WAEC,OAAON,CACR,EAjKCO,KA2KD,SAAqBC,GACpB,IAAIC,EACAC,EAGJ,IADAD,EAAKD,EAAQ,GACPE,EAAI,EAAGA,EAAIF,EAAOG,OAAQD,IAE/B,GAAKF,EAAQE,KAAQD,EACpB,MAAM,IAAIG,MAAOC,EAAQ,+JAAgKC,EAAMN,EAAQ,QAGzM,OAAOC,CACR,EAtLCM,SAAYC,EACZC,aA+MD,SAA6BT,GAC5B,IAAIC,EAAKO,EAAgBR,GAGzB,GAAKU,EAAyBT,IAAe,YAAPA,EACrC,OAAOA,EAGR,GAAKU,EAA2BV,GAC/B,OAAOW,EAAkB,CAAEX,EAAIP,IAEhC,GAAKmB,EAAyBZ,GAC7B,OAAOW,EAAkB,CAAEX,EAAIR,IAGhC,OAAOE,CACR,GA3NImB,EAAgB,CAEnBC,eAAkB,CACjBL,EACApB,EAASC,IAAK,0BAEfyB,2BAA8B,CAC7BC,EAAMP,GACNpB,EAASC,IAAK,0BAEf2B,oBAAuB,CACtBC,EACAxB,GAEDyB,gCAAmC,CAClCH,EAAME,GACNxB,GAED0B,uBAA0B,CACzBC,EACAhC,EAASC,IAAK,kCAEfgC,mCAAsC,CACrCN,EAAMK,GACNhC,EAASC,IAAK,kCAIfiC,QAAW,CACVC,EACAnC,EAASC,IAAK,mBAEfmC,oBAAuB,CACtBT,EAAMQ,GACNnC,EAASC,IAAK,mBAEfoC,eAAkB,CACjBd,EACApB,GAEDmC,2BAA8B,CAC7BX,EAAMJ,GACNpB,GAEDoC,iBAAoB,CACnBlB,EACAjB,GAEDoC,6BAAgC,CAC/Bb,EAAMN,GACNjB,GAIDqC,KAAQ,CACPC,EACA1C,EAASC,IAAK,gBAEf0C,iBAAoB,CACnBhB,EAAMe,GACN1C,EAASC,IAAK,gBAIf2C,QAAW,CACVC,EACA7C,EAASC,IAAK,mBAEf6C,oBAAuB,CACtBnB,EAAMkB,GACN7C,EAASC,IAAK,mBAIf8C,QAAW,CACVC,EACAhD,EAASC,IAAK,mBAEfgD,oBAAuB,CACtBtB,EAAMqB,GACNhD,EAASC,IAAK,mBAIfiD,cAAiB,CAChBC,EACAnD,EAASC,IAAK,yBAEfmD,0BAA6B,CAC5BzB,EAAMwB,GACNnD,EAASC,IAAK,yBAEfoD,cAAiB,CAChBC,EACAtD,EAASC,IAAK,yBAEfsD,0BAA6B,CAC5B5B,EAAM2B,GACNtD,EAASC,IAAK,yBAEfuD,WAAc,CACbC,EACAzD,EAASC,IAAK,sBAEfyD,uBAA0B,CACzB/B,EAAM8B,GACNzD,EAASC,IAAK,uBAchB,SAAS0B,EAAMgC,GACd,OASA,SAAkBC,GACjB,MAAmB,YAAVA,GAAyBD,EAAKC,EACvC,CACF,CAsDA,SAAS1C,EAAgBR,GACxB,IAAIC,EAAKW,EAAkBZ,GAC3B,GAAY,OAAPC,EACJ,MAAM,IAAIG,MAAOC,EAAQ,wJAAyJC,EAAMN,EAAQ,QAEjM,OAAOC,CACR,CA4CA,SAASkD,EAASnD,EAAQoD,GACzB,IAAInD,EACAoD,EAGJ,GAAKC,EAAYF,GAChB,OAAOA,EAIR,QAAW,KADXC,EAAIzD,EAAewD,IAElB,OAAOC,EAAGrD,GAOX,GAJAC,EAAKO,EAAgBR,QAIV,KADXqD,EAAIvC,EAAesC,IAGlB,OAAKC,EAAG,GAAKpD,GAELA,EAGDoD,EAAG,GAEX,MAAM,IAAIE,UAAWlD,EAAQ,SAAU+C,GACxC"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4180f6e..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 output data type from a list of input ndarray data types. -* -* @module @stdlib/ndarray-base-output-dtype -* -* @example -* var resolve = require( '@stdlib/ndarray-base-output-dtype' ); -* -* var dt = resolve( [ 'float64' ], 'complex_floating_point' ); -* // 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 3336b9d..0000000 --- a/lib/main.js +++ /dev/null @@ -1,332 +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 */ - -'use strict'; - -// MODULES // - -var isFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-floating-point-data-type' ); -var isRealFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-real-floating-point-data-type' ); -var isComplexFloatingPointDataType = require( '@stdlib/ndarray-base-assert-is-complex-floating-point-data-type' ); -var isIntegerDataType = require( '@stdlib/ndarray-base-assert-is-integer-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 isRealDataType = require( '@stdlib/ndarray-base-assert-is-real-data-type' ); -var isNumericDataType = require( '@stdlib/ndarray-base-assert-is-numeric-data-type' ); -var isBooleanDataType = require( '@stdlib/ndarray-base-assert-is-boolean-data-type' ); -var isIntegerIndexDataType = require( '@stdlib/ndarray-base-assert-is-integer-index-data-type' ); -var isBooleanIndexDataType = require( '@stdlib/ndarray-base-assert-is-boolean-index-data-type' ); -var isMaskIndexDataType = require( '@stdlib/ndarray-base-assert-is-mask-index-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/string-format' ); - - -// VARIABLES // - -var DEFAULT_DTYPE = defaults.get( 'dtypes.default' ); -var DEFAULT_INDEX_DTYPE = defaults.get( 'dtypes.default_index' ); -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' ); - -// Table where, for each respective policy, the value is a function which applies the policy to an input data type... -var POLICY_TABLE1 = { - 'default': defaultPolicy, - 'default_index': defaultIndexPolicy, - 'same': samePolicy, - 'promoted': promotedPolicy, - 'accumulation': accumulationPolicy -}; - -// Table where, for each respective policy, the value is an array whose first element is an assertion and whose second element is a fallback data type... -var POLICY_TABLE2 = { - // Floating-point policies... - 'floating_point': [ - isFloatingPointDataType, - defaults.get( 'dtypes.floating_point' ) - ], - 'floating_point_and_generic': [ - wrap( isFloatingPointDataType ), - defaults.get( 'dtypes.floating_point' ) - ], - 'real_floating_point': [ - isRealFloatingPointDataType, - DEFAULT_REAL_FLOATING_POINT_DTYPE - ], - 'real_floating_point_and_generic': [ - wrap( isRealFloatingPointDataType ), - DEFAULT_REAL_FLOATING_POINT_DTYPE - ], - 'complex_floating_point': [ - isComplexFloatingPointDataType, - defaults.get( 'dtypes.complex_floating_point' ) - ], - 'complex_floating_point_and_generic': [ - wrap( isComplexFloatingPointDataType ), - defaults.get( 'dtypes.complex_floating_point' ) - ], - - // Integer policies... - 'integer': [ - isIntegerDataType, - defaults.get( 'dtypes.integer' ) - ], - 'integer_and_generic': [ - wrap( isIntegerDataType ), - defaults.get( 'dtypes.integer' ) - ], - 'signed_integer': [ - isSignedIntegerDataType, - DEFAULT_SIGNED_INTEGER_DTYPE - ], - 'signed_integer_and_generic': [ - wrap( isSignedIntegerDataType ), - DEFAULT_SIGNED_INTEGER_DTYPE - ], - 'unsigned_integer': [ - isUnsignedIntegerDataType, - DEFAULT_UNSIGNED_INTEGER_DTYPE - ], - 'unsigned_integer_and_generic': [ - wrap( isUnsignedIntegerDataType ), - DEFAULT_UNSIGNED_INTEGER_DTYPE - ], - - // Real-valued number policies... - 'real': [ - isRealDataType, - defaults.get( 'dtypes.real' ) - ], - 'real_and_generic': [ - wrap( isRealDataType ), - defaults.get( 'dtypes.real' ) - ], - - // Real- and complex-valued number policies... - 'numeric': [ - isNumericDataType, - defaults.get( 'dtypes.numeric' ) - ], - 'numeric_and_generic': [ - wrap( isNumericDataType ), - defaults.get( 'dtypes.numeric' ) - ], - - // Boolean policies... - 'boolean': [ - isBooleanDataType, - defaults.get( 'dtypes.boolean' ) - ], - 'boolean_and_generic': [ - wrap( isBooleanDataType ), - defaults.get( 'dtypes.boolean' ) - ], - - // Index policies... - 'integer_index': [ - isIntegerIndexDataType, - defaults.get( 'dtypes.integer_index' ) - ], - 'integer_index_and_generic': [ - wrap( isIntegerIndexDataType ), - defaults.get( 'dtypes.integer_index' ) - ], - 'boolean_index': [ - isBooleanIndexDataType, - defaults.get( 'dtypes.boolean_index' ) - ], - 'boolean_index_and_generic': [ - wrap( isBooleanIndexDataType ), - defaults.get( 'dtypes.boolean_index' ) - ], - 'mask_index': [ - isMaskIndexDataType, - defaults.get( 'dtypes.mask_index' ) - ], - 'mask_index_and_generic': [ - wrap( isMaskIndexDataType ), - defaults.get( 'dtypes.mask_index' ) - ] -}; - - -// FUNCTIONS // - -/** -* Wraps a data type validation function to also check for a "generic" data type. -* -* @private -* @param {Function} fcn - validation function -* @returns {Function} wrapped validation function -*/ -function wrap( fcn ) { - return wrapper; - - /** - * Tests whether a provided data type is either "generic" or satisfies a data type validation function. - * - * @private - * @param {*} value - input value - * @returns {boolean} boolean indicating whether a provided value passes a test - */ - function wrapper( value ) { - return ( value === 'generic' ) || fcn( value ); - } -} - -/** -* Returns the default data type. -* -* @private -* @returns {string} output ndarray data type -*/ -function defaultPolicy() { - // When the policy is "default", the output data type should always be the default data type without consideration for the input data types: - return DEFAULT_DTYPE; -} - -/** -* Returns the default index data type. -* -* @private -* @returns {string} output ndarray data type -*/ -function defaultIndexPolicy() { - // When the policy is "default_index", the output data type should always be the default index data type without consideration for the input data types: - return DEFAULT_INDEX_DTYPE; -} - -/** -* Applies the "same" policy by returning the common input data type. -* -* @private -* @param {StringArray} dtypes - input ndarray data types -* @throws {Error} invalid data types -* @returns {string} output ndarray data type -*/ -function samePolicy( dtypes ) { - var dt; - var i; - - dt = dtypes[ 0 ]; - for ( i = 1; i < dtypes.length; i++ ) { - // When the policy is "same", we require that all data types (both input and output) be the same... - if ( dtypes[ i ] !== dt ) { - throw new Error( format( 'invalid argument. Unable to resolve an output data type. The output data type policy is "same" and yet the input data types are not equal. Data types: [%s].', join( dtypes, ', ' ) ) ); - } - } - return dt; -} - -/** -* Applies the "promoted" policy by applying type promotion to the list of provided data types. -* -* @private -* @param {StringArray} dtypes - input ndarray data types -* @throws {Error} must provide data types which can be safely cast to a common data type -* @returns {string} output ndarray data type -*/ -function promotedPolicy( dtypes ) { - var dt = promoteDataTypes( dtypes ); - if ( dt === null ) { - throw new Error( format( 'invalid argument. Unable to apply type promotion rules when resolving a data type to which the input data types can be safely cast. Data types: [%s].', join( dtypes, ', ' ) ) ); - } - return dt; -} - -/** -* Applies the "accumulation" policy to the list of input data types. -* -* @private -* @param {StringArray} dtypes - input ndarray data types -* @throws {Error} must provide data types which can be safely cast to a common data type -* @returns {string} output ndarray data type -*/ -function accumulationPolicy( dtypes ) { - var dt = promotedPolicy( dtypes ); - - // If the promoted 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( dt ) || dt === 'generic' ) { // NOTE: we may want to revisit this in the future for float16/complex32, where the value range is much more limited - return dt; - } - // Unless the promoted 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 small range integer data types (e.g., `int8`) is at high risk for overflow, especially for ndarrays containing many elements... - if ( isUnsignedIntegerDataType( dt ) ) { - return promoteDataTypes( [ dt, DEFAULT_UNSIGNED_INTEGER_DTYPE ] ); - } - if ( isSignedIntegerDataType( dt ) ) { - return promoteDataTypes( [ dt, DEFAULT_SIGNED_INTEGER_DTYPE ] ); - } - // For all other data types, accumulate in the default real-valued floating-point data type... - return DEFAULT_REAL_FLOATING_POINT_DTYPE; -} - - -// MAIN // - -/** -* Resolves the output data type from a list of input ndarray data types. -* -* @param {StringArray} dtypes - list of input ndarray data types -* @param {string} policy - output ndarray data type policy -* @throws {TypeError} second argument must be a recognized data type policy -* @throws {Error} unexpected error -* @returns {string} output ndarray data type -* -* @example -* var dt = resolve( [ 'float64' ], 'complex_floating_point' ); -* // returns -*/ -function resolve( dtypes, policy ) { - var dt; - var p; - - // First, check whether the policy mandates that the output data type always be a specific data type... - if ( isDataType( policy ) ) { - return policy; - } - // Next, check whether the policy is one in which we may be able to avoid type promotion... - p = POLICY_TABLE1[ policy ]; - if ( p !== void 0 ) { - return p( dtypes ); - } - // For all other policies, we always apply type promotion rules... - dt = promotedPolicy( dtypes ); - - // Check whether the policy requires determining the data type "kind"... - p = POLICY_TABLE2[ policy ]; - if ( p !== void 0 ) { - // Check whether the promoted data type belongs to the data type "kind"... - if ( p[ 0 ]( dt ) ) { - // If so, we can just return the promoted data type: - return dt; - } - // Otherwise, we need to fallback to a default data type belonging to that "kind": - return p[ 1 ]; - } - throw new TypeError( format( 'invalid argument. Second argument must be a supported data type policy. Value: `%s`.', policy ) ); -} - - -// EXPORTS // - -module.exports = resolve; diff --git a/package.json b/package.json index d17bb8b..d8e4439 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Resolve the output data type from a list of input ndarray data types.", "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,53 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-join": "^0.1.1", - "@stdlib/ndarray-base-assert-is-boolean-data-type": "^0.1.0", - "@stdlib/ndarray-base-assert-is-boolean-index-data-type": "github:stdlib-js/ndarray-base-assert-is-boolean-index-data-type#main", - "@stdlib/ndarray-base-assert-is-complex-floating-point-data-type": "^0.2.2", - "@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-integer-data-type": "^0.2.2", - "@stdlib/ndarray-base-assert-is-integer-index-data-type": "github:stdlib-js/ndarray-base-assert-is-integer-index-data-type#main", - "@stdlib/ndarray-base-assert-is-mask-index-data-type": "github:stdlib-js/ndarray-base-assert-is-mask-index-data-type#main", - "@stdlib/ndarray-base-assert-is-numeric-data-type": "^0.2.2", - "@stdlib/ndarray-base-assert-is-real-data-type": "^0.2.2", - "@stdlib/ndarray-base-assert-is-real-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/string-format": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-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", @@ -101,7 +31,6 @@ "return", "output" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..e297033 --- /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.binary.js b/test/test.binary.js deleted file mode 100644 index 71d32db..0000000 --- a/test/test.binary.js +++ /dev/null @@ -1,1314 +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 defaults = require( '@stdlib/ndarray-defaults' ); -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 data type 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' ], value ); - }; - } -}); - -tape( 'the function throw an error if the data type policy is "same" and the input data types differ', function test( t ) { - var values; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[ i ], values[ (i+1)%values.length ] ), Error, 'throws an error when provided '+values[ i ] ); - } - t.end(); - - function badValue( v1, v2 ) { - return function badValue() { - resolve( [ v1, v2 ], 'same' ); - }; - } -}); - -tape( 'the function throw an error if the data type policy requires type promotion and the input data types do not promote to a common data type (policy=promoted)', function test( t ) { - var values1; - var values2; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'uint8', - 'int8', - 'complex64', - 'foo' - ]; - values2 = [ - 'bool', - 'bool', - 'bool', - 'bool', - 'bool', - 'bool', - 'bool', - 'bar' - ]; - for ( i = 0; i < values1.length; i++ ) { - t.throws( badValue( values1[ i ], values2[ i ] ), Error, 'throws an error when provided '+values1[ i ]+' and '+values2[ i ] ); - } - t.end(); - - function badValue( v1, v2 ) { - return function badValue() { - resolve( [ v1, v2 ], 'promoted' ); - }; - } -}); - -tape( 'the function throw an error if the data type policy requires type promotion and the input data types do not promote to a common data type (policy=floating_point)', function test( t ) { - var values1; - var values2; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'uint8', - 'int8', - 'complex64' - ]; - values2 = [ - 'bool', - 'bool', - 'bool', - 'bool', - 'bool', - 'bool', - 'bool' - ]; - for ( i = 0; i < values1.length; i++ ) { - t.throws( badValue( values1[ i ], values2[ i ] ), Error, 'throws an error when provided '+values1[ i ]+' and '+values2[ i ] ); - } - t.end(); - - function badValue( v1, v2 ) { - return function badValue() { - resolve( [ v1, v2 ], 'floating_point' ); - }; - } -}); - -tape( 'the function throw an error if the data type policy requires type promotion and the input data types do not promote to a common data type (policy=accumulation)', function test( t ) { - var values1; - var values2; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'uint8', - 'int8', - 'complex64' - ]; - values2 = [ - 'bool', - 'bool', - 'bool', - 'bool', - 'bool', - 'bool', - 'bool' - ]; - for ( i = 0; i < values1.length; i++ ) { - t.throws( badValue( values1[ i ], values2[ i ] ), Error, 'throws an error when provided '+values1[ i ]+' and '+values2[ i ] ); - } - t.end(); - - function badValue( v1, v2 ) { - return function badValue() { - resolve( [ v1, v2 ], 'accumulation' ); - }; - } -}); - -tape( 'the function resolves an output data type (policy=boolean)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64', - 'bool' - ]; - - dt = defaults.get( 'dtypes.boolean' ); - expected = [ - dt, - dt, - dt, - dt, - dt, - dt, - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ], values[ i ] ], 'boolean' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=default)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.default' ); - expected = [ - dt, - dt, - dt, - dt, - dt, - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ], values[ i ] ], 'default' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=default_index)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.default_index' ); - expected = [ - dt, - dt, - dt, - dt, - dt, - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ], values[ i ] ], 'default_index' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=same)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - expected = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ], values[ i ] ], 'same' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=promoted)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - expected = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex128' - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'promoted' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - expected = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ], values[ (i+1)%values.length ] ], values[ i ] ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=floating_point)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.floating_point' ); - expected = [ - 'float64', - 'float32', - dt, - dt, - dt, - dt, - 'complex128' - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'floating_point' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=floating_point_and_generic)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64', - 'float32' - ]; - - dt = defaults.get( 'dtypes.floating_point' ); - expected = [ - 'float64', - 'float32', - dt, - dt, - 'generic', - dt, - 'complex128', - 'complex64' - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'floating_point_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=real_floating_point)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.real_floating_point' ); - expected = [ - 'float64', - 'float32', - dt, - dt, - dt, - dt, - dt - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'real_floating_point' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=real_floating_point_and_generic)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.real_floating_point' ); - expected = [ - 'float64', - 'float32', - dt, - dt, - 'generic', - dt, - dt - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'real_floating_point_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=complex_floating_point)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.complex_floating_point' ); - expected = [ - dt, - dt, - dt, - dt, - dt, - dt, - 'complex128' - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'complex_floating_point' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=complex_floating_point_and_generic)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.complex_floating_point' ); - expected = [ - dt, - dt, - dt, - dt, - 'generic', - dt, - 'complex128' - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'complex_floating_point_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=numeric)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.numeric' ); - expected = [ - 'float64', - 'float32', - 'int32', - 'uint16', - dt, - 'int8', - 'complex128' - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'numeric' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=numeric_and_generic)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.numeric' ); - expected = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex128' - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'numeric_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=integer)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.integer' ); - expected = [ - dt, - dt, - 'int32', - 'uint16', - dt, - 'int8', - dt - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'integer' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=integer_and_generic)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.integer' ); - expected = [ - dt, - dt, - 'int32', - 'uint16', - 'generic', - 'int8', - dt - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'integer_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=signed_integer)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.signed_integer' ); - expected = [ - dt, - dt, - 'int32', - dt, - dt, - 'int8', - dt - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'signed_integer' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=signed_integer_and_generic)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.signed_integer' ); - expected = [ - dt, - dt, - 'int32', - dt, - 'generic', - 'int8', - dt - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'signed_integer_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=unsigned_integer)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.unsigned_integer' ); - expected = [ - dt, - dt, - dt, - 'uint16', - dt, - dt, - dt - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'unsigned_integer' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=unsigned_integer_and_generic)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.unsigned_integer' ); - expected = [ - dt, - dt, - dt, - 'uint16', - 'generic', - dt, - dt - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'unsigned_integer_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=integer_index)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.integer_index' ); - expected = [ - dt, - dt, - dt, - dt, - dt, - dt, - dt - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'integer_index' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=integer_index_and_generic)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.integer_index' ); - expected = [ - dt, - dt, - dt, - dt, - 'generic', - dt, - dt - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'integer_index_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=boolean_index)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.boolean_index' ); - expected = [ - dt, - dt, - dt, - dt, - dt, - dt, - dt - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'boolean_index' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=boolean_index_and_generic)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.boolean_index' ); - expected = [ - dt, - dt, - dt, - dt, - 'generic', - dt, - dt - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'boolean_index_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=mask_index)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.mask_index' ); - expected = [ - dt, - dt, - dt, - dt, - dt, - dt, - dt - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'mask_index' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=mask_index_and_generic)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64' - ]; - - dt = defaults.get( 'dtypes.mask_index' ); - expected = [ - dt, - dt, - dt, - dt, - 'generic', - dt, - dt - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'mask_index_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=accumulation)', function test( t ) { - var expected; - var values1; - var values2; - var dt; - var i; - - values1 = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64', - 'bool' - ]; - values2 = [ - 'float32', - 'float32', - 'int8', - 'uint8', - 'float64', - 'int8', - 'float64', - 'bool' - ]; - - dt = defaults.get( 'dtypes.real_floating_point' ); - expected = [ - 'float64', - 'float32', - 'int32', - 'uint32', - 'generic', - 'int32', - 'complex128', - dt - ]; - for ( i = 0; i < values1.length; i++ ) { - dt = resolve( [ values1[ i ], values2[ i ] ], 'accumulation' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); diff --git a/test/test.unary.js b/test/test.unary.js deleted file mode 100644 index d478f4a..0000000 --- a/test/test.unary.js +++ /dev/null @@ -1,958 +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 defaults = require( '@stdlib/ndarray-defaults' ); -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 data type 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' ], value ); - }; - } -}); - -tape( 'the function resolves an output data type (policy=boolean)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64', - 'bool' - ]; - - dt = defaults.get( 'dtypes.boolean' ); - expected = [ - dt, - dt, - dt, - dt, - dt, - dt, - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'boolean' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=default)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.default' ); - expected = [ - dt, - dt, - dt, - dt, - dt, - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'default' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=default_index)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.default_index' ); - expected = [ - dt, - dt, - dt, - dt, - dt, - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'default_index' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=same)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - expected = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'same' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=promoted)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - expected = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'promoted' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - expected = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], values[ i ] ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=floating_point)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.floating_point' ); - expected = [ - 'float64', - 'float32', - dt, - dt, - dt, - dt, - 'complex64' - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'floating_point' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=floating_point_and_generic)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.floating_point' ); - expected = [ - 'float64', - 'float32', - dt, - dt, - 'generic', - dt, - 'complex64' - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'floating_point_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=real_floating_point)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.real_floating_point' ); - expected = [ - 'float64', - 'float32', - dt, - dt, - dt, - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'real_floating_point' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=real_floating_point_and_generic)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.real_floating_point' ); - expected = [ - 'float64', - 'float32', - dt, - dt, - 'generic', - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'real_floating_point_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=complex_floating_point)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.complex_floating_point' ); - expected = [ - dt, - dt, - dt, - dt, - dt, - dt, - 'complex64' - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'complex_floating_point' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=complex_floating_point_and_generic)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.complex_floating_point' ); - expected = [ - dt, - dt, - dt, - dt, - 'generic', - dt, - 'complex64' - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'complex_floating_point_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=numeric)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.numeric' ); - expected = [ - 'float64', - 'float32', - 'int32', - 'uint16', - dt, - 'int8', - 'complex64' - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'numeric' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=numeric_and_generic)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.numeric' ); - expected = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'numeric_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=integer)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.integer' ); - expected = [ - dt, - dt, - 'int32', - 'uint16', - dt, - 'int8', - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'integer' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=integer_and_generic)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.integer' ); - expected = [ - dt, - dt, - 'int32', - 'uint16', - 'generic', - 'int8', - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'integer_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=signed_integer)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.signed_integer' ); - expected = [ - dt, - dt, - 'int32', - dt, - dt, - 'int8', - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'signed_integer' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=signed_integer_and_generic)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.signed_integer' ); - expected = [ - dt, - dt, - 'int32', - dt, - 'generic', - 'int8', - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'signed_integer_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=unsigned_integer)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.unsigned_integer' ); - expected = [ - dt, - dt, - dt, - 'uint16', - dt, - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'unsigned_integer' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=unsigned_integer_and_generic)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.unsigned_integer' ); - expected = [ - dt, - dt, - dt, - 'uint16', - 'generic', - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'unsigned_integer_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=integer_index)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.integer_index' ); - expected = [ - dt, - dt, - dt, - dt, - dt, - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'integer_index' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=integer_index_and_generic)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.integer_index' ); - expected = [ - dt, - dt, - dt, - dt, - 'generic', - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'integer_index_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=boolean_index)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.boolean_index' ); - expected = [ - dt, - dt, - dt, - dt, - dt, - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'boolean_index' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=boolean_index_and_generic)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.boolean_index' ); - expected = [ - dt, - dt, - dt, - dt, - 'generic', - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'boolean_index_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=mask_index)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.mask_index' ); - expected = [ - dt, - dt, - dt, - dt, - dt, - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'mask_index' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=mask_index_and_generic)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64' - ]; - - dt = defaults.get( 'dtypes.mask_index' ); - expected = [ - dt, - dt, - dt, - dt, - 'generic', - dt, - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'mask_index_and_generic' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function resolves an output data type (policy=accumulation)', function test( t ) { - var expected; - var values; - var dt; - var i; - - values = [ - 'float64', - 'float32', - 'int32', - 'uint16', - 'generic', - 'int8', - 'complex64', - 'bool' - ]; - - dt = defaults.get( 'dtypes.real_floating_point' ); - expected = [ - 'float64', - 'float32', - 'int32', - 'uint32', - 'generic', - 'int32', - 'complex64', - dt - ]; - for ( i = 0; i < values.length; i++ ) { - dt = resolve( [ values[ i ] ], 'accumulation' ); - t.strictEqual( dt, expected[ i ], 'returns expected value' ); - } - t.end(); -});