diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 74697bd..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/ind2sub) 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 37af1d5..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/ind2sub) 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 143618b..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -236,7 +238,7 @@ for ( i = 0; i < len; i++ ) { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. @@ -301,11 +303,11 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/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 6f0e1b5..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 1e236b2..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/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-ind2sub/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 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 70c1453..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n \"mode\": \"throw\",\n \"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 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* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACE,KAAQ,QACR,MAAS,WACX,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 01bf62b..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +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. -*/ - -import ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true, opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 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'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6c85fa8 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.3-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.3-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.3-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.3-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.3-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.2-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.2-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4312458 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 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* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index f9ee6b2..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 59a64b3..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 58fdf93..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index ee01d90..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 1cf74ee..c6962f1 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Convert a linear index to an array of subscripts.", "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,46 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-integer": "^0.2.3", - "@stdlib/assert-is-nonnegative-integer-array": "^0.2.3", - "@stdlib/assert-is-plain-object": "^0.2.3", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.2.2", - "@stdlib/ndarray-base-assert-is-order": "^0.2.2", - "@stdlib/ndarray-base-ind2sub": "^0.2.3", - "@stdlib/ndarray-base-shape2strides": "^0.2.3", - "@stdlib/string-format": "^0.2.3", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.2.3", - "@stdlib/assert-is-array": "^0.2.3", - "@stdlib/math-base-special-floor": "^0.2.4", - "@stdlib/ndarray-base-numel": "^0.2.3", - "@stdlib/random-base-randu": "^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.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d197cf0 --- /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.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +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. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - 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() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - 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() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - 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() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - 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() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - 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() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - 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() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - 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() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 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() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +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. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 85dac67..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - 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() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - 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() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - 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() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - 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() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - 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() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 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() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index a7313a1..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns expected value' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns expected value' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -});