diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index e0caa28..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/setter) 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 0fa1881..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/setter) 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 87409c6..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: '35 23 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -192,7 +183,7 @@ console.log( arr ); ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. @@ -255,7 +246,7 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-setter/main/LICENSE -[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes +[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index adb8de9..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,332 +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 format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var setter = require( './../lib' ); - - -// VARIABLES // - -var rand = discreteUniform( 0, 127 ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var set; - var dt; - var i; - - dt = dtypes(); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - set = setter( dt[ i%dt.length ] ); - if ( typeof set !== 'function' ) { - b.fail( 'should return a function' ); - } - } - b.toc(); - if ( !isFunction( set ) ) { - b.fail( 'should return a function' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s:dtype=generic', pkg ), function benchmark( b ) { - var arr; - var set; - var i; - var j; - var v; - - arr = filledBy( 100, 'generic', rand ); - set = setter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - j = i % arr.length; - set( arr, j, i%128 ); - v = arr[ j ]; - 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( format( '%s:dtype=float64', pkg ), function benchmark( b ) { - var arr; - var set; - var i; - var j; - var v; - - arr = filledBy( 100, 'float64', rand ); - set = setter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - j = i % arr.length; - set( arr, j, i%128 ); - v = arr[ j ]; - 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( format( '%s:dtype=float32', pkg ), function benchmark( b ) { - var arr; - var set; - var i; - var j; - var v; - - arr = filledBy( 100, 'float32', rand ); - set = setter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - j = i % arr.length; - set( arr, j, i%128 ); - v = arr[ j ]; - 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( format( '%s:dtype=int32', pkg ), function benchmark( b ) { - var arr; - var set; - var i; - var j; - var v; - - arr = filledBy( 100, 'int32', rand ); - set = setter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - j = i % arr.length; - set( arr, j, i%128 ); - v = arr[ j ]; - 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( format( '%s:dtype=int16', pkg ), function benchmark( b ) { - var arr; - var set; - var i; - var j; - var v; - - arr = filledBy( 100, 'int16', rand ); - set = setter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - j = i % arr.length; - set( arr, j, i%128 ); - v = arr[ j ]; - 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( format( '%s:dtype=int8', pkg ), function benchmark( b ) { - var arr; - var set; - var i; - var j; - var v; - - arr = filledBy( 100, 'int8', rand ); - set = setter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - j = i % arr.length; - set( arr, j, i%128 ); - v = arr[ j ]; - 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( format( '%s:dtype=uint32', pkg ), function benchmark( b ) { - var arr; - var set; - var i; - var j; - var v; - - arr = filledBy( 100, 'uint32', rand ); - set = setter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - j = i % arr.length; - set( arr, j, i%128 ); - v = arr[ j ]; - 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( format( '%s:dtype=uint16', pkg ), function benchmark( b ) { - var arr; - var set; - var i; - var j; - var v; - - arr = filledBy( 100, 'uint16', rand ); - set = setter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - j = i % arr.length; - set( arr, j, i%128 ); - v = arr[ j ]; - 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( format( '%s:dtype=uint8', pkg ), function benchmark( b ) { - var arr; - var set; - var i; - var j; - var v; - - arr = filledBy( 100, 'uint8', rand ); - set = setter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - j = i % arr.length; - set( arr, j, i%128 ); - v = arr[ j ]; - 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( format( '%s:dtype=uint8c', pkg ), function benchmark( b ) { - var arr; - var set; - var i; - var j; - var v; - - arr = filledBy( 100, 'uint8c', rand ); - set = setter( dtype( arr ) ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - j = i % arr.length; - set( arr, j, i%128 ); - v = arr[ j ]; - 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 b7cc67d..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/setter" -%% click B href "https://github.com/stdlib-js/array-base-setter/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-setter/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-setter/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-setter/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-setter/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/setter -[production-url]: https://github.com/stdlib-js/array-base-setter/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-setter/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-setter/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-setter/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-setter/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index af95cdd..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import setter from '../docs/types/index'; -export = setter; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 9b022b1..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var f=function(n,t){return function(){try{return t||n((t={exports:{}}).exports,t),t.exports}catch(i){throw (t=0, i)}};};var o=f(function(T,u){ -var e={float64:c,float32:s,float16:r,int32:a,int16:l,int8:U,uint32:p,uint16:v,uint8:F,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function s(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function a(n,t,i){n[t]=i}function l(n,t,i){n[t]=i}function U(n,t,i){n[t]=i}function p(n,t,i){n[t]=i}function v(n,t,i){n[t]=i}function F(n,t,i){n[t]=i}function I(n,t,i){n[t]=i}function d(n,t,i){n[t]=i}function x(n,t,i){n[t]=i}function y(n){var t=e[n];return typeof t=="function"?t:e.default}u.exports=y -});var E=o();module.exports=E; -/** @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 62f3a65..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 SETTERS = {\n\t'float64': setFloat64,\n\t'float32': setFloat32,\n\t'float16': setFloat16,\n\t'int32': setInt32,\n\t'int16': setInt16,\n\t'int8': setInt8,\n\t'uint32': setUint32,\n\t'uint16': setUint16,\n\t'uint8': setUint8,\n\t'uint8c': setUint8c,\n\t'generic': setGeneric,\n\t'default': setArrayLike\n};\n\n\n// FUNCTIONS //\n\n/**\n* Sets an element in a `Float64Array`.\n*\n* @private\n* @param {Float64Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var arr = new Float64Array( 4 );\n*\n* setFloat64( arr, 2, 3.0 );\n*\n* var v = arr[ 2 ];\n* // returns 3.0\n*/\nfunction setFloat64( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in a `Float32Array`.\n*\n* @private\n* @param {Float32Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* var Float32Array = require( '@stdlib/array-float32' );\n*\n* var arr = new Float32Array( 4 );\n*\n* setFloat32( arr, 2, 3.0 );\n*\n* var v = arr[ 2 ];\n* // returns 3.0\n*/\nfunction setFloat32( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in a `Float16Array`.\n*\n* @private\n* @param {Float16Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* var Float16Array = require( '@stdlib/array-float16' );\n*\n* var arr = new Float16Array( 4 );\n*\n* setFloat16( arr, 2, 3.0 );\n*\n* var v = arr[ 2 ];\n* // returns 3.0\n*/\nfunction setFloat16( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in an `Int32Array`.\n*\n* @private\n* @param {Int32Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* var Int32Array = require( '@stdlib/array-int32' );\n*\n* var arr = new Int32Array( 4 );\n*\n* setInt32( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setInt32( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in an `Int16Array`.\n*\n* @private\n* @param {Int16Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* var Int16Array = require( '@stdlib/array-int16' );\n*\n* var arr = new Int16Array( 4 );\n*\n* setInt16( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setInt16( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in an `Int8Array`.\n*\n* @private\n* @param {Int8Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* var Int8Array = require( '@stdlib/array-int8' );\n*\n* var arr = new Int8Array( 4 );\n*\n* setInt8( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setInt8( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in a `Uint32Array`.\n*\n* @private\n* @param {Uint32Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* var Uint32Array = require( '@stdlib/array-uint32' );\n*\n* var arr = new Uint32Array( 4 );\n*\n* setUint32( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setUint32( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in a `Uint16Array`.\n*\n* @private\n* @param {Uint16Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* var Uint16Array = require( '@stdlib/array-uint16' );\n*\n* var arr = new Uint16Array( 4 );\n*\n* setUint16( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setUint16( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in a `Uint8Array`.\n*\n* @private\n* @param {Uint8Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* var Uint8Array = require( '@stdlib/array-uint8' );\n*\n* var arr = new Uint8Array( 4 );\n*\n* setUint8( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setUint8( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in a `Uint8ClampedArray`.\n*\n* @private\n* @param {Uint8ClampedArray} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* var Uint8ClampedArray = require( '@stdlib/array-uint8c' );\n*\n* var arr = new Uint8ClampedArray( 4 );\n*\n* setUint8c( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setUint8c( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in a generic `Array`.\n*\n* @private\n* @param {Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {*} value - value to set\n*\n* @example\n* var arr = [ 1, 2, 3, 4 ];\n*\n* setGeneric( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setGeneric( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in an indexed array-like object.\n*\n* @private\n* @param {Collection} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {*} value - value to set\n*\n* @example\n* var arr = [ 1, 2, 3, 4 ];\n*\n* setArrayLike( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setArrayLike( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n\n// MAIN //\n\n/**\n* Returns an accessor function for setting an element in 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 set = setter( dtype( arr ) );\n* set( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setter( dtype ) {\n\tvar f = SETTERS[ dtype ];\n\tif ( typeof f === 'function' ) {\n\t\treturn f;\n\t}\n\treturn SETTERS.default;\n}\n\n\n// EXPORTS //\n\nmodule.exports = setter;\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 setting an element in an indexed array-like object.\n*\n* @module @stdlib/array-base-setter\n*\n* @example\n* var dtype = require( '@stdlib/array-dtype' );\n* var setter = require( '@stdlib/array-base-setter' );\n*\n* var arr = [ 1, 2, 3, 4 ];\n*\n* var set = setter( dtype( arr ) );\n* set( arr, 2, 10 );\n*\n* var v = arr[ 2 ];\n* // returns 10\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASX,EAAYY,EAAKC,EAAKC,EAAQ,CACtCF,EAAKC,CAAI,EAAIC,CACd,CAoBA,SAASb,EAAYW,EAAKC,EAAKC,EAAQ,CACtCF,EAAKC,CAAI,EAAIC,CACd,CAoBA,SAASZ,EAAYU,EAAKC,EAAKC,EAAQ,CACtCF,EAAKC,CAAI,EAAIC,CACd,CAoBA,SAASX,EAAUS,EAAKC,EAAKC,EAAQ,CACpCF,EAAKC,CAAI,EAAIC,CACd,CAoBA,SAASV,EAAUQ,EAAKC,EAAKC,EAAQ,CACpCF,EAAKC,CAAI,EAAIC,CACd,CAoBA,SAAST,EAASO,EAAKC,EAAKC,EAAQ,CACnCF,EAAKC,CAAI,EAAIC,CACd,CAoBA,SAASR,EAAWM,EAAKC,EAAKC,EAAQ,CACrCF,EAAKC,CAAI,EAAIC,CACd,CAoBA,SAASP,EAAWK,EAAKC,EAAKC,EAAQ,CACrCF,EAAKC,CAAI,EAAIC,CACd,CAoBA,SAASN,EAAUI,EAAKC,EAAKC,EAAQ,CACpCF,EAAKC,CAAI,EAAIC,CACd,CAoBA,SAASL,EAAWG,EAAKC,EAAKC,EAAQ,CACrCF,EAAKC,CAAI,EAAIC,CACd,CAkBA,SAASJ,EAAYE,EAAKC,EAAKC,EAAQ,CACtCF,EAAKC,CAAI,EAAIC,CACd,CAkBA,SAASH,EAAcC,EAAKC,EAAKC,EAAQ,CACxCF,EAAKC,CAAI,EAAIC,CACd,CAsBA,SAASC,EAAQC,EAAQ,CACxB,IAAIC,EAAIlB,EAASiB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDlB,EAAQ,OAChB,CAKAD,EAAO,QAAUiB,ICnSjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "setFloat16", "setInt32", "setInt16", "setInt8", "setUint32", "setUint16", "setUint8", "setUint8c", "setGeneric", "setArrayLike", "arr", "idx", "value", "setter", "dtype", "f", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index e41d7c7..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,52 +0,0 @@ - -{{alias}}( dtype ) - Returns an accessor function for setting an element in an indexed array-like - object. - - An accessor function accepts the following arguments: - - - arr: input array. - - idx: element index. - - value: value to set. - - If provided an unsupported `dtype`, the function returns a default accessor - function for accessing elements in 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. - - Accessor functions do *not* validate input values. - - Parameters - ---------- - dtype: string - Array data type. - - Returns - ------- - f: Function - Accessor function. - - Examples - -------- - > var f = {{alias}}( 'generic' ); - > var x = [ 1, 2, 3, 4 ]; - > f( x, 2, 10 ); - > x - [ 1, 2, 10, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 56fb4f8..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,396 +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 setter = require( './index' ); - - -// TESTS // - -// The function returns a function... -{ - setter( 'float64' ); // $ExpectType SetFloat64 - setter( 'float32' ); // $ExpectType SetFloat32 - setter( 'int32' ); // $ExpectType SetInt32 - setter( 'int16' ); // $ExpectType SetInt16 - setter( 'int8' ); // $ExpectType SetInt8 - setter( 'uint32' ); // $ExpectType SetUint32 - setter( 'uint16' ); // $ExpectType SetUint16 - setter( 'uint8' ); // $ExpectType SetUint8 - setter( 'uint8c' ); // $ExpectType SetUint8c - setter( 'generic' ); // $ExpectType SetGeneric - setter( 'foo' ); // $ExpectType SetArrayLike -} - -// The compiler throws an error if the function is provided a first argument which is not a string... -{ - setter( 5 ); // $ExpectError - setter( true ); // $ExpectError - setter( false ); // $ExpectError - setter( null ); // $ExpectError - setter( {} ); // $ExpectError - setter( [] ); // $ExpectError - setter( ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - setter(); // $ExpectError - setter( 'float64', {} ); // $ExpectError -} - -// The function returns a function which sets an array element... -{ - const set1 = setter( 'generic' ); - const x1 = [ 1, 2, 3, 4 ]; - set1( x1, 2, 3 ); // $ExpectType void - - const set2 = setter( 'float64' ); - const x2 = new Float64Array( [ 1, 2, 3, 4 ] ); - set2( x2, 2, 3 ); // $ExpectType void - - const set3 = setter( 'float32' ); - const x3 = new Float32Array( [ 1, 2, 3, 4 ] ); - set3( x3, 2, 3 ); // $ExpectType void - - const set4 = setter( 'int32' ); - const x4 = new Int32Array( [ 1, 2, 3, 4 ] ); - set4( x4, 2, 3 ); // $ExpectType void - - const set5 = setter( 'int16' ); - const x5 = new Int16Array( [ 1, 2, 3, 4 ] ); - set5( x5, 2, 3 ); // $ExpectType void - - const set6 = setter( 'int8' ); - const x6 = new Int8Array( [ 1, 2, 3, 4 ] ); - set6( x6, 2, 3 ); // $ExpectType void - - const set7 = setter( 'uint32' ); - const x7 = new Uint32Array( [ 1, 2, 3, 4 ] ); - set7( x7, 2, 3 ); // $ExpectType void - - const set8 = setter( 'uint16' ); - const x8 = new Uint16Array( [ 1, 2, 3, 4 ] ); - set8( x8, 2, 3 ); // $ExpectType void - - const set9 = setter( 'uint8' ); - const x9 = new Uint8Array( [ 1, 2, 3, 4 ] ); - set9( x9, 2, 3 ); // $ExpectType void - - const set10 = setter( 'uint8c' ); - const x10 = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); - set10( x10, 2, 3 ); // $ExpectType void - - const set11 = setter( 'foo' ); - const x11 = [ 1, 2, 3, 4 ]; - set11( x11, 2, 3 ); // $ExpectType void -} - -// The compiler throws an error if the returned function is provided a first argument which is not a collection... -{ - const set1 = setter( 'generic' ); - set1( 5, 2, 3 ); // $ExpectError - set1( true, 2, 3 ); // $ExpectError - set1( false, 2, 3 ); // $ExpectError - set1( null, 2, 3 ); // $ExpectError - set1( {}, 2, 3 ); // $ExpectError - - const set2 = setter( 'float64' ); - set2( 5, 2, 3 ); // $ExpectError - set2( true, 2, 3 ); // $ExpectError - set2( false, 2, 3 ); // $ExpectError - set2( null, 2, 3 ); // $ExpectError - set2( {}, 2, 3 ); // $ExpectError - - const set3 = setter( 'float32' ); - set3( 5, 2, 3 ); // $ExpectError - set3( true, 2, 3 ); // $ExpectError - set3( false, 2, 3 ); // $ExpectError - set3( null, 2, 3 ); // $ExpectError - set3( {}, 2, 3 ); // $ExpectError - - const set4 = setter( 'int32' ); - set4( 5, 2, 3 ); // $ExpectError - set4( true, 2, 3 ); // $ExpectError - set4( false, 2, 3 ); // $ExpectError - set4( null, 2, 3 ); // $ExpectError - set4( {}, 2, 3 ); // $ExpectError - - const set5 = setter( 'int16' ); - set5( 5, 2, 3 ); // $ExpectError - set5( true, 2, 3 ); // $ExpectError - set5( false, 2, 3 ); // $ExpectError - set5( null, 2, 3 ); // $ExpectError - set5( {}, 2, 3 ); // $ExpectError - - const set6 = setter( 'int8' ); - set6( 5, 2, 3 ); // $ExpectError - set6( true, 2, 3 ); // $ExpectError - set6( false, 2, 3 ); // $ExpectError - set6( null, 2, 3 ); // $ExpectError - set6( {}, 2, 3 ); // $ExpectError - - const set7 = setter( 'uint32' ); - set7( 5, 2, 3 ); // $ExpectError - set7( true, 2, 3 ); // $ExpectError - set7( false, 2, 3 ); // $ExpectError - set7( null, 2, 3 ); // $ExpectError - set7( {}, 2, 3 ); // $ExpectError - - const set8 = setter( 'uint16' ); - set8( 5, 2, 3 ); // $ExpectError - set8( true, 2, 3 ); // $ExpectError - set8( false, 2, 3 ); // $ExpectError - set8( null, 2, 3 ); // $ExpectError - set8( {}, 2, 3 ); // $ExpectError - - const set9 = setter( 'uint8' ); - set9( 5, 2, 3 ); // $ExpectError - set9( true, 2, 3 ); // $ExpectError - set9( false, 2, 3 ); // $ExpectError - set9( null, 2, 3 ); // $ExpectError - set9( {}, 2, 3 ); // $ExpectError - - const set10 = setter( 'uint8c' ); - set10( 5, 2, 3 ); // $ExpectError - set10( true, 2, 3 ); // $ExpectError - set10( false, 2, 3 ); // $ExpectError - set10( null, 2, 3 ); // $ExpectError - set10( {}, 2, 3 ); // $ExpectError - - const set11 = setter( 'foo' ); - set11( 5, 2, 3 ); // $ExpectError - set11( true, 2, 3 ); // $ExpectError - set11( false, 2, 3 ); // $ExpectError - set11( null, 2, 3 ); // $ExpectError - set11( {}, 2, 3 ); // $ExpectError -} - -// The compiler throws an error if the returned function is provided a second argument which is not a number... -{ - const set1 = setter( 'generic' ); - set1( [ 1, 2, 3, 4 ], '5', 3 ); // $ExpectError - set1( [ 1, 2, 3, 4 ], true, 3 ); // $ExpectError - set1( [ 1, 2, 3, 4 ], false, 3 ); // $ExpectError - set1( [ 1, 2, 3, 4 ], null, 3 ); // $ExpectError - set1( [ 1, 2, 3, 4 ], {}, 3 ); // $ExpectError - - const set2 = setter( 'float64' ); - set2( new Float64Array( [ 1, 2, 3, 4 ] ), '5', 3 ); // $ExpectError - set2( new Float64Array( [ 1, 2, 3, 4 ] ), true, 3 ); // $ExpectError - set2( new Float64Array( [ 1, 2, 3, 4 ] ), false, 3 ); // $ExpectError - set2( new Float64Array( [ 1, 2, 3, 4 ] ), null, 3 ); // $ExpectError - set2( new Float64Array( [ 1, 2, 3, 4 ] ), {}, 3 ); // $ExpectError - - const set3 = setter( 'float32' ); - set3( new Float32Array( [ 1, 2, 3, 4 ] ), '5', 3 ); // $ExpectError - set3( new Float32Array( [ 1, 2, 3, 4 ] ), true, 3 ); // $ExpectError - set3( new Float32Array( [ 1, 2, 3, 4 ] ), false, 3 ); // $ExpectError - set3( new Float32Array( [ 1, 2, 3, 4 ] ), null, 3 ); // $ExpectError - set3( new Float32Array( [ 1, 2, 3, 4 ] ), {}, 3 ); // $ExpectError - - const set4 = setter( 'int32' ); - set4( new Int32Array( [ 1, 2, 3, 4 ] ), '5', 3 ); // $ExpectError - set4( new Int32Array( [ 1, 2, 3, 4 ] ), true, 3 ); // $ExpectError - set4( new Int32Array( [ 1, 2, 3, 4 ] ), false, 3 ); // $ExpectError - set4( new Int32Array( [ 1, 2, 3, 4 ] ), null, 3 ); // $ExpectError - set4( new Int32Array( [ 1, 2, 3, 4 ] ), {}, 3 ); // $ExpectError - - const set5 = setter( 'int16' ); - set5( new Int16Array( [ 1, 2, 3, 4 ] ), '5', 3 ); // $ExpectError - set5( new Int16Array( [ 1, 2, 3, 4 ] ), true, 3 ); // $ExpectError - set5( new Int16Array( [ 1, 2, 3, 4 ] ), false, 3 ); // $ExpectError - set5( new Int16Array( [ 1, 2, 3, 4 ] ), null, 3 ); // $ExpectError - set5( new Int16Array( [ 1, 2, 3, 4 ] ), {}, 3 ); // $ExpectError - - const set6 = setter( 'int8' ); - set6( new Int8Array( [ 1, 2, 3, 4 ] ), '5', 3 ); // $ExpectError - set6( new Int8Array( [ 1, 2, 3, 4 ] ), true, 3 ); // $ExpectError - set6( new Int8Array( [ 1, 2, 3, 4 ] ), false, 3 ); // $ExpectError - set6( new Int8Array( [ 1, 2, 3, 4 ] ), null, 3 ); // $ExpectError - set6( new Int8Array( [ 1, 2, 3, 4 ] ), {}, 3 ); // $ExpectError - - const set7 = setter( 'uint32' ); - set7( new Uint32Array( [ 1, 2, 3, 4 ] ), '5', 3 ); // $ExpectError - set7( new Uint32Array( [ 1, 2, 3, 4 ] ), true, 3 ); // $ExpectError - set7( new Uint32Array( [ 1, 2, 3, 4 ] ), false, 3 ); // $ExpectError - set7( new Uint32Array( [ 1, 2, 3, 4 ] ), null, 3 ); // $ExpectError - set7( new Uint32Array( [ 1, 2, 3, 4 ] ), {}, 3 ); // $ExpectError - - const set8 = setter( 'uint16' ); - set8( new Uint16Array( [ 1, 2, 3, 4 ] ), '5', 3 ); // $ExpectError - set8( new Uint16Array( [ 1, 2, 3, 4 ] ), true, 3 ); // $ExpectError - set8( new Uint16Array( [ 1, 2, 3, 4 ] ), false, 3 ); // $ExpectError - set8( new Uint16Array( [ 1, 2, 3, 4 ] ), null, 3 ); // $ExpectError - set8( new Uint16Array( [ 1, 2, 3, 4 ] ), {}, 3 ); // $ExpectError - - const set9 = setter( 'uint8' ); - set9( new Uint8Array( [ 1, 2, 3, 4 ] ), '5', 3 ); // $ExpectError - set9( new Uint8Array( [ 1, 2, 3, 4 ] ), true, 3 ); // $ExpectError - set9( new Uint8Array( [ 1, 2, 3, 4 ] ), false, 3 ); // $ExpectError - set9( new Uint8Array( [ 1, 2, 3, 4 ] ), null, 3 ); // $ExpectError - set9( new Uint8Array( [ 1, 2, 3, 4 ] ), {}, 3 ); // $ExpectError - - const set10 = setter( 'uint8c' ); - set10( new Uint8ClampedArray( [ 1, 2, 3, 4 ] ), '5', 3 ); // $ExpectError - set10( new Uint8ClampedArray( [ 1, 2, 3, 4 ] ), true, 3 ); // $ExpectError - set10( new Uint8ClampedArray( [ 1, 2, 3, 4 ] ), false, 3 ); // $ExpectError - set10( new Uint8ClampedArray( [ 1, 2, 3, 4 ] ), null, 3 ); // $ExpectError - set10( new Uint8ClampedArray( [ 1, 2, 3, 4 ] ), {}, 3 ); // $ExpectError - - const set11 = setter( 'foo' ); - set11( [ 1, 2, 3, 4 ], '5', 3 ); // $ExpectError - set11( [ 1, 2, 3, 4 ], true, 3 ); // $ExpectError - set11( [ 1, 2, 3, 4 ], false, 3 ); // $ExpectError - set11( [ 1, 2, 3, 4 ], null, 3 ); // $ExpectError - set11( [ 1, 2, 3, 4 ], {}, 3 ); // $ExpectError -} - -// The compiler throws an error if the returned function is provided a third argument which is not a valid value... -{ - const set2 = setter( 'float64' ); - set2( new Float64Array( [ 1, 2, 3, 4 ] ), 2, '5' ); // $ExpectError - set2( new Float64Array( [ 1, 2, 3, 4 ] ), 2, true ); // $ExpectError - set2( new Float64Array( [ 1, 2, 3, 4 ] ), 2, false ); // $ExpectError - set2( new Float64Array( [ 1, 2, 3, 4 ] ), 2, null ); // $ExpectError - set2( new Float64Array( [ 1, 2, 3, 4 ] ), 2, {} ); // $ExpectError - - const set3 = setter( 'float32' ); - set3( new Float32Array( [ 1, 2, 3, 4 ] ), 2, '5' ); // $ExpectError - set3( new Float32Array( [ 1, 2, 3, 4 ] ), 2, true ); // $ExpectError - set3( new Float32Array( [ 1, 2, 3, 4 ] ), 2, false ); // $ExpectError - set3( new Float32Array( [ 1, 2, 3, 4 ] ), 2, null ); // $ExpectError - set3( new Float32Array( [ 1, 2, 3, 4 ] ), 2, {} ); // $ExpectError - - const set4 = setter( 'int32' ); - set4( new Int32Array( [ 1, 2, 3, 4 ] ), 2, '5' ); // $ExpectError - set4( new Int32Array( [ 1, 2, 3, 4 ] ), 2, true ); // $ExpectError - set4( new Int32Array( [ 1, 2, 3, 4 ] ), 2, false ); // $ExpectError - set4( new Int32Array( [ 1, 2, 3, 4 ] ), 2, null ); // $ExpectError - set4( new Int32Array( [ 1, 2, 3, 4 ] ), 2, {} ); // $ExpectError - - const set5 = setter( 'int16' ); - set5( new Int16Array( [ 1, 2, 3, 4 ] ), 2, '5' ); // $ExpectError - set5( new Int16Array( [ 1, 2, 3, 4 ] ), 2, true ); // $ExpectError - set5( new Int16Array( [ 1, 2, 3, 4 ] ), 2, false ); // $ExpectError - set5( new Int16Array( [ 1, 2, 3, 4 ] ), 2, null ); // $ExpectError - set5( new Int16Array( [ 1, 2, 3, 4 ] ), 2, {} ); // $ExpectError - - const set6 = setter( 'int8' ); - set6( new Int8Array( [ 1, 2, 3, 4 ] ), 2, '5' ); // $ExpectError - set6( new Int8Array( [ 1, 2, 3, 4 ] ), 2, true ); // $ExpectError - set6( new Int8Array( [ 1, 2, 3, 4 ] ), 2, false ); // $ExpectError - set6( new Int8Array( [ 1, 2, 3, 4 ] ), 2, null ); // $ExpectError - set6( new Int8Array( [ 1, 2, 3, 4 ] ), 2, {} ); // $ExpectError - - const set7 = setter( 'uint32' ); - set7( new Uint32Array( [ 1, 2, 3, 4 ] ), 2, '5' ); // $ExpectError - set7( new Uint32Array( [ 1, 2, 3, 4 ] ), 2, true ); // $ExpectError - set7( new Uint32Array( [ 1, 2, 3, 4 ] ), 2, false ); // $ExpectError - set7( new Uint32Array( [ 1, 2, 3, 4 ] ), 2, null ); // $ExpectError - set7( new Uint32Array( [ 1, 2, 3, 4 ] ), 2, {} ); // $ExpectError - - const set8 = setter( 'uint16' ); - set8( new Uint16Array( [ 1, 2, 3, 4 ] ), 2, '5' ); // $ExpectError - set8( new Uint16Array( [ 1, 2, 3, 4 ] ), 2, true ); // $ExpectError - set8( new Uint16Array( [ 1, 2, 3, 4 ] ), 2, false ); // $ExpectError - set8( new Uint16Array( [ 1, 2, 3, 4 ] ), 2, null ); // $ExpectError - set8( new Uint16Array( [ 1, 2, 3, 4 ] ), 2, {} ); // $ExpectError - - const set9 = setter( 'uint8' ); - set9( new Uint8Array( [ 1, 2, 3, 4 ] ), 2, '5' ); // $ExpectError - set9( new Uint8Array( [ 1, 2, 3, 4 ] ), 2, true ); // $ExpectError - set9( new Uint8Array( [ 1, 2, 3, 4 ] ), 2, false ); // $ExpectError - set9( new Uint8Array( [ 1, 2, 3, 4 ] ), 2, null ); // $ExpectError - set9( new Uint8Array( [ 1, 2, 3, 4 ] ), 2, {} ); // $ExpectError - - const set10 = setter( 'uint8c' ); - set10( new Uint8ClampedArray( [ 1, 2, 3, 4 ] ), 2, '5' ); // $ExpectError - set10( new Uint8ClampedArray( [ 1, 2, 3, 4 ] ), 2, true ); // $ExpectError - set10( new Uint8ClampedArray( [ 1, 2, 3, 4 ] ), 2, false ); // $ExpectError - set10( new Uint8ClampedArray( [ 1, 2, 3, 4 ] ), 2, null ); // $ExpectError - set10( new Uint8ClampedArray( [ 1, 2, 3, 4 ] ), 2, {} ); // $ExpectError -} - -// The compiler throws an error if the returned function is provided an unsupported number of arguments... -{ - const set1 = setter( 'generic' ); - set1(); // $ExpectError - set1( [] ); // $ExpectError - set1( [], 1 ); // $ExpectError - set1( [], 1, 2, 2 ); // $ExpectError - - const set2 = setter( 'float64' ); - set2(); // $ExpectError - set2( new Float64Array( [] ) ); // $ExpectError - set2( new Float64Array( [] ), 1 ); // $ExpectError - set2( new Float64Array( [] ), 1, 2, 2 ); // $ExpectError - - const set3 = setter( 'float32' ); - set3(); // $ExpectError - set3( new Float32Array( [] ) ); // $ExpectError - set3( new Float32Array( [] ), 1 ); // $ExpectError - set3( new Float32Array( [] ), 1, 2, 2 ); // $ExpectError - - const set4 = setter( 'int32' ); - set4(); // $ExpectError - set4( new Int32Array( [] ) ); // $ExpectError - set4( new Int32Array( [] ), 1 ); // $ExpectError - set4( new Int32Array( [] ), 1, 2, 2 ); // $ExpectError - - const set5 = setter( 'int16' ); - set5(); // $ExpectError - set5( new Int16Array( [] ) ); // $ExpectError - set5( new Int16Array( [] ), 1 ); // $ExpectError - set5( new Int16Array( [] ), 1, 2, 2 ); // $ExpectError - - const set6 = setter( 'int8' ); - set6(); // $ExpectError - set6( new Int8Array( [] ) ); // $ExpectError - set6( new Int8Array( [] ), 1 ); // $ExpectError - set6( new Int8Array( [] ), 1, 2, 2 ); // $ExpectError - - const set7 = setter( 'uint32' ); - set7(); // $ExpectError - set7( new Uint32Array( [] ) ); // $ExpectError - set7( new Uint32Array( [] ), 1 ); // $ExpectError - set7( new Uint32Array( [] ), 1, 2, 2 ); // $ExpectError - - const set8 = setter( 'uint16' ); - set8(); // $ExpectError - set8( new Uint16Array( [] ) ); // $ExpectError - set8( new Uint16Array( [] ), 1 ); // $ExpectError - set8( new Uint16Array( [] ), 1, 2, 2 ); // $ExpectError - - const set9 = setter( 'uint8' ); - set9(); // $ExpectError - set9( new Uint8Array( [] ) ); // $ExpectError - set9( new Uint8Array( [] ), 1 ); // $ExpectError - set9( new Uint8Array( [] ), 1, 2, 2 ); // $ExpectError - - const set10 = setter( 'uint8c' ); - set10(); // $ExpectError - set10( new Uint8ClampedArray( [] ) ); // $ExpectError - set10( new Uint8ClampedArray( [] ), 1 ); // $ExpectError - set10( new Uint8ClampedArray( [] ), 1, 2, 2 ); // $ExpectError - - const set11 = setter( 'foo' ); - set11(); // $ExpectError - set11( [] ); // $ExpectError - set11( [], 1 ); // $ExpectError - set11( [], 1, 2, 2 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 24bb023..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 setter = require( './../lib' ); - -var arr = filled( 1.0, 10, 'float64' ); -setter( dtype( arr ) )( arr, 2, 100.0 ); -console.log( arr ); - -arr = filled( 2.0, 10, 'float32' ); -setter( dtype( arr ) )( arr, 2, 100.0 ); -console.log( arr ); - -arr = filled( 3, 10, 'int32' ); -setter( dtype( arr ) )( arr, 2, 100 ); -console.log( arr ); - -arr = filled( 4, 10, 'int16' ); -setter( dtype( arr ) )( arr, 2, 100 ); -console.log( arr ); - -arr = filled( 5, 10, 'int8' ); -setter( dtype( arr ) )( arr, 2, 100 ); -console.log( arr ); - -arr = filled( 6, 10, 'uint32' ); -setter( dtype( arr ) )( arr, 2, 100 ); -console.log( arr ); - -arr = filled( 7, 10, 'uint16' ); -setter( dtype( arr ) )( arr, 2, 100 ); -console.log( arr ); - -arr = filled( 8, 10, 'uint8' ); -setter( dtype( arr ) )( arr, 2, 100 ); -console.log( arr ); - -arr = filled( 9, 10, 'uint8c' ); -setter( dtype( arr ) )( arr, 2, 100 ); -console.log( arr ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 39bb27e..f6c72c9 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..90d5bd0 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +var n={float64:function(n,t,i){n[t]=i},float32:function(n,t,i){n[t]=i},float16:function(n,t,i){n[t]=i},int32:function(n,t,i){n[t]=i},int16:function(n,t,i){n[t]=i},int8:function(n,t,i){n[t]=i},uint32:function(n,t,i){n[t]=i},uint16:function(n,t,i){n[t]=i},uint8:function(n,t,i){n[t]=i},uint8c:function(n,t,i){n[t]=i},generic:function(n,t,i){n[t]=i},default:function(n,t,i){n[t]=i}};function t(t){var i=n[t];return"function"==typeof i?i:n.default}export{t as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..96cf1d6 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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 SETTERS = {\n\t'float64': setFloat64,\n\t'float32': setFloat32,\n\t'float16': setFloat16,\n\t'int32': setInt32,\n\t'int16': setInt16,\n\t'int8': setInt8,\n\t'uint32': setUint32,\n\t'uint16': setUint16,\n\t'uint8': setUint8,\n\t'uint8c': setUint8c,\n\t'generic': setGeneric,\n\t'default': setArrayLike\n};\n\n\n// FUNCTIONS //\n\n/**\n* Sets an element in a `Float64Array`.\n*\n* @private\n* @param {Float64Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var arr = new Float64Array( 4 );\n*\n* setFloat64( arr, 2, 3.0 );\n*\n* var v = arr[ 2 ];\n* // returns 3.0\n*/\nfunction setFloat64( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in a `Float32Array`.\n*\n* @private\n* @param {Float32Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* import Float32Array from '@stdlib/array-float32';\n*\n* var arr = new Float32Array( 4 );\n*\n* setFloat32( arr, 2, 3.0 );\n*\n* var v = arr[ 2 ];\n* // returns 3.0\n*/\nfunction setFloat32( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in a `Float16Array`.\n*\n* @private\n* @param {Float16Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* import Float16Array from '@stdlib/array-float16';\n*\n* var arr = new Float16Array( 4 );\n*\n* setFloat16( arr, 2, 3.0 );\n*\n* var v = arr[ 2 ];\n* // returns 3.0\n*/\nfunction setFloat16( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in an `Int32Array`.\n*\n* @private\n* @param {Int32Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* import Int32Array from '@stdlib/array-int32';\n*\n* var arr = new Int32Array( 4 );\n*\n* setInt32( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setInt32( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in an `Int16Array`.\n*\n* @private\n* @param {Int16Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* import Int16Array from '@stdlib/array-int16';\n*\n* var arr = new Int16Array( 4 );\n*\n* setInt16( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setInt16( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in an `Int8Array`.\n*\n* @private\n* @param {Int8Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* import Int8Array from '@stdlib/array-int8';\n*\n* var arr = new Int8Array( 4 );\n*\n* setInt8( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setInt8( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in a `Uint32Array`.\n*\n* @private\n* @param {Uint32Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* import Uint32Array from '@stdlib/array-uint32';\n*\n* var arr = new Uint32Array( 4 );\n*\n* setUint32( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setUint32( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in a `Uint16Array`.\n*\n* @private\n* @param {Uint16Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* import Uint16Array from '@stdlib/array-uint16';\n*\n* var arr = new Uint16Array( 4 );\n*\n* setUint16( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setUint16( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in a `Uint8Array`.\n*\n* @private\n* @param {Uint8Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* import Uint8Array from '@stdlib/array-uint8';\n*\n* var arr = new Uint8Array( 4 );\n*\n* setUint8( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setUint8( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in a `Uint8ClampedArray`.\n*\n* @private\n* @param {Uint8ClampedArray} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {number} value - value to set\n*\n* @example\n* import Uint8ClampedArray from '@stdlib/array-uint8c';\n*\n* var arr = new Uint8ClampedArray( 4 );\n*\n* setUint8c( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setUint8c( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in a generic `Array`.\n*\n* @private\n* @param {Array} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {*} value - value to set\n*\n* @example\n* var arr = [ 1, 2, 3, 4 ];\n*\n* setGeneric( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setGeneric( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n/**\n* Sets an element in an indexed array-like object.\n*\n* @private\n* @param {Collection} arr - input array\n* @param {NonNegativeInteger} idx - element index\n* @param {*} value - value to set\n*\n* @example\n* var arr = [ 1, 2, 3, 4 ];\n*\n* setArrayLike( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setArrayLike( arr, idx, value ) {\n\tarr[ idx ] = value;\n}\n\n\n// MAIN //\n\n/**\n* Returns an accessor function for setting an element in 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 set = setter( dtype( arr ) );\n* set( arr, 2, 3 );\n*\n* var v = arr[ 2 ];\n* // returns 3\n*/\nfunction setter( dtype ) {\n\tvar f = SETTERS[ dtype ];\n\tif ( typeof f === 'function' ) {\n\t\treturn f;\n\t}\n\treturn SETTERS.default;\n}\n\n\n// EXPORTS //\n\nexport default setter;\n"],"names":["SETTERS","float64","arr","idx","value","float32","float16","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAmCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EApCCC,QAwDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAzDCE,QA6ED,SAAqBJ,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9ECG,MAkGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAnGCI,MAuHD,SAAmBN,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAxHCK,KA4ID,SAAkBP,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EA7ICM,OAiKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAlKCO,OAsLD,SAAoBT,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAvLCQ,MA2MD,SAAmBV,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA5MCS,OAgOD,SAAoBX,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjOCU,QAmPD,SAAqBZ,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EApPCW,QAsQD,SAAuBb,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASY,EAAQC,GAChB,IAAIC,EAAIlB,EAASiB,GACjB,MAAkB,mBAANC,EACJA,EAEDlB,EAAQe,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e3a60cd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +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 setting an element in an indexed array-like object. -* -* @module @stdlib/array-base-setter -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* var setter = require( '@stdlib/array-base-setter' ); -* -* var arr = [ 1, 2, 3, 4 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 10 ); -* -* var v = arr[ 2 ]; -* // returns 10 -*/ - -// 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 399d926..0000000 --- a/lib/main.js +++ /dev/null @@ -1,332 +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 SETTERS = { - 'float64': setFloat64, - 'float32': setFloat32, - 'float16': setFloat16, - 'int32': setInt32, - 'int16': setInt16, - 'int8': setInt8, - 'uint32': setUint32, - 'uint16': setUint16, - 'uint8': setUint8, - 'uint8c': setUint8c, - 'generic': setGeneric, - 'default': setArrayLike -}; - - -// FUNCTIONS // - -/** -* Sets an element in a `Float64Array`. -* -* @private -* @param {Float64Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @param {number} value - value to set -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* setFloat64( arr, 2, 3.0 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -function setFloat64( arr, idx, value ) { - arr[ idx ] = value; -} - -/** -* Sets an element in a `Float32Array`. -* -* @private -* @param {Float32Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @param {number} value - value to set -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* setFloat32( arr, 2, 3.0 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -function setFloat32( arr, idx, value ) { - arr[ idx ] = value; -} - -/** -* Sets an element in a `Float16Array`. -* -* @private -* @param {Float16Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @param {number} value - value to set -* -* @example -* var Float16Array = require( '@stdlib/array-float16' ); -* -* var arr = new Float16Array( 4 ); -* -* setFloat16( arr, 2, 3.0 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -function setFloat16( arr, idx, value ) { - arr[ idx ] = value; -} - -/** -* Sets an element in an `Int32Array`. -* -* @private -* @param {Int32Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @param {number} value - value to set -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* setInt32( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -function setInt32( arr, idx, value ) { - arr[ idx ] = value; -} - -/** -* Sets an element in an `Int16Array`. -* -* @private -* @param {Int16Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @param {number} value - value to set -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* setInt16( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -function setInt16( arr, idx, value ) { - arr[ idx ] = value; -} - -/** -* Sets an element in an `Int8Array`. -* -* @private -* @param {Int8Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @param {number} value - value to set -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* setInt8( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -function setInt8( arr, idx, value ) { - arr[ idx ] = value; -} - -/** -* Sets an element in a `Uint32Array`. -* -* @private -* @param {Uint32Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @param {number} value - value to set -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* setUint32( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -function setUint32( arr, idx, value ) { - arr[ idx ] = value; -} - -/** -* Sets an element in a `Uint16Array`. -* -* @private -* @param {Uint16Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @param {number} value - value to set -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* setUint16( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -function setUint16( arr, idx, value ) { - arr[ idx ] = value; -} - -/** -* Sets an element in a `Uint8Array`. -* -* @private -* @param {Uint8Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @param {number} value - value to set -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* setUint8( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -function setUint8( arr, idx, value ) { - arr[ idx ] = value; -} - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @private -* @param {Uint8ClampedArray} arr - input array -* @param {NonNegativeInteger} idx - element index -* @param {number} value - value to set -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* setUint8c( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -function setUint8c( arr, idx, value ) { - arr[ idx ] = value; -} - -/** -* Sets an element in a generic `Array`. -* -* @private -* @param {Array} arr - input array -* @param {NonNegativeInteger} idx - element index -* @param {*} value - value to set -* -* @example -* var arr = [ 1, 2, 3, 4 ]; -* -* setGeneric( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -function setGeneric( arr, idx, value ) { - arr[ idx ] = value; -} - -/** -* Sets an element in an indexed array-like object. -* -* @private -* @param {Collection} arr - input array -* @param {NonNegativeInteger} idx - element index -* @param {*} value - value to set -* -* @example -* var arr = [ 1, 2, 3, 4 ]; -* -* setArrayLike( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -function setArrayLike( arr, idx, value ) { - arr[ idx ] = value; -} - - -// MAIN // - -/** -* Returns an accessor function for setting an element in 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 set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -function setter( dtype ) { - var f = SETTERS[ dtype ]; - if ( typeof f === 'function' ) { - return f; - } - return SETTERS.default; -} - - -// EXPORTS // - -module.exports = setter; diff --git a/package.json b/package.json index b588099..f8899a0 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Return an accessor function for setting an element in 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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,39 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/types": "^0.5.1" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.3.1", - "@stdlib/array-dtypes": "^0.4.1", - "@stdlib/array-filled": "^0.3.1", - "@stdlib/array-filled-by": "^0.3.1", - "@stdlib/array-typed-real-dtypes": "^0.2.3", - "@stdlib/assert-is-function": "^0.2.3", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/random-base-discrete-uniform": "^0.2.2", - "@stdlib/string-format": "^0.2.3", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..b49ede8 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index bad6e9f..0000000 --- a/test/test.js +++ /dev/null @@ -1,105 +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 setter = 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 setter, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns a function for setting an array element', function test( t ) { - var arr; - var set; - var dt; - var v; - var i; - - for ( i = 0; i < DTYPES.length; i++ ) { - dt = DTYPES[ i ]; - set = setter( dt ); - arr = filled( 0, 10, dt ); - set( arr, 2, i+1 ); - v = arr[ 2 ]; - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } - t.end(); -}); - -tape( 'the function returns a function for setting an array element (unrecognized dtype)', function test( t ) { - var arr; - var set; - var v; - - set = setter( 'foo' ); - arr = filled( 2, 10, 'generic' ); - set( arr, 2, 100 ); - v = arr[ 2 ]; - t.strictEqual( v, 100, 'returns expected value' ); - - t.end(); -}); - -tape( 'the returned function does not perform bounds checks', function test( t ) { - var arr; - var set; - var dt; - var v; - var i; - - for ( i = 0; i < DTYPES.length; i++ ) { - dt = DTYPES[ i ]; - set = setter( dt ); - arr = filled( 0, 10, dt ); - set( arr, 20, i+1 ); - v = arr[ 20 ]; - t.strictEqual( ( v === i+1 ) || ( v === void 0 ), true, '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 set; - var v; - - set = setter( 'foo' ); - arr = filled( 0, 10, 'generic' ); - set( arr, 20, 100 ); - v = arr[ 20 ]; - t.strictEqual( v, 100, 'returns expected value' ); - - t.end(); -});