diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 98c1dff..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-03-24T01:07:35.207Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 7bd48cc..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/getter) 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 8e7daf0..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/getter) 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 e5a71d8..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: '23 11 * * 5' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n +``` -```javascript -var getter = require( '@stdlib/array-base-getter' ); +If no recognized module system is present, access bundle contents via the global scope: + +```html + ``` #### getter( dtype ) @@ -117,10 +123,15 @@ The returned accessor function accepts the following arguments: -```javascript -var filled = require( '@stdlib/array-filled' ); -var dtype = require( '@stdlib/array-dtype' ); -var getter = require( '@stdlib/array-base-getter' ); +```html + + + + + + + + + ```
@@ -251,7 +267,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-getter/main/LICENSE -[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes +[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes/tree/umd
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 4ca8149..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,301 +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. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var getter = require( './../lib' ); - - -// VARIABLES // - -var rand = discreteUniform( 0, 127 ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var get; - var dt; - var i; - - dt = dtypes(); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - get = getter( dt[ i%dt.length ] ); - if ( typeof get !== 'function' ) { - b.fail( 'should return a function' ); - } - } - b.toc(); - if ( !isFunction( get ) ) { - b.fail( 'should return a function' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=generic', function benchmark( b ) { - var arr; - var get; - var i; - var v; - - arr = filledBy( 100, 'generic', rand ); - get = getter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = get( arr, i%arr.length ); - if ( v !== v ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float64', function benchmark( b ) { - var arr; - var get; - var i; - var v; - - arr = filledBy( 100, 'float64', rand ); - get = getter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = get( arr, i%arr.length ); - if ( v !== v ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=float32', function benchmark( b ) { - var arr; - var get; - var i; - var v; - - arr = filledBy( 100, 'float32', rand ); - get = getter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = get( arr, i%arr.length ); - if ( v !== v ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int32', function benchmark( b ) { - var arr; - var get; - var i; - var v; - - arr = filledBy( 100, 'int32', rand ); - get = getter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = get( arr, i%arr.length ); - if ( v !== v ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int16', function benchmark( b ) { - var arr; - var get; - var i; - var v; - - arr = filledBy( 100, 'int16', rand ); - get = getter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = get( arr, i%arr.length ); - if ( v !== v ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=int8', function benchmark( b ) { - var arr; - var get; - var i; - var v; - - arr = filledBy( 100, 'int8', rand ); - get = getter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = get( arr, i%arr.length ); - if ( v !== v ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint32', function benchmark( b ) { - var arr; - var get; - var i; - var v; - - arr = filledBy( 100, 'uint32', rand ); - get = getter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = get( arr, i%arr.length ); - if ( v !== v ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint16', function benchmark( b ) { - var arr; - var get; - var i; - var v; - - arr = filledBy( 100, 'uint16', rand ); - get = getter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = get( arr, i%arr.length ); - if ( v !== v ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8', function benchmark( b ) { - var arr; - var get; - var i; - var v; - - arr = filledBy( 100, 'uint8', rand ); - get = getter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = get( arr, i%arr.length ); - if ( v !== v ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':dtype=uint8c', function benchmark( b ) { - var arr; - var get; - var i; - var v; - - arr = filledBy( 100, 'uint8c', rand ); - get = getter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = get( arr, i%arr.length ); - if ( v !== v ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6f23cbd..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/getter" -%% click B href "https://github.com/stdlib-js/array-base-getter/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-getter/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-getter/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-getter/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-getter/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/getter -[production-url]: https://github.com/stdlib-js/array-base-getter/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-getter/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-getter/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-getter/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-getter/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-getter/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-getter/blob/esm/README.md \ No newline at end of file diff --git a/browser.js b/browser.js new file mode 100644 index 0000000..680e7a5 --- /dev/null +++ b/browser.js @@ -0,0 +1,3 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +var n,t;n=this,t=function(){"use strict";var n={float64:function(n,t){return n[t]},float32:function(n,t){return n[t]},int32:function(n,t){return n[t]},int16:function(n,t){return n[t]},int8:function(n,t){return n[t]},uint32:function(n,t){return n[t]},uint16:function(n,t){return n[t]},uint8:function(n,t){return n[t]},uint8c:function(n,t){return n[t]},generic:function(n,t){return n[t]},default:function(n,t){return n[t]}};return function(t){var e=n[t];return"function"==typeof e?e:n.default}},"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(n="undefined"!=typeof globalThis?globalThis:n||self).getter=t(); +//# sourceMappingURL=browser.js.map diff --git a/browser.js.map b/browser.js.map new file mode 100644 index 0000000..745d66e --- /dev/null +++ b/browser.js.map @@ -0,0 +1 @@ +{"version":3,"file":"browser.js","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 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// VARIABLES //\n\nvar GETTERS = {\n\t'float64': getFloat64,\n\t'float32': getFloat32,\n\t'int32': getInt32,\n\t'int16': getInt16,\n\t'int8': getInt8,\n\t'uint32': getUint32,\n\t'uint16': getUint16,\n\t'uint8': getUint8,\n\t'uint8c': getUint8c,\n\t'generic': getGeneric,\n\t'default': getArrayLike\n};\n\n\n// FUNCTIONS //\n\n/**\n* Returns an element from a `Float64Array`.\n*\n* @private\n* @param {Float64Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var arr = new Float64Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getFloat64( arr, 2 );\n* // returns 3.0\n*/\nfunction getFloat64( arr, idx ) {\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a `Float32Array`.\n*\n* @private\n* @param {Float32Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Float32Array from '@stdlib/array-float32';\n*\n* var arr = new Float32Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getFloat32( arr, 2 );\n* // returns 3.0\n*/\nfunction getFloat32( arr, idx ) {\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from an `Int32Array`.\n*\n* @private\n* @param {Int32Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Int32Array from '@stdlib/array-int32';\n*\n* var arr = new Int32Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getInt32( arr, 2 );\n* // returns 3\n*/\nfunction getInt32( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from an `Int16Array`.\n*\n* @private\n* @param {Int16Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Int16Array from '@stdlib/array-int16';\n*\n* var arr = new Int16Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getInt16( arr, 2 );\n* // returns 3\n*/\nfunction getInt16( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from an `Int8Array`.\n*\n* @private\n* @param {Int8Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Int8Array from '@stdlib/array-int8';\n*\n* var arr = new Int8Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getInt8( arr, 2 );\n* // returns 3\n*/\nfunction getInt8( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a `Uint32Array`.\n*\n* @private\n* @param {Uint32Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Uint32Array from '@stdlib/array-uint32';\n*\n* var arr = new Uint32Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getUint32( arr, 2 );\n* // returns 3\n*/\nfunction getUint32( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a `Uint16Array`.\n*\n* @private\n* @param {Uint16Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Uint16Array from '@stdlib/array-uint16';\n*\n* var arr = new Uint16Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getUint16( arr, 2 );\n* // returns 3\n*/\nfunction getUint16( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a `Uint8Array`.\n*\n* @private\n* @param {Uint8Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n*\n* var arr = new Uint8Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getUint8( arr, 2 );\n* // returns 3\n*/\nfunction getUint8( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a `Uint8ClampedArray`.\n*\n* @private\n* @param {Uint8ClampedArray} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Uint8ClampedArray from '@stdlib/array-uint8c';\n*\n* var arr = new Uint8ClampedArray( [ 1, 2, 3, 4 ] );\n*\n* var v = getUint8c( arr, 2 );\n* // returns 3\n*/\nfunction getUint8c( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a generic `Array`.\n*\n* @private\n* @param {Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {*} element value\n*\n* @example\n* var arr = [ 1, 2, 3, 4 ];\n*\n* var v = getGeneric( arr, 2 );\n* // returns 3\n*/\nfunction getGeneric( arr, idx ) {\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from an indexed array-like object.\n*\n* @private\n* @param {Collection} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {*} element value\n*\n* @example\n* var arr = [ 1, 2, 3, 4 ];\n*\n* var v = getArrayLike( arr, 2 );\n* // returns 3\n*/\nfunction getArrayLike( arr, idx ) {\n\treturn arr[ idx ];\n}\n\n\n// MAIN //\n\n/**\n* Returns an accessor function for retrieving an element from an indexed array-like object.\n*\n* @param {string} dtype - array dtype\n* @returns {Function} accessor\n*\n* @example\n* import dtype from '@stdlib/array-dtype';\n*\n* var arr = [ 1, 2, 3, 4 ];\n*\n* var get = getter( dtype( arr ) );\n* var v = get( arr, 2 );\n* // returns 3\n*/\nfunction getter( dtype ) {\n\tvar f = GETTERS[ dtype ];\n\tif ( typeof f === 'function' ) {\n\t\treturn f;\n\t}\n\treturn GETTERS.default;\n}\n\n\n// EXPORTS //\n\nexport default getter;\n"],"names":["GETTERS","float64","arr","idx","float32","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","dtype","f"],"mappings":";yCAsBA,IAAIA,EAAU,CACbC,QAgCD,SAAqBC,EAAKC,GACzB,OAAOD,EAAKC,EACb,EAjCCC,QAmDD,SAAqBF,EAAKC,GACzB,OAAOD,EAAKC,EACb,EApDCE,MAsED,SAAmBH,EAAKC,GACvB,OAAOD,EAAKC,EACb,EAvECG,MAyFD,SAAmBJ,EAAKC,GACvB,OAAOD,EAAKC,EACb,EA1FCI,KA4GD,SAAkBL,EAAKC,GACtB,OAAOD,EAAKC,EACb,EA7GCK,OA+HD,SAAoBN,EAAKC,GACxB,OAAOD,EAAKC,EACb,EAhICM,OAkJD,SAAoBP,EAAKC,GACxB,OAAOD,EAAKC,EACb,EAnJCO,MAqKD,SAAmBR,EAAKC,GACvB,OAAOD,EAAKC,EACb,EAtKCQ,OAwLD,SAAoBT,EAAKC,GACxB,OAAOD,EAAKC,EACb,EAzLCS,QAyMD,SAAqBV,EAAKC,GACzB,OAAOD,EAAKC,EACb,EA1MCU,QA0ND,SAAuBX,EAAKC,GAC3B,OAAOD,EAAKC,EACb,UAoBA,SAAiBW,GAChB,IAAIC,EAAIf,EAASc,GACjB,MAAkB,mBAANC,EACJA,EAEDf,EAAQa,OAChB"} \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 0906510..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import getter from '../docs/types/index'; -export = getter; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 7dcfc41..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var i=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var u=i(function(E,r){ -var e={float64:f,float32:o,int32:c,int16:g,int8:a,uint32:l,uint16:s,uint8:U,uint8c:p,generic:v,default:I};function f(n,t){return n[t]}function o(n,t){return n[t]}function c(n,t){return n[t]}function g(n,t){return n[t]}function a(n,t){return n[t]}function l(n,t){return n[t]}function s(n,t){return n[t]}function U(n,t){return n[t]}function p(n,t){return n[t]}function v(n,t){return n[t]}function I(n,t){return n[t]}function d(n){var t=e[n];return typeof t=="function"?t:e.default}r.exports=d -});var x=u();module.exports=x; -/** @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 1ab64c6..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 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// VARIABLES //\n\nvar GETTERS = {\n\t'float64': getFloat64,\n\t'float32': getFloat32,\n\t'int32': getInt32,\n\t'int16': getInt16,\n\t'int8': getInt8,\n\t'uint32': getUint32,\n\t'uint16': getUint16,\n\t'uint8': getUint8,\n\t'uint8c': getUint8c,\n\t'generic': getGeneric,\n\t'default': getArrayLike\n};\n\n\n// FUNCTIONS //\n\n/**\n* Returns an element from a `Float64Array`.\n*\n* @private\n* @param {Float64Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var arr = new Float64Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getFloat64( arr, 2 );\n* // returns 3.0\n*/\nfunction getFloat64( arr, idx ) {\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a `Float32Array`.\n*\n* @private\n* @param {Float32Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n*\n* var arr = new Float32Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getFloat32( arr, 2 );\n* // returns 3.0\n*/\nfunction getFloat32( arr, idx ) {\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from an `Int32Array`.\n*\n* @private\n* @param {Int32Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* var Int32Array = require( '@stdlib/array-int32' );\n*\n* var arr = new Int32Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getInt32( arr, 2 );\n* // returns 3\n*/\nfunction getInt32( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from an `Int16Array`.\n*\n* @private\n* @param {Int16Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* var Int16Array = require( '@stdlib/array-int16' );\n*\n* var arr = new Int16Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getInt16( arr, 2 );\n* // returns 3\n*/\nfunction getInt16( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from an `Int8Array`.\n*\n* @private\n* @param {Int8Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* var Int8Array = require( '@stdlib/array-int8' );\n*\n* var arr = new Int8Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getInt8( arr, 2 );\n* // returns 3\n*/\nfunction getInt8( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a `Uint32Array`.\n*\n* @private\n* @param {Uint32Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* var Uint32Array = require( '@stdlib/array-uint32' );\n*\n* var arr = new Uint32Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getUint32( arr, 2 );\n* // returns 3\n*/\nfunction getUint32( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a `Uint16Array`.\n*\n* @private\n* @param {Uint16Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* var Uint16Array = require( '@stdlib/array-uint16' );\n*\n* var arr = new Uint16Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getUint16( arr, 2 );\n* // returns 3\n*/\nfunction getUint16( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a `Uint8Array`.\n*\n* @private\n* @param {Uint8Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n*\n* var arr = new Uint8Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getUint8( arr, 2 );\n* // returns 3\n*/\nfunction getUint8( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a `Uint8ClampedArray`.\n*\n* @private\n* @param {Uint8ClampedArray} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* var Uint8ClampedArray = require( '@stdlib/array-uint8c' );\n*\n* var arr = new Uint8ClampedArray( [ 1, 2, 3, 4 ] );\n*\n* var v = getUint8c( arr, 2 );\n* // returns 3\n*/\nfunction getUint8c( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a generic `Array`.\n*\n* @private\n* @param {Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {*} element value\n*\n* @example\n* var arr = [ 1, 2, 3, 4 ];\n*\n* var v = getGeneric( arr, 2 );\n* // returns 3\n*/\nfunction getGeneric( arr, idx ) {\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from an indexed array-like object.\n*\n* @private\n* @param {Collection} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {*} element value\n*\n* @example\n* var arr = [ 1, 2, 3, 4 ];\n*\n* var v = getArrayLike( arr, 2 );\n* // returns 3\n*/\nfunction getArrayLike( arr, idx ) {\n\treturn arr[ idx ];\n}\n\n\n// MAIN //\n\n/**\n* Returns an accessor function for retrieving an element from an indexed array-like object.\n*\n* @param {string} dtype - array dtype\n* @returns {Function} accessor\n*\n* @example\n* var dtype = require( '@stdlib/array-dtype' );\n*\n* var arr = [ 1, 2, 3, 4 ];\n*\n* var get = getter( dtype( arr ) );\n* var v = get( arr, 2 );\n* // returns 3\n*/\nfunction getter( dtype ) {\n\tvar f = GETTERS[ dtype ];\n\tif ( typeof f === 'function' ) {\n\t\treturn f;\n\t}\n\treturn GETTERS.default;\n}\n\n\n// EXPORTS //\n\nmodule.exports = getter;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 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* Return an accessor function for retrieving an element from an indexed array-like object.\n*\n* @module @stdlib/array-base-getter\n*\n* @example\n* var dtype = require( '@stdlib/array-dtype' );\n* var getter = require( '@stdlib/array-base-getter' );\n*\n* var arr = [ 1, 2, 3, 4 ];\n*\n* var get = getter( dtype( arr ) );\n* var v = get( arr, 2 );\n* // returns 3\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAqBA,SAASV,EAAYW,EAAKC,EAAM,CAC/B,OAAOD,EAAKC,CAAI,CACjB,CAkBA,SAASX,EAAYU,EAAKC,EAAM,CAC/B,OAAOD,EAAKC,CAAI,CACjB,CAkBA,SAASV,EAAUS,EAAKC,EAAM,CAC7B,OAAOD,EAAKC,CAAI,CACjB,CAkBA,SAAST,EAAUQ,EAAKC,EAAM,CAC7B,OAAOD,EAAKC,CAAI,CACjB,CAkBA,SAASR,EAASO,EAAKC,EAAM,CAC5B,OAAOD,EAAKC,CAAI,CACjB,CAkBA,SAASP,EAAWM,EAAKC,EAAM,CAC9B,OAAOD,EAAKC,CAAI,CACjB,CAkBA,SAASN,EAAWK,EAAKC,EAAM,CAC9B,OAAOD,EAAKC,CAAI,CACjB,CAkBA,SAASL,EAAUI,EAAKC,EAAM,CAC7B,OAAOD,EAAKC,CAAI,CACjB,CAkBA,SAASJ,EAAWG,EAAKC,EAAM,CAC9B,OAAOD,EAAKC,CAAI,CACjB,CAgBA,SAASH,EAAYE,EAAKC,EAAM,CAC/B,OAAOD,EAAKC,CAAI,CACjB,CAgBA,SAASF,EAAcC,EAAKC,EAAM,CACjC,OAAOD,EAAKC,CAAI,CACjB,CAoBA,SAASC,EAAQC,EAAQ,CACxB,IAAIC,EAAIhB,EAASe,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDhB,EAAQ,OAChB,CAKAD,EAAO,QAAUe,ICtPjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "GETTERS", "getFloat64", "getFloat32", "getInt32", "getInt16", "getInt8", "getUint32", "getUint16", "getUint8", "getUint8c", "getGeneric", "getArrayLike", "arr", "idx", "getter", "dtype", "f", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 163b05f..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,47 +0,0 @@ - -{{alias}}( dtype ) - Returns an accessor function for retrieving an element from an indexed - array-like object. - - An accessor function accepts the following arguments: - - - arr: input array. - - idx: element index. - - If provided an unsupported `dtype`, the function returns a default accessor - function for accessing elements from any indexed array-like object. - - Otherwise, the function returns an accessor function which should *only* be - provided an array instance corresponding to `dtype` (e.g., if `dtype` is - 'float64', the returned accessor function should only be provided instances - of Float64Array). - - Accessor functions do *not* verify that provided input arrays are array - instances corresponding to `dtype`, as doing so would introduce performance - overhead. If array instances corresponding to other data types are provided - to an accessor function, JavaScript runtimes will consider the function - polymorphic, potentially triggering de-optimization. In order to ensure - maximum performance, *always* ensure that an accessor function is - monomorphic. - - Accessor functions do *not* perform bounds checking. - - Parameters - ---------- - dtype: string - Array data type. - - Returns - ------- - f: Function - Accessor function. - - Examples - -------- - > var f = {{alias}}( 'generic' ); - > var v = f( [ 1, 2, 3, 4 ], 2 ) - 3 - - See Also - -------- - diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts deleted file mode 100644 index 514e3c6..0000000 --- a/docs/types/index.d.ts +++ /dev/null @@ -1,312 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Returns an element from a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @returns element value -*/ -type GetFloat64 = ( arr: Float64Array, idx: number ) => number | void; - -/** -* Returns an element from a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @returns element value -*/ -type GetFloat32 = ( arr: Float32Array, idx: number ) => number | void; - -/** -* Returns an element from an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @returns element value -*/ -type GetInt32 = ( arr: Int32Array, idx: number ) => number | void; - -/** -* Returns an element from an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @returns element value -*/ -type GetInt16 = ( arr: Int16Array, idx: number ) => number | void; - -/** -* Returns an element from an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @returns element value -*/ -type GetInt8 = ( arr: Int8Array, idx: number ) => number | void; - -/** -* Returns an element from a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @returns element value -*/ -type GetUint32 = ( arr: Uint32Array, idx: number ) => number | void; - -/** -* Returns an element from a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @returns element value -*/ -type GetUint16 = ( arr: Uint16Array, idx: number ) => number | void; - -/** -* Returns an element from a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @returns element value -*/ -type GetUint8 = ( arr: Uint8Array, idx: number ) => number | void; - -/** -* Returns an element from a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @returns element value -*/ -type GetUint8c = ( arr: Uint8ClampedArray, idx: number ) => number | void; - -/** -* Returns an element from a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @returns element value -*/ -type GetGeneric = ( arr: Array, idx: number ) => T | void; - -/** -* Returns an element from an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @returns element value -*/ -type GetArrayLike = ( arr: Collection, idx: number ) => T | void; - -/** -* Returns an accessor function for retrieving an element from a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( [ 1, 2, 3, 4 ] ); -* -* var get = getter( 'float64' ); -* var v = get( arr, 2 ); -* // returns 3.0 -*/ -declare function getter( dtype: 'float64' ): GetFloat64; - -/** -* Returns an accessor function for retrieving an element from a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( [ 1, 2, 3, 4 ] ); -* -* var get = getter( 'float32' ); -* var v = get( arr, 2 ); -* // returns 3.0 -*/ -declare function getter( dtype: 'float32' ): GetFloat32; - -/** -* Returns an accessor function for retrieving an element from an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( [ 1, 2, 3, 4 ] ); -* -* var get = getter( 'int32' ); -* var v = get( arr, 2 ); -* // returns 3 -*/ -declare function getter( dtype: 'int32' ): GetInt32; - -/** -* Returns an accessor function for retrieving an element from an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( [ 1, 2, 3, 4 ] ); -* -* var get = getter( 'int16' ); -* var v = get( arr, 2 ); -* // returns 3 -*/ -declare function getter( dtype: 'int16' ): GetInt16; - -/** -* Returns an accessor function for retrieving an element from an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( [ 1, 2, 3, 4 ] ); -* -* var get = getter( 'int8' ); -* var v = get( arr, 2 ); -* // returns 3 -*/ -declare function getter( dtype: 'int8' ): GetInt8; - -/** -* Returns an accessor function for retrieving an element from a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( [ 1, 2, 3, 4 ] ); -* -* var get = getter( 'uint32' ); -* var v = get( arr, 2 ); -* // returns 3 -*/ -declare function getter( dtype: 'uint32' ): GetUint32; - -/** -* Returns an accessor function for retrieving an element from a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( [ 1, 2, 3, 4 ] ); -* -* var get = getter( 'uint16' ); -* var v = get( arr, 2 ); -* // returns 3 -*/ -declare function getter( dtype: 'uint16' ): GetUint16; - -/** -* Returns an accessor function for retrieving an element from a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( [ 1, 2, 3, 4 ] ); -* -* var get = getter( 'uint8' ); -* var v = get( arr, 2 ); -* // returns 3 -*/ -declare function getter( dtype: 'uint8' ): GetUint8; - -/** -* Returns an accessor function for retrieving an element from a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); -* -* var get = getter( 'uint8c' ); -* var v = get( arr, 2 ); -* // returns 3 -*/ -declare function getter( dtype: 'uint8c' ): GetUint8c; - -/** -* Returns an accessor function for retrieving an element from a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 1, 2, 3, 4 ]; -* -* var get = getter( 'generic' ); -* var v = get( arr, 2 ); -* // returns 3 -*/ -declare function getter( dtype: 'generic' ): GetGeneric; - -/** -* Returns an accessor function for retrieving an element from an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 1, 2, 3, 4 ]; -* -* var get = getter( dtype( arr ) ); -* var v = get( arr, 2 ); -* // returns 3 -*/ -declare function getter( dtype: string ): GetArrayLike; - - -// EXPORTS // - -export = getter; diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8e8efc8..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,319 +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. -*/ - -import getter = require( './index' ); - - -// TESTS // - -// The function returns a function... -{ - getter( 'float64' ); // $ExpectType GetFloat64 - getter( 'float32' ); // $ExpectType GetFloat32 - getter( 'int32' ); // $ExpectType GetInt32 - getter( 'int16' ); // $ExpectType GetInt16 - getter( 'int8' ); // $ExpectType GetInt8 - getter( 'uint32' ); // $ExpectType GetUint32 - getter( 'uint16' ); // $ExpectType GetUint16 - getter( 'uint8' ); // $ExpectType GetUint8 - getter( 'uint8c' ); // $ExpectType GetUint8c - getter( 'generic' ); // $ExpectType GetGeneric - getter( 'foo' ); // $ExpectType GetArrayLike -} - -// The compiler throws an error if the function is provided a first argument which is not a string... -{ - getter( 5 ); // $ExpectError - getter( true ); // $ExpectError - getter( false ); // $ExpectError - getter( null ); // $ExpectError - getter( {} ); // $ExpectError - getter( [] ); // $ExpectError - getter( ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - getter(); // $ExpectError - getter( 'float64', {} ); // $ExpectError -} - -// The function returns a function which returns an array element... -{ - const get1 = getter( 'generic' ); - const x1 = [ 1, 2, 3, 4 ]; - get1( x1, 2 ); // $ExpectType number | void - - const get2 = getter( 'float64' ); - const x2 = new Float64Array( [ 1, 2, 3, 4 ] ); - get2( x2, 2 ); // $ExpectType number | void - - const get3 = getter( 'float32' ); - const x3 = new Float32Array( [ 1, 2, 3, 4 ] ); - get3( x3, 2 ); // $ExpectType number | void - - const get4 = getter( 'int32' ); - const x4 = new Int32Array( [ 1, 2, 3, 4 ] ); - get4( x4, 2 ); // $ExpectType number | void - - const get5 = getter( 'int16' ); - const x5 = new Int16Array( [ 1, 2, 3, 4 ] ); - get5( x5, 2 ); // $ExpectType number | void - - const get6 = getter( 'int8' ); - const x6 = new Int8Array( [ 1, 2, 3, 4 ] ); - get6( x6, 2 ); // $ExpectType number | void - - const get7 = getter( 'uint32' ); - const x7 = new Uint32Array( [ 1, 2, 3, 4 ] ); - get7( x7, 2 ); // $ExpectType number | void - - const get8 = getter( 'uint16' ); - const x8 = new Uint16Array( [ 1, 2, 3, 4 ] ); - get8( x8, 2 ); // $ExpectType number | void - - const get9 = getter( 'uint8' ); - const x9 = new Uint8Array( [ 1, 2, 3, 4 ] ); - get9( x9, 2 ); // $ExpectType number | void - - const get10 = getter( 'uint8c' ); - const x10 = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - get10( x10, 2 ); // $ExpectType number | void - - const get11 = getter( 'foo' ); - const x11 = [ 1, 2, 3, 4 ]; - get11( x11, 2 ); // $ExpectType unknown -} - -// The compiler throws an error if the returned function is provided a first argument which is not a collection... -{ - const get1 = getter( 'generic' ); - get1( 5, 2 ); // $ExpectError - get1( true, 2 ); // $ExpectError - get1( false, 2 ); // $ExpectError - get1( null, 2 ); // $ExpectError - get1( {}, 2 ); // $ExpectError - - const get2 = getter( 'float64' ); - get2( 5, 2 ); // $ExpectError - get2( true, 2 ); // $ExpectError - get2( false, 2 ); // $ExpectError - get2( null, 2 ); // $ExpectError - get2( {}, 2 ); // $ExpectError - - const get3 = getter( 'float32' ); - get3( 5, 2 ); // $ExpectError - get3( true, 2 ); // $ExpectError - get3( false, 2 ); // $ExpectError - get3( null, 2 ); // $ExpectError - get3( {}, 2 ); // $ExpectError - - const get4 = getter( 'int32' ); - get4( 5, 2 ); // $ExpectError - get4( true, 2 ); // $ExpectError - get4( false, 2 ); // $ExpectError - get4( null, 2 ); // $ExpectError - get4( {}, 2 ); // $ExpectError - - const get5 = getter( 'int16' ); - get5( 5, 2 ); // $ExpectError - get5( true, 2 ); // $ExpectError - get5( false, 2 ); // $ExpectError - get5( null, 2 ); // $ExpectError - get5( {}, 2 ); // $ExpectError - - const get6 = getter( 'int8' ); - get6( 5, 2 ); // $ExpectError - get6( true, 2 ); // $ExpectError - get6( false, 2 ); // $ExpectError - get6( null, 2 ); // $ExpectError - get6( {}, 2 ); // $ExpectError - - const get7 = getter( 'uint32' ); - get7( 5, 2 ); // $ExpectError - get7( true, 2 ); // $ExpectError - get7( false, 2 ); // $ExpectError - get7( null, 2 ); // $ExpectError - get7( {}, 2 ); // $ExpectError - - const get8 = getter( 'uint16' ); - get8( 5, 2 ); // $ExpectError - get8( true, 2 ); // $ExpectError - get8( false, 2 ); // $ExpectError - get8( null, 2 ); // $ExpectError - get8( {}, 2 ); // $ExpectError - - const get9 = getter( 'uint8' ); - get9( 5, 2 ); // $ExpectError - get9( true, 2 ); // $ExpectError - get9( false, 2 ); // $ExpectError - get9( null, 2 ); // $ExpectError - get9( {}, 2 ); // $ExpectError - - const get10 = getter( 'uint8c' ); - get10( 5, 2 ); // $ExpectError - get10( true, 2 ); // $ExpectError - get10( false, 2 ); // $ExpectError - get10( null, 2 ); // $ExpectError - get10( {}, 2 ); // $ExpectError - - const get11 = getter( 'foo' ); - get11( 5, 2 ); // $ExpectError - get11( true, 2 ); // $ExpectError - get11( false, 2 ); // $ExpectError - get11( null, 2 ); // $ExpectError - get11( {}, 2 ); // $ExpectError -} - -// The compiler throws an error if the returned function is provided a second argument which is not a number... -{ - const get1 = getter( 'generic' ); - get1( [ 1, 2, 3, 4 ], '5' ); // $ExpectError - get1( [ 1, 2, 3, 4 ], true ); // $ExpectError - get1( [ 1, 2, 3, 4 ], false ); // $ExpectError - get1( [ 1, 2, 3, 4 ], null ); // $ExpectError - get1( [ 1, 2, 3, 4 ], {} ); // $ExpectError - - const get2 = getter( 'float64' ); - get2( new Float64Array( [ 1, 2, 3, 4 ] ), '5' ); // $ExpectError - get2( new Float64Array( [ 1, 2, 3, 4 ] ), true ); // $ExpectError - get2( new Float64Array( [ 1, 2, 3, 4 ] ), false ); // $ExpectError - get2( new Float64Array( [ 1, 2, 3, 4 ] ), null ); // $ExpectError - get2( new Float64Array( [ 1, 2, 3, 4 ] ), {} ); // $ExpectError - - const get3 = getter( 'float32' ); - get3( new Float32Array( [ 1, 2, 3, 4 ] ), '5' ); // $ExpectError - get3( new Float32Array( [ 1, 2, 3, 4 ] ), true ); // $ExpectError - get3( new Float32Array( [ 1, 2, 3, 4 ] ), false ); // $ExpectError - get3( new Float32Array( [ 1, 2, 3, 4 ] ), null ); // $ExpectError - get3( new Float32Array( [ 1, 2, 3, 4 ] ), {} ); // $ExpectError - - const get4 = getter( 'int32' ); - get4( new Int32Array( [ 1, 2, 3, 4 ] ), '5' ); // $ExpectError - get4( new Int32Array( [ 1, 2, 3, 4 ] ), true ); // $ExpectError - get4( new Int32Array( [ 1, 2, 3, 4 ] ), false ); // $ExpectError - get4( new Int32Array( [ 1, 2, 3, 4 ] ), null ); // $ExpectError - get4( new Int32Array( [ 1, 2, 3, 4 ] ), {} ); // $ExpectError - - const get5 = getter( 'int16' ); - get5( new Int16Array( [ 1, 2, 3, 4 ] ), '5' ); // $ExpectError - get5( new Int16Array( [ 1, 2, 3, 4 ] ), true ); // $ExpectError - get5( new Int16Array( [ 1, 2, 3, 4 ] ), false ); // $ExpectError - get5( new Int16Array( [ 1, 2, 3, 4 ] ), null ); // $ExpectError - get5( new Int16Array( [ 1, 2, 3, 4 ] ), {} ); // $ExpectError - - const get6 = getter( 'int8' ); - get6( new Int8Array( [ 1, 2, 3, 4 ] ), '5' ); // $ExpectError - get6( new Int8Array( [ 1, 2, 3, 4 ] ), true ); // $ExpectError - get6( new Int8Array( [ 1, 2, 3, 4 ] ), false ); // $ExpectError - get6( new Int8Array( [ 1, 2, 3, 4 ] ), null ); // $ExpectError - get6( new Int8Array( [ 1, 2, 3, 4 ] ), {} ); // $ExpectError - - const get7 = getter( 'uint32' ); - get7( new Uint32Array( [ 1, 2, 3, 4 ] ), '5' ); // $ExpectError - get7( new Uint32Array( [ 1, 2, 3, 4 ] ), true ); // $ExpectError - get7( new Uint32Array( [ 1, 2, 3, 4 ] ), false ); // $ExpectError - get7( new Uint32Array( [ 1, 2, 3, 4 ] ), null ); // $ExpectError - get7( new Uint32Array( [ 1, 2, 3, 4 ] ), {} ); // $ExpectError - - const get8 = getter( 'uint16' ); - get8( new Uint16Array( [ 1, 2, 3, 4 ] ), '5' ); // $ExpectError - get8( new Uint16Array( [ 1, 2, 3, 4 ] ), true ); // $ExpectError - get8( new Uint16Array( [ 1, 2, 3, 4 ] ), false ); // $ExpectError - get8( new Uint16Array( [ 1, 2, 3, 4 ] ), null ); // $ExpectError - get8( new Uint16Array( [ 1, 2, 3, 4 ] ), {} ); // $ExpectError - - const get9 = getter( 'uint8' ); - get9( new Uint8Array( [ 1, 2, 3, 4 ] ), '5' ); // $ExpectError - get9( new Uint8Array( [ 1, 2, 3, 4 ] ), true ); // $ExpectError - get9( new Uint8Array( [ 1, 2, 3, 4 ] ), false ); // $ExpectError - get9( new Uint8Array( [ 1, 2, 3, 4 ] ), null ); // $ExpectError - get9( new Uint8Array( [ 1, 2, 3, 4 ] ), {} ); // $ExpectError - - const get10 = getter( 'uint8c' ); - get10( new Uint8ClampedArray( [ 1, 2, 3, 4 ] ), '5' ); // $ExpectError - get10( new Uint8ClampedArray( [ 1, 2, 3, 4 ] ), true ); // $ExpectError - get10( new Uint8ClampedArray( [ 1, 2, 3, 4 ] ), false ); // $ExpectError - get10( new Uint8ClampedArray( [ 1, 2, 3, 4 ] ), null ); // $ExpectError - get10( new Uint8ClampedArray( [ 1, 2, 3, 4 ] ), {} ); // $ExpectError - - const get11 = getter( 'foo' ); - get11( [ 1, 2, 3, 4 ], '5' ); // $ExpectError - get11( [ 1, 2, 3, 4 ], true ); // $ExpectError - get11( [ 1, 2, 3, 4 ], false ); // $ExpectError - get11( [ 1, 2, 3, 4 ], null ); // $ExpectError - get11( [ 1, 2, 3, 4 ], {} ); // $ExpectError -} - -// The compiler throws an error if the returned function is provided an unsupported number of arguments... -{ - const get1 = getter( 'generic' ); - get1(); // $ExpectError - get1( [] ); // $ExpectError - get1( [], 1, 2 ); // $ExpectError - - const get2 = getter( 'float64' ); - get2(); // $ExpectError - get2( new Float64Array( [] ) ); // $ExpectError - get2( new Float64Array( [] ), 1, 2 ); // $ExpectError - - const get3 = getter( 'float32' ); - get3(); // $ExpectError - get3( new Float32Array( [] ) ); // $ExpectError - get3( new Float32Array( [] ), 1, 2 ); // $ExpectError - - const get4 = getter( 'int32' ); - get4(); // $ExpectError - get4( new Int32Array( [] ) ); // $ExpectError - get4( new Int32Array( [] ), 1, 2 ); // $ExpectError - - const get5 = getter( 'int16' ); - get5(); // $ExpectError - get5( new Int16Array( [] ) ); // $ExpectError - get5( new Int16Array( [] ), 1, 2 ); // $ExpectError - - const get6 = getter( 'int8' ); - get6(); // $ExpectError - get6( new Int8Array( [] ) ); // $ExpectError - get6( new Int8Array( [] ), 1, 2 ); // $ExpectError - - const get7 = getter( 'uint32' ); - get7(); // $ExpectError - get7( new Uint32Array( [] ) ); // $ExpectError - get7( new Uint32Array( [] ), 1, 2 ); // $ExpectError - - const get8 = getter( 'uint16' ); - get8(); // $ExpectError - get8( new Uint16Array( [] ) ); // $ExpectError - get8( new Uint16Array( [] ), 1, 2 ); // $ExpectError - - const get9 = getter( 'uint8' ); - get9(); // $ExpectError - get9( new Uint8Array( [] ) ); // $ExpectError - get9( new Uint8Array( [] ), 1, 2 ); // $ExpectError - - const get10 = getter( 'uint8c' ); - get10(); // $ExpectError - get10( new Uint8ClampedArray( [] ) ); // $ExpectError - get10( new Uint8ClampedArray( [] ), 1, 2 ); // $ExpectError - - const get11 = getter( 'foo' ); - get11(); // $ExpectError - get11( [] ); // $ExpectError - get11( [], 1, 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index e6791eb..0000000 --- a/examples/index.js +++ /dev/null @@ -1,59 +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. -*/ - -'use strict'; - -var filled = require( '@stdlib/array-filled' ); -var dtype = require( '@stdlib/array-dtype' ); -var getter = require( './../lib' ); - -var arr = filled( 1.0, 10, 'float64' ); -var v = getter( dtype( arr ) )( arr, 2 ); -console.log( 'v: %d', v ); - -arr = filled( 2.0, 10, 'float32' ); -v = getter( dtype( arr ) )( arr, 2 ); -console.log( 'v: %d', v ); - -arr = filled( 3, 10, 'int32' ); -v = getter( dtype( arr ) )( arr, 2 ); -console.log( 'v: %d', v ); - -arr = filled( 4, 10, 'int16' ); -v = getter( dtype( arr ) )( arr, 2 ); -console.log( 'v: %d', v ); - -arr = filled( 5, 10, 'int8' ); -v = getter( dtype( arr ) )( arr, 2 ); -console.log( 'v: %d', v ); - -arr = filled( 6, 10, 'uint32' ); -v = getter( dtype( arr ) )( arr, 2 ); -console.log( 'v: %d', v ); - -arr = filled( 7, 10, 'uint16' ); -v = getter( dtype( arr ) )( arr, 2 ); -console.log( 'v: %d', v ); - -arr = filled( 8, 10, 'uint8' ); -v = getter( dtype( arr ) )( arr, 2 ); -console.log( 'v: %d', v ); - -arr = filled( 9, 10, 'uint8c' ); -v = getter( dtype( arr ) )( arr, 2 ); -console.log( 'v: %d', v ); diff --git a/index.js b/index.js new file mode 100644 index 0000000..430f4e6 --- /dev/null +++ b/index.js @@ -0,0 +1,3 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +var n,t;n=this,t=function(){"use strict";var n={float64:function(n,t){return n[t]},float32:function(n,t){return n[t]},int32:function(n,t){return n[t]},int16:function(n,t){return n[t]},int8:function(n,t){return n[t]},uint32:function(n,t){return n[t]},uint16:function(n,t){return n[t]},uint8:function(n,t){return n[t]},uint8c:function(n,t){return n[t]},generic:function(n,t){return n[t]},default:function(n,t){return n[t]}};return function(t){var e=n[t];return"function"==typeof e?e:n.default}},"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(n="undefined"!=typeof globalThis?globalThis:n||self).getter=t(); +//# sourceMappingURL=index.js.map diff --git a/index.js.map b/index.js.map new file mode 100644 index 0000000..5ef22a7 --- /dev/null +++ b/index.js.map @@ -0,0 +1 @@ +{"version":3,"file":"index.js","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 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// VARIABLES //\n\nvar GETTERS = {\n\t'float64': getFloat64,\n\t'float32': getFloat32,\n\t'int32': getInt32,\n\t'int16': getInt16,\n\t'int8': getInt8,\n\t'uint32': getUint32,\n\t'uint16': getUint16,\n\t'uint8': getUint8,\n\t'uint8c': getUint8c,\n\t'generic': getGeneric,\n\t'default': getArrayLike\n};\n\n\n// FUNCTIONS //\n\n/**\n* Returns an element from a `Float64Array`.\n*\n* @private\n* @param {Float64Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var arr = new Float64Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getFloat64( arr, 2 );\n* // returns 3.0\n*/\nfunction getFloat64( arr, idx ) {\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a `Float32Array`.\n*\n* @private\n* @param {Float32Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Float32Array from '@stdlib/array-float32';\n*\n* var arr = new Float32Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getFloat32( arr, 2 );\n* // returns 3.0\n*/\nfunction getFloat32( arr, idx ) {\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from an `Int32Array`.\n*\n* @private\n* @param {Int32Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Int32Array from '@stdlib/array-int32';\n*\n* var arr = new Int32Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getInt32( arr, 2 );\n* // returns 3\n*/\nfunction getInt32( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from an `Int16Array`.\n*\n* @private\n* @param {Int16Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Int16Array from '@stdlib/array-int16';\n*\n* var arr = new Int16Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getInt16( arr, 2 );\n* // returns 3\n*/\nfunction getInt16( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from an `Int8Array`.\n*\n* @private\n* @param {Int8Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Int8Array from '@stdlib/array-int8';\n*\n* var arr = new Int8Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getInt8( arr, 2 );\n* // returns 3\n*/\nfunction getInt8( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a `Uint32Array`.\n*\n* @private\n* @param {Uint32Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Uint32Array from '@stdlib/array-uint32';\n*\n* var arr = new Uint32Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getUint32( arr, 2 );\n* // returns 3\n*/\nfunction getUint32( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a `Uint16Array`.\n*\n* @private\n* @param {Uint16Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Uint16Array from '@stdlib/array-uint16';\n*\n* var arr = new Uint16Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getUint16( arr, 2 );\n* // returns 3\n*/\nfunction getUint16( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a `Uint8Array`.\n*\n* @private\n* @param {Uint8Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n*\n* var arr = new Uint8Array( [ 1, 2, 3, 4 ] );\n*\n* var v = getUint8( arr, 2 );\n* // returns 3\n*/\nfunction getUint8( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a `Uint8ClampedArray`.\n*\n* @private\n* @param {Uint8ClampedArray} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {number} element value\n*\n* @example\n* import Uint8ClampedArray from '@stdlib/array-uint8c';\n*\n* var arr = new Uint8ClampedArray( [ 1, 2, 3, 4 ] );\n*\n* var v = getUint8c( arr, 2 );\n* // returns 3\n*/\nfunction getUint8c( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from a generic `Array`.\n*\n* @private\n* @param {Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {*} element value\n*\n* @example\n* var arr = [ 1, 2, 3, 4 ];\n*\n* var v = getGeneric( arr, 2 );\n* // returns 3\n*/\nfunction getGeneric( arr, idx ) {\n\treturn arr[ idx ];\n}\n\n/**\n* Returns an element from an indexed array-like object.\n*\n* @private\n* @param {Collection} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @returns {*} element value\n*\n* @example\n* var arr = [ 1, 2, 3, 4 ];\n*\n* var v = getArrayLike( arr, 2 );\n* // returns 3\n*/\nfunction getArrayLike( arr, idx ) {\n\treturn arr[ idx ];\n}\n\n\n// MAIN //\n\n/**\n* Returns an accessor function for retrieving an element from an indexed array-like object.\n*\n* @param {string} dtype - array dtype\n* @returns {Function} accessor\n*\n* @example\n* import dtype from '@stdlib/array-dtype';\n*\n* var arr = [ 1, 2, 3, 4 ];\n*\n* var get = getter( dtype( arr ) );\n* var v = get( arr, 2 );\n* // returns 3\n*/\nfunction getter( dtype ) {\n\tvar f = GETTERS[ dtype ];\n\tif ( typeof f === 'function' ) {\n\t\treturn f;\n\t}\n\treturn GETTERS.default;\n}\n\n\n// EXPORTS //\n\nexport default getter;\n"],"names":["GETTERS","float64","arr","idx","float32","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","dtype","f"],"mappings":";yCAsBA,IAAIA,EAAU,CACbC,QAgCD,SAAqBC,EAAKC,GACzB,OAAOD,EAAKC,EACb,EAjCCC,QAmDD,SAAqBF,EAAKC,GACzB,OAAOD,EAAKC,EACb,EApDCE,MAsED,SAAmBH,EAAKC,GACvB,OAAOD,EAAKC,EACb,EAvECG,MAyFD,SAAmBJ,EAAKC,GACvB,OAAOD,EAAKC,EACb,EA1FCI,KA4GD,SAAkBL,EAAKC,GACtB,OAAOD,EAAKC,EACb,EA7GCK,OA+HD,SAAoBN,EAAKC,GACxB,OAAOD,EAAKC,EACb,EAhICM,OAkJD,SAAoBP,EAAKC,GACxB,OAAOD,EAAKC,EACb,EAnJCO,MAqKD,SAAmBR,EAAKC,GACvB,OAAOD,EAAKC,EACb,EAtKCQ,OAwLD,SAAoBT,EAAKC,GACxB,OAAOD,EAAKC,EACb,EAzLCS,QAyMD,SAAqBV,EAAKC,GACzB,OAAOD,EAAKC,EACb,EA1MCU,QA0ND,SAAuBX,EAAKC,GAC3B,OAAOD,EAAKC,EACb,UAoBA,SAAiBW,GAChB,IAAIC,EAAIf,EAASc,GACjB,MAAkB,mBAANC,EACJA,EAEDf,EAAQa,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 8ad4dc9..0000000 --- a/lib/index.js +++ /dev/null @@ -1,44 +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. -*/ - -'use strict'; - -/** -* Return an accessor function for retrieving an element from an indexed array-like object. -* -* @module @stdlib/array-base-getter -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* var getter = require( '@stdlib/array-base-getter' ); -* -* var arr = [ 1, 2, 3, 4 ]; -* -* var get = getter( dtype( arr ) ); -* var v = get( arr, 2 ); -* // returns 3 -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6b58d24..0000000 --- a/lib/main.js +++ /dev/null @@ -1,285 +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. -*/ - -'use strict'; - -// VARIABLES // - -var GETTERS = { - 'float64': getFloat64, - 'float32': getFloat32, - 'int32': getInt32, - 'int16': getInt16, - 'int8': getInt8, - 'uint32': getUint32, - 'uint16': getUint16, - 'uint8': getUint8, - 'uint8c': getUint8c, - 'generic': getGeneric, - 'default': getArrayLike -}; - - -// FUNCTIONS // - -/** -* Returns an element from a `Float64Array`. -* -* @private -* @param {Float64Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @returns {number} element value -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( [ 1, 2, 3, 4 ] ); -* -* var v = getFloat64( arr, 2 ); -* // returns 3.0 -*/ -function getFloat64( arr, idx ) { - return arr[ idx ]; -} - -/** -* Returns an element from a `Float32Array`. -* -* @private -* @param {Float32Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @returns {number} element value -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( [ 1, 2, 3, 4 ] ); -* -* var v = getFloat32( arr, 2 ); -* // returns 3.0 -*/ -function getFloat32( arr, idx ) { - return arr[ idx ]; -} - -/** -* Returns an element from an `Int32Array`. -* -* @private -* @param {Int32Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @returns {number} element value -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( [ 1, 2, 3, 4 ] ); -* -* var v = getInt32( arr, 2 ); -* // returns 3 -*/ -function getInt32( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point - return arr[ idx ]; -} - -/** -* Returns an element from an `Int16Array`. -* -* @private -* @param {Int16Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @returns {number} element value -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( [ 1, 2, 3, 4 ] ); -* -* var v = getInt16( arr, 2 ); -* // returns 3 -*/ -function getInt16( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point - return arr[ idx ]; -} - -/** -* Returns an element from an `Int8Array`. -* -* @private -* @param {Int8Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @returns {number} element value -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( [ 1, 2, 3, 4 ] ); -* -* var v = getInt8( arr, 2 ); -* // returns 3 -*/ -function getInt8( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point - return arr[ idx ]; -} - -/** -* Returns an element from a `Uint32Array`. -* -* @private -* @param {Uint32Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @returns {number} element value -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( [ 1, 2, 3, 4 ] ); -* -* var v = getUint32( arr, 2 ); -* // returns 3 -*/ -function getUint32( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point - return arr[ idx ]; -} - -/** -* Returns an element from a `Uint16Array`. -* -* @private -* @param {Uint16Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @returns {number} element value -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( [ 1, 2, 3, 4 ] ); -* -* var v = getUint16( arr, 2 ); -* // returns 3 -*/ -function getUint16( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point - return arr[ idx ]; -} - -/** -* Returns an element from a `Uint8Array`. -* -* @private -* @param {Uint8Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @returns {number} element value -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( [ 1, 2, 3, 4 ] ); -* -* var v = getUint8( arr, 2 ); -* // returns 3 -*/ -function getUint8( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point - return arr[ idx ]; -} - -/** -* Returns an element from a `Uint8ClampedArray`. -* -* @private -* @param {Uint8ClampedArray} arr - input array -* @param {NonNegativeInteger} idx - element index -* @returns {number} element value -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); -* -* var v = getUint8c( arr, 2 ); -* // returns 3 -*/ -function getUint8c( arr, idx ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point - return arr[ idx ]; -} - -/** -* Returns an element from a generic `Array`. -* -* @private -* @param {Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @returns {*} element value -* -* @example -* var arr = [ 1, 2, 3, 4 ]; -* -* var v = getGeneric( arr, 2 ); -* // returns 3 -*/ -function getGeneric( arr, idx ) { - return arr[ idx ]; -} - -/** -* Returns an element from an indexed array-like object. -* -* @private -* @param {Collection} arr - input array -* @param {NonNegativeInteger} idx - element index -* @returns {*} element value -* -* @example -* var arr = [ 1, 2, 3, 4 ]; -* -* var v = getArrayLike( arr, 2 ); -* // returns 3 -*/ -function getArrayLike( arr, idx ) { - return arr[ idx ]; -} - - -// MAIN // - -/** -* Returns an accessor function for retrieving an element from an indexed array-like object. -* -* @param {string} dtype - array dtype -* @returns {Function} accessor -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 1, 2, 3, 4 ]; -* -* var get = getter( dtype( arr ) ); -* var v = get( arr, 2 ); -* // returns 3 -*/ -function getter( dtype ) { - var f = GETTERS[ dtype ]; - if ( typeof f === 'function' ) { - return f; - } - return GETTERS.default; -} - - -// EXPORTS // - -module.exports = getter; diff --git a/package.json b/package.json index dcc57da..251d8c7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,7 @@ "version": "0.2.2", "description": "Return an accessor function for retrieving an element from an indexed array-like object.", "license": "Apache-2.0", - "author": { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - }, - "contributors": [ - { - "name": "The Stdlib Authors", - "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" - } - ], - "main": "./lib", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "main": "./index.js", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,38 +12,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/types": "^0.4.3" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", diff --git a/stats_browser.html b/stats_browser.html new file mode 100644 index 0000000..7dc13e9 --- /dev/null +++ b/stats_browser.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/stats_node.html b/stats_node.html new file mode 100644 index 0000000..db1c0ed --- /dev/null +++ b/stats_node.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 76da60e..0000000 --- a/test/test.js +++ /dev/null @@ -1,101 +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. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var filled = require( '@stdlib/array-filled' ); -var dtypes = require( '@stdlib/array-typed-real-dtypes' ); -var getter = require( './../lib' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof getter, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns a function for returning an array element', function test( t ) { - var arr; - var get; - var dt; - var v; - var i; - - for ( i = 0; i < DTYPES.length; i++ ) { - dt = DTYPES[ i ]; - get = getter( dt ); - arr = filled( i+1, 10, dt ); - v = get( arr, 2 ); - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } - t.end(); -}); - -tape( 'the function returns a function for returning an array element (unrecognized dtype)', function test( t ) { - var arr; - var get; - var v; - - get = getter( 'foo' ); - arr = filled( 2, 10, 'generic' ); - v = get( arr, 2 ); - t.strictEqual( v, 2, 'returns expected value' ); - - t.end(); -}); - -tape( 'the returned function does not perform bounds checks', function test( t ) { - var arr; - var get; - var dt; - var v; - var i; - - for ( i = 0; i < DTYPES.length; i++ ) { - dt = DTYPES[ i ]; - get = getter( dt ); - arr = filled( i+1, 10, dt ); - v = get( arr, arr.length+10 ); - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var get; - var v; - - get = getter( 'foo' ); - arr = filled( 2, 10, 'generic' ); - v = get( arr, arr.length+10 ); - t.strictEqual( v, void 0, 'returns expected value' ); - - t.end(); -});