From 628e26c69d383928cb5a472137e7a0a00e0de37c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 6 Dec 2022 03:31:14 +0000 Subject: [PATCH 001/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index bf227d3..c218e73 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.0.x" + "@stdlib/types": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x" }, "devDependencies": { "@stdlib/array-dtype": "^0.0.x", @@ -82,4 +83,4 @@ "type": "patreon", "url": "https://www.patreon.com/athan" } -} +} \ No newline at end of file From 6410e78f4a7da17e7230d9012c5f8b7579e43721 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 6 Dec 2022 03:47:29 +0000 Subject: [PATCH 002/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 781 ---- .github/workflows/publish.yml | 117 - .github/workflows/test.yml | 92 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 183 - .npmignore | 227 -- .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 39 +- benchmark/benchmark.js | 331 -- branches.md | 53 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4044 +++++++++++++++++++++ test/test.js | 109 - 36 files changed, 4069 insertions(+), 4367 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# 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 `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 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 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 bc583ae..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 df8591c..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 37ddb4f..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,781 +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: - -# 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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # 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: | - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\"/\"@stdlib\/error-tools-fmtprodmsg\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^0.0.x'; 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' - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - 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)' - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -179,7 +172,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]. @@ -239,7 +232,7 @@ Copyright © 2016-2022. 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/stdlib +[@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/esm
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 72ad87a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +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' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 41e8058..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 4442c84..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 5ec9327..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 0a12243..b55a53d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..787a813 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2022 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 c218e73..9fdd537 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "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.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.0.x", - "@stdlib/array-dtypes": "^0.0.x", - "@stdlib/array-filled": "^0.0.x", - "@stdlib/array-filled-by": "^0.0.x", - "@stdlib/array-typed-real-dtypes": "^0.0.x", - "@stdlib/assert-is-function": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/math-base-assert-is-nan": "^0.0.x", - "@stdlib/random-base-discrete-uniform": "^0.0.x", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "2.x.x" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "patreon", "url": "https://www.patreon.com/athan" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..dd1d32c --- /dev/null +++ b/stats.html @@ -0,0 +1,4044 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 91216b6c81ca6ff9678abad94beb44120d4db1cf Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Feb 2023 04:34:48 +0000 Subject: [PATCH 003/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 3a2091f..478c41f 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.0.x" + "@stdlib/types": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x" }, "devDependencies": { "@stdlib/array-dtype": "^0.0.x", @@ -82,4 +83,4 @@ "type": "patreon", "url": "https://www.patreon.com/athan" } -} +} \ No newline at end of file From af2e3a49cd9031a732f23d34533246fb02277f67 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Feb 2023 16:59:07 +0000 Subject: [PATCH 004/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4044 ------------------------------------------------- 4 files changed, 4383 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index b55a53d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 2.0 - -/// - -import { Collection } from '@stdlib/types/object'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: any ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: any ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 787a813..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2022 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index dd1d32c..0000000 --- a/stats.html +++ /dev/null @@ -1,4044 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From e71ede9935d0253201a2f0bb028aaa2500146e7f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Feb 2023 17:00:00 +0000 Subject: [PATCH 005/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 791 --- .github/workflows/publish.yml | 117 - .github/workflows/test.yml | 92 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 184 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- benchmark/benchmark.js | 331 -- branches.md | 53 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 109 - 37 files changed, 6202 insertions(+), 4379 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# 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 `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 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 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 71da2dd..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-02-01T02:16:22.333Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 bc583ae..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 df8591c..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 f4eea88..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,791 +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 - -# 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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # 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: | - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\"/\"@stdlib\/error-tools-fmtprodmsg\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^0.0.x'; 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -179,7 +172,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]. @@ -239,7 +232,7 @@ Copyright © 2016-2023. 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/stdlib +[@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/esm
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 72ad87a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +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' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 41e8058..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 4442c84..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 5ec9327..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 0a12243..b55a53d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..0158300 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 478c41f..9fdd537 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "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.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.0.x", - "@stdlib/array-dtypes": "^0.0.x", - "@stdlib/array-filled": "^0.0.x", - "@stdlib/array-filled-by": "^0.0.x", - "@stdlib/array-typed-real-dtypes": "^0.0.x", - "@stdlib/assert-is-function": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/math-base-assert-is-nan": "^0.0.x", - "@stdlib/random-base-discrete-uniform": "^0.0.x", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "patreon", "url": "https://www.patreon.com/athan" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..6a175d0 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From d72127bd7ed3360d0387a4f10daeae5291153296 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 2 Feb 2023 04:51:08 +0000 Subject: [PATCH 006/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 15779a3..97b18f4 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.0.x" + "@stdlib/types": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x" }, "devDependencies": { "@stdlib/array-dtype": "^0.0.x", @@ -82,4 +83,4 @@ "type": "patreon", "url": "https://www.patreon.com/athan" } -} +} \ No newline at end of file From 4bf758c5f19dfb87fe52d2a9ac3a84a1e3e3e8cf Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 2 Feb 2023 05:04:22 +0000 Subject: [PATCH 007/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index b55a53d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 2.0 - -/// - -import { Collection } from '@stdlib/types/object'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: any ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: any ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0158300..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 6a175d0..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 442f384a467aecf02083529914a50354a95007b0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 2 Feb 2023 05:05:20 +0000 Subject: [PATCH 008/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 791 --- .github/workflows/publish.yml | 117 - .github/workflows/test.yml | 92 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 184 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- benchmark/benchmark.js | 331 -- branches.md | 53 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 109 - 36 files changed, 6202 insertions(+), 4378 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# 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 `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 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 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 bc583ae..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 df8591c..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 f4eea88..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,791 +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 - -# 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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # 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: | - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\"/\"@stdlib\/error-tools-fmtprodmsg\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^0.0.x'; 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -179,7 +172,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]. @@ -239,7 +232,7 @@ Copyright © 2016-2023. 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/stdlib +[@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/esm
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 72ad87a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +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' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 41e8058..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 4442c84..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 5ec9327..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 0a12243..b55a53d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..0158300 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 97b18f4..546e307 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.1", "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.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.0.x", - "@stdlib/array-dtypes": "^0.0.x", - "@stdlib/array-filled": "^0.0.x", - "@stdlib/array-filled-by": "^0.0.x", - "@stdlib/array-typed-real-dtypes": "^0.0.x", - "@stdlib/assert-is-function": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/math-base-assert-is-nan": "^0.0.x", - "@stdlib/random-base-discrete-uniform": "^0.0.x", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "patreon", "url": "https://www.patreon.com/athan" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3a3b569 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From f5ad7514622eb8783f5f23a9c63868e84b48c4e5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 2 Feb 2023 05:08:32 +0000 Subject: [PATCH 009/140] Update README.md for ESM bundle v0.0.1 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5bddb40..40342ad 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ limitations under the License. ## Usage ```javascript -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.0.1-esm/index.mjs'; ``` #### setter( dtype ) @@ -100,7 +100,7 @@ The returned accessor function accepts the following arguments: import filled from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled@esm/index.mjs'; import dtype from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs'; -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.0.1-esm/index.mjs'; var arr = filled( 1.0, 10, 'float64' ); setter( dtype( arr ) )( arr, 2, 100.0 ); From 6c8c3921124791b7f6a74443f1db4c22260a567b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 2 Feb 2023 05:08:33 +0000 Subject: [PATCH 010/140] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 40342ad..223bab2 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,11 @@ limitations under the License. ## Usage +```javascript +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-setter/tags). For example, + ```javascript import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.0.1-esm/index.mjs'; ``` @@ -100,7 +105,7 @@ The returned accessor function accepts the following arguments: import filled from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled@esm/index.mjs'; import dtype from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs'; -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.0.1-esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; var arr = filled( 1.0, 10, 'float64' ); setter( dtype( arr ) )( arr, 2, 100.0 ); From 5d647016cc563251f35286cac843742a7d6b2d26 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Jun 2023 10:00:26 +0000 Subject: [PATCH 011/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 7c8c55e..c5633f1 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.0.14" + "@stdlib/types": "^0.0.14", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.0.6", @@ -82,4 +83,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From ac5d9e5c3ca2d25ad03a0d002d049826ddc6d03f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Jun 2023 18:13:53 +0000 Subject: [PATCH 012/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index b55a53d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 2.0 - -/// - -import { Collection } from '@stdlib/types/object'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: any ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: any ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0158300..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3a3b569..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From ccfb2829538e9fc54e2df511cfbeddc9e5839fa8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Jun 2023 18:14:49 +0000 Subject: [PATCH 013/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- benchmark/benchmark.js | 331 -- branches.md | 53 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 109 - 37 files changed, 6202 insertions(+), 4520 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# 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 `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 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 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 7628836..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-06-01T06:32:01.166Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 bc583ae..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 df8591c..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 3e8e2db..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -179,7 +172,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]. @@ -239,7 +232,7 @@ Copyright © 2016-2023. 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/stdlib +[@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/esm
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 72ad87a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +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' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 8b24458..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 4442c84..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 5ec9327..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 0a12243..b55a53d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..0158300 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 c5633f1..7d84bfc 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.1", "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.0.14", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.0.6", - "@stdlib/array-dtypes": "^0.0.6", - "@stdlib/array-filled": "^0.0.6", - "@stdlib/array-filled-by": "^0.0.2", - "@stdlib/array-typed-real-dtypes": "^0.0.2", - "@stdlib/assert-is-function": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-assert-is-nan": "^0.0.8", - "@stdlib/random-base-discrete-uniform": "^0.0.6", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..0aa6176 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 633ff6efafaef2306f90ca494261d8aacda07e16 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 27 Jun 2023 20:57:30 +0000 Subject: [PATCH 014/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 7c8c55e..c5633f1 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.0.14" + "@stdlib/types": "^0.0.14", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.0.6", @@ -82,4 +83,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 2d6b4c8452ef4c430f267cad4d6954b55c628a36 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 27 Jun 2023 20:59:26 +0000 Subject: [PATCH 015/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index b55a53d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 2.0 - -/// - -import { Collection } from '@stdlib/types/object'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: any ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: any ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0158300..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 0aa6176..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 409e0b517a8c5c709dc86b6f76906a45dcd4c561 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 27 Jun 2023 21:00:16 +0000 Subject: [PATCH 016/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- benchmark/benchmark.js | 331 -- branches.md | 53 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 109 - 36 files changed, 6202 insertions(+), 4519 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# 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 `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 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 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 bc583ae..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 df8591c..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 3e8e2db..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -179,7 +172,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]. @@ -239,7 +232,7 @@ Copyright © 2016-2023. 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/stdlib +[@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/esm
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 72ad87a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +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' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 8b24458..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 4442c84..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 513816c..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 c5ba113..cfa5cd6 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..0158300 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 c5633f1..7d84bfc 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.1", "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.0.14", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.0.6", - "@stdlib/array-dtypes": "^0.0.6", - "@stdlib/array-filled": "^0.0.6", - "@stdlib/array-filled-by": "^0.0.2", - "@stdlib/array-typed-real-dtypes": "^0.0.2", - "@stdlib/assert-is-function": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-assert-is-nan": "^0.0.8", - "@stdlib/random-base-discrete-uniform": "^0.0.6", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..2924c79 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 4f3a977407daf952ad40206d96aa66f71282e614 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Jul 2023 09:27:42 +0000 Subject: [PATCH 017/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 7c8c55e..c5633f1 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.0.14" + "@stdlib/types": "^0.0.14", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.0.6", @@ -82,4 +83,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 35df55bccd5b615ac0f557dcd9cf39697a1a952c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Jul 2023 18:34:24 +0000 Subject: [PATCH 018/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index cfa5cd6..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/object'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0158300..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2924c79..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e3684af17628ce858ac8e5220db788605ff65e72 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Jul 2023 18:35:19 +0000 Subject: [PATCH 019/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- benchmark/benchmark.js | 331 -- branches.md | 53 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 109 - 37 files changed, 6202 insertions(+), 4520 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# 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 `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 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 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 04d6f04..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-07-01T06:22:56.587Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 bc583ae..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 df8591c..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 3e8e2db..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -179,7 +172,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]. @@ -239,7 +232,7 @@ Copyright © 2016-2023. 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/stdlib +[@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/esm
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 72ad87a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +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' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 8b24458..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 4442c84..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 513816c..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 c5ba113..cfa5cd6 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..0158300 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 c5633f1..7d84bfc 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.1", "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.0.14", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.0.6", - "@stdlib/array-dtypes": "^0.0.6", - "@stdlib/array-filled": "^0.0.6", - "@stdlib/array-filled-by": "^0.0.2", - "@stdlib/array-typed-real-dtypes": "^0.0.2", - "@stdlib/assert-is-function": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-assert-is-nan": "^0.0.8", - "@stdlib/random-base-discrete-uniform": "^0.0.6", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..ee095de --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 0a29809bc353b3879744d5db7b35849d7f2d3a25 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 17 Aug 2023 02:26:35 +0000 Subject: [PATCH 020/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 7c8c55e..c5633f1 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.0.14" + "@stdlib/types": "^0.0.14", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.0.6", @@ -82,4 +83,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From d41b0c8e47d208f3be5259c2567a1e68951a234d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 17 Aug 2023 02:31:24 +0000 Subject: [PATCH 021/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index cfa5cd6..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/object'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0158300..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index ee095de..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 2ef7122721894df52b10e3914cf57d92d2925f6e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 17 Aug 2023 02:32:23 +0000 Subject: [PATCH 022/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 783 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- benchmark/benchmark.js | 331 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 109 - 39 files changed, 6202 insertions(+), 4519 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# 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 `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 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 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 bc583ae..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 df8591c..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 91f2b93..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,783 +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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -179,7 +172,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]. @@ -239,7 +232,7 @@ Copyright © 2016-2023. 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/stdlib +[@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/esm
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 72ad87a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +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' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 8b24458..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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 513816c..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 cdf8ef8..8bd2a40 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..0158300 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 c5633f1..7d84bfc 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.1", "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.0.14", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.0.6", - "@stdlib/array-dtypes": "^0.0.6", - "@stdlib/array-filled": "^0.0.6", - "@stdlib/array-filled-by": "^0.0.2", - "@stdlib/array-typed-real-dtypes": "^0.0.2", - "@stdlib/assert-is-function": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-assert-is-nan": "^0.0.8", - "@stdlib/random-base-discrete-uniform": "^0.0.6", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f3ed8be --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From cc7c4ed9b7738ad6f6a2f5cfbc2e4d5289e6dee9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 24 Aug 2023 22:00:23 +0000 Subject: [PATCH 023/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 7c8c55e..c5633f1 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.0.14" + "@stdlib/types": "^0.0.14", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.0.6", @@ -82,4 +83,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 149fe110ce97d5c6f3f3dca4915da12337a10b61 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 24 Aug 2023 22:03:37 +0000 Subject: [PATCH 024/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 8bd2a40..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0158300..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f3ed8be..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 904152cdfc8f35733f83e5a991645aece87349b7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 24 Aug 2023 22:04:35 +0000 Subject: [PATCH 025/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 783 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- benchmark/benchmark.js | 331 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 109 - 39 files changed, 6202 insertions(+), 4519 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# 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 `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 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 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 bc583ae..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 df8591c..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 91f2b93..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,783 +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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -179,7 +172,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]. @@ -239,7 +232,7 @@ Copyright © 2016-2023. 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/stdlib +[@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/esm
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 72ad87a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +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' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 8b24458..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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 6aa905b..b37f1b1 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..0158300 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 c5633f1..7d84bfc 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.1", "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.0.14", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.0.6", - "@stdlib/array-dtypes": "^0.0.6", - "@stdlib/array-filled": "^0.0.6", - "@stdlib/array-filled-by": "^0.0.2", - "@stdlib/array-typed-real-dtypes": "^0.0.2", - "@stdlib/assert-is-function": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-assert-is-nan": "^0.0.8", - "@stdlib/random-base-discrete-uniform": "^0.0.6", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3af7420 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 9628a2df6f4eace027eb7508897c13f504e6b5a0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 06:34:58 +0000 Subject: [PATCH 026/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index c5bd8e7..c217c73 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.1.0" + "@stdlib/types": "^0.1.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.0" }, "devDependencies": { "@stdlib/array-dtype": "^0.0.6", @@ -82,4 +83,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 6305f458ac4bec2728153e3ed419e49a24dc330f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 08:52:33 +0000 Subject: [PATCH 027/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index b37f1b1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; // tslint:disable-line:no-unnecessary-generics - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; // tslint:disable-line:no-unnecessary-generics - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0158300..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3af7420..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From f55608c82b87f7c89d175bcdeb2d4495909112be Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 08:53:48 +0000 Subject: [PATCH 028/140] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 783 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- benchmark/benchmark.js | 331 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 109 - 40 files changed, 6202 insertions(+), 4554 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +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 -insert_final_newline = false - -# 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 = false - -# 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 `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 bc583ae..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 df8591c..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 91f2b93..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,783 +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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -190,7 +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]. @@ -250,7 +243,7 @@ Copyright © 2016-2023. 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/stdlib +[@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/esm
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 72ad87a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +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' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 8b24458..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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 6aa905b..b37f1b1 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..0158300 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 c217c73..3c86ed9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "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.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.0" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.0.6", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled": "^0.0.6", - "@stdlib/array-filled-by": "^0.0.2", - "@stdlib/array-typed-real-dtypes": "^0.1.0", - "@stdlib/assert-is-function": "^0.1.0", - "@stdlib/bench": "^0.1.0", - "@stdlib/math-base-assert-is-nan": "^0.1.0", - "@stdlib/random-base-discrete-uniform": "^0.0.6", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..b99c34f --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 5237c2e996d238e215ccf1335f92ca12efc25612 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 10:40:15 +0000 Subject: [PATCH 029/140] Update README.md for ESM bundle v0.1.0 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 01ca9e2..6f6b29c 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.1.0-esm/index.mjs'; ``` #### setter( dtype ) @@ -111,7 +111,7 @@ The returned accessor function accepts the following arguments: import filled from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled@esm/index.mjs'; import dtype from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs'; -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.1.0-esm/index.mjs'; var arr = filled( 1.0, 10, 'float64' ); setter( dtype( arr ) )( arr, 2, 100.0 ); From e4903d315cb5ac368601c75c913d32953606f5db Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 10:40:16 +0000 Subject: [PATCH 030/140] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6f6b29c..d8d6f71 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-setter/tags). For example, + ```javascript import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.1.0-esm/index.mjs'; ``` @@ -111,7 +116,7 @@ The returned accessor function accepts the following arguments: import filled from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled@esm/index.mjs'; import dtype from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs'; -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.1.0-esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; var arr = filled( 1.0, 10, 'float64' ); setter( dtype( arr ) )( arr, 2, 100.0 ); From a1545bde1b29ec45dd39e7929efdadb183bb567c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Oct 2023 14:13:52 +0000 Subject: [PATCH 031/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 29e6ccd..59d75bf 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.1.0" + "@stdlib/types": "^0.1.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.0" }, "devDependencies": { "@stdlib/array-dtype": "^0.1.0", @@ -82,4 +83,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 6dc5c577eb939d85738094ceef4d83968f46258b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Oct 2023 22:10:45 +0000 Subject: [PATCH 032/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index b37f1b1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; // tslint:disable-line:no-unnecessary-generics - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; // tslint:disable-line:no-unnecessary-generics - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0158300..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index b99c34f..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 27578a7e958499acc0e74de527cbe05805ef1b62 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Oct 2023 22:14:12 +0000 Subject: [PATCH 033/140] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 247 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- benchmark/benchmark.js | 331 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 109 - test/test.js | 109 - 42 files changed, 6202 insertions(+), 4722 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +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 -insert_final_newline = false - -# 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 = false - -# 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 `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 8df40cb..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-10-01T04:21:02.449Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 ab56cca..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 3acd3a9..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 corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - 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 c1c45e7..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 cfc2d9c..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - 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 corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - 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 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -190,7 +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]. @@ -250,7 +243,7 @@ Copyright © 2016-2023. 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/stdlib +[@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/esm
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 72ad87a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +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' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 8b24458..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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 6aa905b..b37f1b1 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..0158300 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 59d75bf..3c86ed9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "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.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.0" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled": "^0.1.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-typed-real-dtypes": "^0.1.0", - "@stdlib/assert-is-function": "^0.1.0", - "@stdlib/bench": "^0.1.0", - "@stdlib/math-base-assert-is-nan": "^0.1.0", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..01cbb68 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index b86da8b..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,109 +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( './../../dist' ); - - -// 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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 1bc861bc98d3a9c1a511d47d80aa5a239a699221 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 5 Oct 2023 17:40:12 +0000 Subject: [PATCH 034/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 7667ac7..1243df5 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.1.0" + "@stdlib/types": "^0.1.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-dtype": "^0.1.0", @@ -82,4 +83,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 58e1697218aa5b0aaab6eede3a8fcb88eb9dd497 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 6 Oct 2023 23:19:51 +0000 Subject: [PATCH 035/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index b37f1b1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; // tslint:disable-line:no-unnecessary-generics - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; // tslint:disable-line:no-unnecessary-generics - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0158300..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 01cbb68..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 405b3a7304dd7bab27af8a1805ae9187d6349e46 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 6 Oct 2023 23:22:43 +0000 Subject: [PATCH 036/140] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 247 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- benchmark/benchmark.js | 331 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 109 - test/test.js | 109 - 41 files changed, 6202 insertions(+), 4721 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +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 -insert_final_newline = false - -# 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 = false - -# 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 `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 ab56cca..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 3acd3a9..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 corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - 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 c1c45e7..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 cfc2d9c..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - 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 corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - 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 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -190,7 +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]. @@ -250,7 +243,7 @@ Copyright © 2016-2023. 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/stdlib +[@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/esm
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 72ad87a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +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' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 8b24458..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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 6aa905b..b37f1b1 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..0158300 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 1243df5..3c86ed9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "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.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled": "^0.1.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-typed-real-dtypes": "^0.1.0", - "@stdlib/assert-is-function": "^0.1.1", - "@stdlib/bench": "^0.1.0", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d5eb088 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index b86da8b..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,109 +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( './../../dist' ); - - -// 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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From ad06dc4ef06a03a362f7628a4fe927348fa3b340 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Nov 2023 15:15:01 +0000 Subject: [PATCH 037/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 700814c..382433c 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.1.0" + "@stdlib/types": "^0.1.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-dtype": "^0.1.0", @@ -82,4 +83,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 1b30195239e543b560e2208179511a51dd962b57 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 2 Nov 2023 22:41:27 +0000 Subject: [PATCH 038/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index b37f1b1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; // tslint:disable-line:no-unnecessary-generics - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; // tslint:disable-line:no-unnecessary-generics - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0158300..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index d5eb088..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 0862d1293d43a5f9053cd5cfed684cd9fd460f2d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 2 Nov 2023 22:45:05 +0000 Subject: [PATCH 039/140] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- benchmark/benchmark.js | 331 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 42 files changed, 6202 insertions(+), 4654 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +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 -insert_final_newline = false - -# 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 = false - -# 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 `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index ce91cf9..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-11-01T04:36:08.721Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 ab56cca..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 3acd3a9..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 corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - 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 c1c45e7..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 cfc2d9c..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - 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 corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - 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 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -190,7 +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]. @@ -250,7 +243,7 @@ Copyright © 2016-2023. 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/stdlib +[@stdlib/array/dtypes]: https://github.com/stdlib-js/stdlib/tree/esm
diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 72ad87a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +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' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 8b24458..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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 6aa905b..b37f1b1 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..0158300 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 382433c..3c86ed9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "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.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled": "^0.1.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-typed-real-dtypes": "^0.1.1", - "@stdlib/assert-is-function": "^0.1.1", - "@stdlib/bench": "^0.1.0", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..dca9178 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + 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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 9778f129c81dfd1d43e6b1b524fbfc9b8e95cd36 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 9 Nov 2023 10:03:30 +0000 Subject: [PATCH 040/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index f862a25..5373e51 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.2.0" + "@stdlib/types": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-dtype": "^0.1.0", @@ -82,4 +83,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From df4341e03f62af88158d76573e30d38735566641 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 9 Nov 2023 10:42:04 +0000 Subject: [PATCH 041/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index b37f1b1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; // tslint:disable-line:no-unnecessary-generics - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; // tslint:disable-line:no-unnecessary-generics - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0158300..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index dca9178..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From ab1520a246951256742ffe771914cc206e34b094 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 9 Nov 2023 10:44:34 +0000 Subject: [PATCH 042/140] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- benchmark/benchmark.js | 331 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 41 files changed, 6202 insertions(+), 4653 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +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 -insert_final_newline = false - -# 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 = false - -# 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 `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 ab56cca..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 3acd3a9..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 corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - 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 c1c45e7..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 cfc2d9c..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - 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 corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - 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 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -190,7 +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]. @@ -250,7 +243,7 @@ Copyright © 2016-2023. 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/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 72ad87a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +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' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 8b24458..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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 6aa905b..b37f1b1 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..0158300 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 5373e51..3c86ed9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "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.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled": "^0.1.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-typed-real-dtypes": "^0.1.1", - "@stdlib/assert-is-function": "^0.1.1", - "@stdlib/bench": "^0.2.0", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3f9398f --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + 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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From a42fb4f947bb4005a08489c6d65b2c40ca799a9c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 12 Nov 2023 15:09:52 +0000 Subject: [PATCH 043/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index f862a25..5373e51 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.2.0" + "@stdlib/types": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-dtype": "^0.1.0", @@ -82,4 +83,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From cfaa3e5ed85ab2ae45204a29626fd2d8d376175e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 12 Nov 2023 15:27:34 +0000 Subject: [PATCH 044/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index b37f1b1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; // tslint:disable-line:no-unnecessary-generics - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; // tslint:disable-line:no-unnecessary-generics - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0158300..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3f9398f..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 04ada56236a64856d0f3c680d81f3b1ccbfb280d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 12 Nov 2023 15:31:34 +0000 Subject: [PATCH 045/140] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- benchmark/benchmark.js | 331 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 41 files changed, 6202 insertions(+), 4653 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +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 -insert_final_newline = false - -# 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 = false - -# 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 `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 ab56cca..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 3acd3a9..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 corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - 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 c1c45e7..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 cfc2d9c..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - 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 corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - 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 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -190,7 +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]. @@ -250,7 +243,7 @@ Copyright © 2016-2023. 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/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 72ad87a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +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' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 8b24458..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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 a9c2e8d..6fce6d0 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..0158300 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 5373e51..3c86ed9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "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.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled": "^0.1.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-typed-real-dtypes": "^0.1.1", - "@stdlib/assert-is-function": "^0.1.1", - "@stdlib/bench": "^0.2.0", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..87264b0 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + 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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From b20890caa6d68783f30d17aed7abf67f14d1eafd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Dec 2023 11:33:46 +0000 Subject: [PATCH 046/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index b2efb9f..6c707f6 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.2.0" + "@stdlib/types": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-dtype": "^0.1.0", @@ -82,4 +83,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 24809b4ae253716c0de2676727850ac35cdc1d7f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 08:40:24 +0000 Subject: [PATCH 047/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 6fce6d0..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0158300..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 87264b0..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From afdca5a48679436f385588e8713a213441c136c2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 08:42:56 +0000 Subject: [PATCH 048/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- benchmark/benchmark.js | 331 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 42 files changed, 6202 insertions(+), 4649 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index d14043d..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-12-01T04:46:30.144Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 ab56cca..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 3acd3a9..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 corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - 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 c1c45e7..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 cfc2d9c..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - 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 corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - 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 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -190,7 +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]. @@ -250,7 +243,7 @@ Copyright © 2016-2023. 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/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 72ad87a..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +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' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 8b24458..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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 a9c2e8d..6fce6d0 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..0158300 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 6c707f6..3c86ed9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "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.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled": "^0.1.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-typed-real-dtypes": "^0.1.1", - "@stdlib/assert-is-function": "^0.1.1", - "@stdlib/bench": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..7d27fc8 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + 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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From be66d05839cf839ad18ee9e31f7834021fec8d83 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 06:51:38 +0000 Subject: [PATCH 049/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 2e69642..3df33c9 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.2.0" + "@stdlib/types": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-dtype": "^0.1.0", @@ -82,4 +83,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 9fe2cf9d3d5574510931511e58a0741a810fe20b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 13:35:07 +0000 Subject: [PATCH 050/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 6fce6d0..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0158300..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 7d27fc8..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 0d05b350c50dd07c269bbe8176bc5db677a733ee Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 13:35:26 +0000 Subject: [PATCH 051/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 43 files changed, 6202 insertions(+), 4655 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 3f4ebe2..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-01-01T04:12:40.943Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 30656c4..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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 3acd3a9..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 corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - 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 c92f5c4..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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 8bae062..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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - 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 e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -190,7 +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]. @@ -250,7 +243,7 @@ Copyright © 2016-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 8b24458..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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 a9c2e8d..6fce6d0 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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 3df33c9..3c86ed9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "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.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled": "^0.1.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-typed-real-dtypes": "^0.1.1", - "@stdlib/assert-is-function": "^0.1.1", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "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.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..0db7455 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + 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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From cf64a82c513723492bea8524fa2dacbd8aa53a18 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jan 2024 22:13:29 +0000 Subject: [PATCH 052/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 2e69642..3df33c9 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.2.0" + "@stdlib/types": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-dtype": "^0.1.0", @@ -82,4 +83,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 093fc0c6a2c61b2183205d33a5dac6dd6cd41514 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jan 2024 22:35:19 +0000 Subject: [PATCH 053/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 6fce6d0..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( `@stdlib/array/float64` ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( `@stdlib/array/float32` ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( `@stdlib/array/int32` ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( `@stdlib/array/int16` ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( `@stdlib/array/int8` ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( `@stdlib/array/uint32` ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( `@stdlib/array/uint16` ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( `@stdlib/array/uint8` ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( `@stdlib/array/uint8c` ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( `@stdlib/array/dtype` ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 0db7455..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 0a7a1e03c513d4bb98f73fbc27c0b1c1060d966f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jan 2024 22:35:36 +0000 Subject: [PATCH 054/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 42 files changed, 6202 insertions(+), 4654 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 30656c4..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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 3acd3a9..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 corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - 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 c92f5c4..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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 8bae062..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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - 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 e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -190,7 +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]. @@ -250,7 +243,7 @@ Copyright © 2016-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 8b24458..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +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. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -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 -[umd-url]: https://github.com/stdlib-js/array-base-setter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-setter/tree/esm \ 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 3df33c9..3c86ed9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "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.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled": "^0.1.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-typed-real-dtypes": "^0.1.1", - "@stdlib/assert-is-function": "^0.1.1", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "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.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -83,4 +27,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1e99f02 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + 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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 437af0c1cc19710aed8f39a49f3d6bc49dabfc97 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 26 Jan 2024 08:29:04 +0000 Subject: [PATCH 055/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 1d8b670..fe816a1 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.2.0" + "@stdlib/types": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-dtype": "^0.1.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From e92b5d70792dbc069c27016ccc7e6ac596d7487a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 26 Jan 2024 08:29:26 +0000 Subject: [PATCH 056/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1e99f02..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From b724f269b3c8529a115ae73710a641ab9ee1af63 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 26 Jan 2024 08:30:01 +0000 Subject: [PATCH 057/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 42 files changed, 6202 insertions(+), 4659 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 30656c4..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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 3acd3a9..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 corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - 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 c92f5c4..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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 8bae062..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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - 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 e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 fe816a1..495df53 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "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.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled": "^0.1.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-typed-real-dtypes": "^0.1.1", - "@stdlib/assert-is-function": "^0.1.1", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "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.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1c9d5bb --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + 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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 02cc34b2d2048550c095bded66cfbc75c4b6930c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 07:21:07 +0000 Subject: [PATCH 058/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 1d8b670..fe816a1 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.2.0" + "@stdlib/types": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-dtype": "^0.1.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From ba18e420eaf6e7e0992be2fd49ecf71c56f01248 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 12:51:07 +0000 Subject: [PATCH 059/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1c9d5bb..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 0a59acb141dc35dfe956f2e1ad8c091c6dafc369 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 12:51:40 +0000 Subject: [PATCH 060/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 43 files changed, 6202 insertions(+), 4660 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 5f228bb..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-02-01T05:01:41.418Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 30656c4..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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 3acd3a9..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 corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - 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 c92f5c4..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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 8bae062..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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - 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 e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - 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-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 fe816a1..495df53 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "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.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled": "^0.1.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-typed-real-dtypes": "^0.1.1", - "@stdlib/assert-is-function": "^0.1.1", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "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.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f1b0b17 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + 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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From a1e2fa4fee31f97dc6aca8e08f714402cc9932cc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 14 Feb 2024 14:03:27 +0000 Subject: [PATCH 061/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 63c36b0..96a4a84 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.3.1" + "@stdlib/types": "^0.3.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.0" }, "devDependencies": { "@stdlib/array-dtype": "^0.1.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From e3a8cb61cc2000a1d737d0e303fdf4f89a70a5ec Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 14 Feb 2024 21:02:07 +0000 Subject: [PATCH 062/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f1b0b17..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From d003b4a22bb475ff835d4409443eda1c6dd8e7e8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 14 Feb 2024 21:02:41 +0000 Subject: [PATCH 063/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 42 files changed, 6202 insertions(+), 4663 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 e7524ab..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 corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - 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 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 96a4a84..69b233e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.0", "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.3.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-filled": "^0.1.0", - "@stdlib/array-filled-by": "^0.1.0", - "@stdlib/array-typed-real-dtypes": "^0.1.1", - "@stdlib/assert-is-function": "^0.1.1", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "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.0" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..41567ea --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + 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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From c99ed92ae450f5749451a0ace3a3f726e10bd01f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 14 Feb 2024 22:09:39 +0000 Subject: [PATCH 064/140] Update README.md for ESM bundle v0.2.0 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 74f7b83..39ff0d9 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.0-esm/index.mjs'; ``` #### setter( dtype ) @@ -111,7 +111,7 @@ The returned accessor function accepts the following arguments: import filled from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled@esm/index.mjs'; import dtype from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs'; -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.0-esm/index.mjs'; var arr = filled( 1.0, 10, 'float64' ); setter( dtype( arr ) )( arr, 2, 100.0 ); From 7457531435a1fff2a37d56412d9b73319e6b8383 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 14 Feb 2024 22:09:40 +0000 Subject: [PATCH 065/140] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 39ff0d9..5873008 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-setter/tags). For example, + ```javascript import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.0-esm/index.mjs'; ``` @@ -111,7 +116,7 @@ The returned accessor function accepts the following arguments: import filled from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled@esm/index.mjs'; import dtype from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs'; -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.0-esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; var arr = filled( 1.0, 10, 'float64' ); setter( dtype( arr ) )( arr, 2, 100.0 ); From 230346ff9ca9e13f869a5597bfb24508c9de2e0b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 00:12:30 +0000 Subject: [PATCH 066/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 80d09ba..85a4a0f 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.3.2" + "@stdlib/types": "^0.3.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-dtype": "^0.2.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 4b8cb1bbabd69074dbe281d0da3d1088862f53fd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 05:40:26 +0000 Subject: [PATCH 067/140] Remove files --- index.d.ts | 334 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6516 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 41567ea..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From d969cbf9176397a2180c76ccf294004e0b551c42 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 05:42:02 +0000 Subject: [PATCH 068/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 42 files changed, 4867 insertions(+), 4657 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 85a4a0f..752c7be 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "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.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.2.0", - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/array-filled": "^0.2.0", - "@stdlib/array-filled-by": "^0.2.0", - "@stdlib/array-typed-real-dtypes": "^0.2.0", - "@stdlib/assert-is-function": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^0.2.0", - "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.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 728f6ea7103caf4b9e5c8d7f6e348c22d04600f1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 07:25:00 +0000 Subject: [PATCH 069/140] Update README.md for ESM bundle v0.2.1 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index df712e5..76a68c1 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.1-esm/index.mjs'; ``` #### setter( dtype ) @@ -111,7 +111,7 @@ The returned accessor function accepts the following arguments: import filled from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled@esm/index.mjs'; import dtype from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs'; -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.1-esm/index.mjs'; var arr = filled( 1.0, 10, 'float64' ); setter( dtype( arr ) )( arr, 2, 100.0 ); From d601056a4848d998c820574cbf19f784978908a3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 07:25:00 +0000 Subject: [PATCH 070/140] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 76a68c1..84c0de3 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-setter/tags). For example, + ```javascript import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.1-esm/index.mjs'; ``` @@ -111,7 +116,7 @@ The returned accessor function accepts the following arguments: import filled from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled@esm/index.mjs'; import dtype from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs'; -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.1-esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; var arr = filled( 1.0, 10, 'float64' ); setter( dtype( arr ) )( arr, 2, 100.0 ); From ac92b5269dfd5c2aa8d03df37cdb4a1acbaba75f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 06:43:45 +0000 Subject: [PATCH 071/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index caa4dbf..d9759c3 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.3.2" + "@stdlib/types": "^0.3.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-dtype": "^0.2.1", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 4608a5fbbbf8975335d50a12c084daabcaee167d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 11:58:38 +0000 Subject: [PATCH 072/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From a0d9bd9f8c0c759edb2073d80a08695b3f7a296d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 11:58:55 +0000 Subject: [PATCH 073/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 43 files changed, 4867 insertions(+), 4659 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 3d34f97..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-03-01T04:48:31.805Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 d9759c3..752c7be 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "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.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.2.1", - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.1", - "@stdlib/assert-is-function": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From f3e58eb652169173ef9e5a09e4848bdbfc50dd20 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 06:00:57 +0000 Subject: [PATCH 074/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index caa4dbf..d9759c3 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.3.2" + "@stdlib/types": "^0.3.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-dtype": "^0.2.1", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 26f3656d64f1b56bcf3401b2a5b49000345a4caa Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 11:10:00 +0000 Subject: [PATCH 075/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 2405e44fe711c7c8ae3a1dbe00772e6448a3ebf4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 11:10:12 +0000 Subject: [PATCH 076/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 43 files changed, 4867 insertions(+), 4662 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 6d928bf..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-04-01T04:04:11.703Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 ec90164..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 d9759c3..752c7be 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "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.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.2.1", - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.1", - "@stdlib/assert-is-function": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From b29ac02b4e740a5f047ebc251258b79784214686 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 02:23:30 +0000 Subject: [PATCH 077/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index caa4dbf..d9759c3 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.3.2" + "@stdlib/types": "^0.3.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-dtype": "^0.2.1", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 5d3c72626b61d704ce593ea45ce856dc7d6a983c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 07:52:42 +0000 Subject: [PATCH 078/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 49195baeae78823fbd2ea203b3da4f3957689062 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 07:52:55 +0000 Subject: [PATCH 079/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 134 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 42 files changed, 4867 insertions(+), 4663 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +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: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 ec90164..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 d9759c3..752c7be 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "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.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.2.1", - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.1", - "@stdlib/assert-is-function": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 3a5792eb2cc0a3bdc71b2438dce310642382482f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 21:16:35 +0000 Subject: [PATCH 080/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 625d7da..7c6c1a5 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.3.2" + "@stdlib/types": "^0.3.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.2.1", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 091ec10c3f3a01738b0febe660a8a959c4abc1bf Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 21:26:28 +0000 Subject: [PATCH 081/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e62a31aeaecc593b6d2b9152f8ab219152d37d51 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 21:26:47 +0000 Subject: [PATCH 082/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 138 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 42 files changed, 4867 insertions(+), 4807 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 7c6c1a5..0677695 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "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.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.2.1", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.1", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 506b7561a9bfd23ed7df9db35c406a97ae23cb26 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 21:34:25 +0000 Subject: [PATCH 083/140] Update README.md for ESM bundle v0.2.2 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 23973fb..7341dff 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.2-esm/index.mjs'; ``` #### setter( dtype ) @@ -111,7 +111,7 @@ The returned accessor function accepts the following arguments: import filled from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled@esm/index.mjs'; import dtype from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs'; -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.2-esm/index.mjs'; var arr = filled( 1.0, 10, 'float64' ); setter( dtype( arr ) )( arr, 2, 100.0 ); From 9321c8bbf4d8943499a49f9a386f09ee15843378 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 21:34:25 +0000 Subject: [PATCH 084/140] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7341dff..c4330d0 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-setter/tags). For example, + ```javascript import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.2-esm/index.mjs'; ``` @@ -111,7 +116,7 @@ The returned accessor function accepts the following arguments: import filled from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled@esm/index.mjs'; import dtype from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs'; -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.2-esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; var arr = filled( 1.0, 10, 'float64' ); setter( dtype( arr ) )( arr, 2, 100.0 ); From 39ce1a3db9958564ece109a129c6419461b15647 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 06:50:50 +0000 Subject: [PATCH 085/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 6bac757..8db9f90 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.3.2" + "@stdlib/types": "^0.3.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.3.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 04f10366bfcdaa806bb9a60155534c521593177d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 11:28:19 +0000 Subject: [PATCH 086/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 70f0ffd7c35bce76cf7abc84fba586f561959633 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 11:28:33 +0000 Subject: [PATCH 087/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 88 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 43 files changed, 4867 insertions(+), 4760 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 0ddb5f5..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-08-01T04:54:58.794Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 8db9f90..0677695 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "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.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 91b6dfc0c20278bf12c1f6effd50837e6d0882ac Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 3 Aug 2024 22:01:51 +0000 Subject: [PATCH 088/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 6bac757..8db9f90 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.3.2" + "@stdlib/types": "^0.3.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.3.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 117d6b9028f1395508b8a0b537b869797905efc1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 4 Aug 2024 01:16:00 +0000 Subject: [PATCH 089/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 36ce938a56f009f07bf438be5ea5bcd10c0857b8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 4 Aug 2024 01:16:18 +0000 Subject: [PATCH 090/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 138 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 43 files changed, 4867 insertions(+), 4810 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index fddbcc2..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-08-03T20:22:38.695Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 8db9f90..0677695 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "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.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From cc1048bd89ee1581158784b334dbc68e0ea18adb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Sep 2024 07:08:57 +0000 Subject: [PATCH 091/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index fc65ca0..8ea444e 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.4.1" + "@stdlib/types": "^0.4.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.3.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From c5b695f6ffa6ab3237a69b31bc8efb71f5663a5d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Sep 2024 11:22:09 +0000 Subject: [PATCH 092/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 94271d34d9449e17909e6c2a1eda3e01bf9f8207 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Sep 2024 11:22:26 +0000 Subject: [PATCH 093/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 138 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 43 files changed, 4867 insertions(+), 4810 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 4a335e0..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-09-01T05:14:45.871Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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 4442c84..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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 8ea444e..0677695 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "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.4.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 025682a46c5f0798ae9c2371bb4a67ca7b5e66e1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 21 Sep 2024 21:22:45 +0000 Subject: [PATCH 094/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index fc65ca0..8ea444e 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.4.1" + "@stdlib/types": "^0.4.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.3.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 06c97f39f054435901735580a1f076e47eed3a55 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 21 Sep 2024 21:29:35 +0000 Subject: [PATCH 095/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 66511fa67b74dddaa8fb863c4aac457eefbdf2c7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 21 Sep 2024 21:29:48 +0000 Subject: [PATCH 096/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 172 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 42 files changed, 4867 insertions(+), 4843 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 8ea444e..0677695 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "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.4.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From f618fcce2670e58352ed836e6fe3b5f0c6b19969 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Oct 2024 07:25:18 +0000 Subject: [PATCH 097/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index fc65ca0..8ea444e 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.4.1" + "@stdlib/types": "^0.4.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.3.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 4afaf12ac4b137762c062ebba890cfb071bebabd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Oct 2024 12:04:06 +0000 Subject: [PATCH 098/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 939381facc9ea4283dfb45a96ef1fdc994278fd0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Oct 2024 12:04:21 +0000 Subject: [PATCH 099/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 172 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 43 files changed, 4867 insertions(+), 4844 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index d7e4320..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-10-01T05:26:27.347Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 8ea444e..0677695 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "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.4.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 26fee2acff5f71f4c49664ec182d0ce9eb2b9d03 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Nov 2024 07:17:22 +0000 Subject: [PATCH 100/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index fc65ca0..8ea444e 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.4.1" + "@stdlib/types": "^0.4.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.3.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 3e0b8ac36e441251e2778b9b0f97041eae379f17 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Nov 2024 11:16:05 +0000 Subject: [PATCH 101/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 35f82baa8a9d9296e90a49f2cebfb390b8de705f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Nov 2024 11:16:20 +0000 Subject: [PATCH 102/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 172 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 43 files changed, 4867 insertions(+), 4844 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index c4e6540..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-11-01T05:30:23.019Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 8ea444e..0677695 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "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.4.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 18c264f52bce0aa5065542b19fb73f7fb76b5a6d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Dec 2024 07:32:54 +0000 Subject: [PATCH 103/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 2aef6cb..824e451 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.3.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 8002a36ac45e4f2f923ac0994462696df0027898 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Dec 2024 11:26:14 +0000 Subject: [PATCH 104/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 2cc567a727890fa502f5070f042d7926b778cbc0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Dec 2024 11:26:31 +0000 Subject: [PATCH 105/140] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 172 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 44 files changed, 4867 insertions(+), 4949 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +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 -insert_final_newline = false - -# 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 = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index cda7617..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-12-01T05:38:24.662Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8972e6f..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/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 f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2024. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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..16f6392 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 824e451..0677695 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "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.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 7c3ce15b35281c178a14b5087a16640c0801b1d4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Mar 2025 00:31:14 +0000 Subject: [PATCH 106/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 2aef6cb..824e451 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.3.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From dcf7f04dd8df609aeba6ea26e4afee485c52bd3b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Mar 2025 00:40:43 +0000 Subject: [PATCH 107/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 16f6392..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 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},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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 8c23cbb2cc5e087dd614aa2696f22757ba61e8a2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Mar 2025 00:41:03 +0000 Subject: [PATCH 108/140] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 194 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 172 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 44 files changed, 4867 insertions(+), 4952 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 7ad0707..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-03-10T00:30:13.046Z 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 f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2025. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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..6adc4b0 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +var n={float64:function(n,t,i){n[t]=i},float32: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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 824e451..0677695 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "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.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 4d58e1ef112516495d8c99fe0a9cb1ad5ff00b48 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 19 May 2025 02:05:02 +0000 Subject: [PATCH 109/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 2aef6cb..824e451 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.3.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 5822aa8d2eab15d0522e4a69b16f644100be7972 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 19 May 2025 02:24:17 +0000 Subject: [PATCH 110/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6adc4b0..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -var n={float64:function(n,t,i){n[t]=i},float32: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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 0ee1534c0b989b602659936657e5c3e87e6e1250 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 19 May 2025 02:24:31 +0000 Subject: [PATCH 111/140] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 194 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 172 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 44 files changed, 4867 insertions(+), 4952 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 6b70695..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-05-19T01:54:35.377Z 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 f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2025. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 68e66c6..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'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 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 set = 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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..6adc4b0 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +var n={float64:function(n,t,i){n[t]=i},float32: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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ef87048..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 set = 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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 824e451..0677695 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "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.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 157992bb79b857018dabed01a3916dfc384a5a63 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 20 Aug 2025 01:12:08 +0000 Subject: [PATCH 112/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 2aef6cb..824e451 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.3.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 06ae4dfd8682b2381067639a324767de73747dee Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 20 Aug 2025 01:12:47 +0000 Subject: [PATCH 113/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6adc4b0..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -var n={float64:function(n,t,i){n[t]=i},float32: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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 00958932490312a76d035c05fa1a1890bdfdc2a3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 20 Aug 2025 01:13:05 +0000 Subject: [PATCH 114/140] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 194 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 173 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 43 files changed, 4867 insertions(+), 4952 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 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 f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -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-2025. 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 8400d42..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'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 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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..6adc4b0 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +var n={float64:function(n,t,i){n[t]=i},float32: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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 824e451..0677695 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "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.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 6e4c375d1b8b1fc4e6012b0ec26125d77a2f0550 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 30 Jan 2026 22:05:08 +0000 Subject: [PATCH 115/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 5f5e0f1..83f7f62 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.3.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From c27cfb590dbc2075c8f17681afd03d6469ea0e5d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 30 Jan 2026 22:12:45 +0000 Subject: [PATCH 116/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6adc4b0..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -var n={float64:function(n,t,i){n[t]=i},float32: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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 7776a8feddcf4cddd42766caa5e67993c34f8eeb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 30 Jan 2026 22:13:05 +0000 Subject: [PATCH 117/140] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 108 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 173 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 43 files changed, 4867 insertions(+), 5057 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 8400d42..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'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 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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..7aa0322 --- /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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 83f7f62..0677695 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "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.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/array-dtypes": "^0.4.0", - "@stdlib/array-filled": "^0.2.1", - "@stdlib/array-filled-by": "^0.2.1", - "@stdlib/array-typed-real-dtypes": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 8a0e95991ace13f50e7fe42dea181adbcc066a33 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Feb 2026 01:26:26 +0000 Subject: [PATCH 118/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 50e9384..f09b9eb 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-dtype": "^0.3.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 7485769574a4fcc69c7dbd76b44266a2a4559ff0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Feb 2026 01:56:40 +0000 Subject: [PATCH 119/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7aa0322..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -var n={float64:function(n,t,i){n[t]=i},float32: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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 02d865432758cb0fbb87e7571338b711687f03ee Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Feb 2026 01:56:56 +0000 Subject: [PATCH 120/140] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 108 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 173 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 44 files changed, 4867 insertions(+), 5058 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 0319987..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-02-02T01:14:05.485Z 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 8400d42..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'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 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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..7aa0322 --- /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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 f09b9eb..0677695 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "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.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/array-dtypes": "^0.4.0", - "@stdlib/array-filled": "^0.3.0", - "@stdlib/array-filled-by": "^0.3.0", - "@stdlib/array-typed-real-dtypes": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 6d13c2cba64186f86c3605ab008a960f4e7dfcdc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 06:42:29 +0000 Subject: [PATCH 121/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index b4acb65..8a37644 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, "devDependencies": { "@stdlib/array-dtype": "^0.3.0", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 2a643e76b6c3bfc752895e73f3215b223f694f7a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 07:47:25 +0000 Subject: [PATCH 122/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7aa0322..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -var n={float64:function(n,t,i){n[t]=i},float32: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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From bc01b5a13b71fd1a321b506ebcb6deac632753c9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 07:47:40 +0000 Subject: [PATCH 123/140] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 173 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 43 files changed, 4867 insertions(+), 5050 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 8400d42..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'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 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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..7aa0322 --- /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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 8a37644..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.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-dtype": "^0.3.0", - "@stdlib/array-dtypes": "^0.4.1", - "@stdlib/array-filled": "^0.3.0", - "@stdlib/array-filled-by": "^0.3.0", - "@stdlib/array-typed-real-dtypes": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.3", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "array", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 1e5c0fad9e9054dbb197708cd3dad6c4c850021a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 08:12:41 +0000 Subject: [PATCH 124/140] Update README.md for ESM bundle v0.2.3 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 925372d..9416404 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.3-esm/index.mjs'; ``` #### setter( dtype ) @@ -111,7 +111,7 @@ The returned accessor function accepts the following arguments: import filled from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled@esm/index.mjs'; import dtype from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs'; -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.3-esm/index.mjs'; var arr = filled( 1.0, 10, 'float64' ); setter( dtype( arr ) )( arr, 2, 100.0 ); From e7d7a38987b707fa10af924faac411c06d08e11d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 08:12:41 +0000 Subject: [PATCH 125/140] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9416404..94a01a4 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-setter/tags). For example, + ```javascript import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.3-esm/index.mjs'; ``` @@ -111,7 +116,7 @@ The returned accessor function accepts the following arguments: import filled from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-filled@esm/index.mjs'; import dtype from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtype@esm/index.mjs'; -import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@v0.2.3-esm/index.mjs'; +import setter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-setter@esm/index.mjs'; var arr = filled( 1.0, 10, 'float64' ); setter( dtype( arr ) )( arr, 2, 100.0 ); From 343a47ae40d8070a204471f5b75279a16890d83e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 29 Mar 2026 03:37:36 +0000 Subject: [PATCH 126/140] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index c4497d5..9e55a1a 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, "devDependencies": { "@stdlib/array-dtype": "^0.3.1", @@ -81,4 +82,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From ed8da0cb6ccfa8ee9884cba33d1280833c10bac3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 29 Mar 2026 03:52:50 +0000 Subject: [PATCH 127/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7aa0322..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -var n={float64:function(n,t,i){n[t]=i},float32: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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 82c449d79ab1b4d9dcd551cf7d05383458ad609e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 29 Mar 2026 03:53:07 +0000 Subject: [PATCH 128/140] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 173 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 331 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 62 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 44 files changed, 4867 insertions(+), 5062 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 0902685..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-03-29T03:29:33.387Z 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 9ec1614..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,331 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var isFunction = require( '@stdlib/assert-is-function' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var filledBy = require( '@stdlib/array-filled-by' ); -var dtype = require( '@stdlib/array-dtype' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var 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( pkg+':dtype=generic', 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( pkg+':dtype=float64', 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( pkg+':dtype=float32', 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( pkg+':dtype=int32', 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( pkg+':dtype=int16', 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( pkg+':dtype=int8', 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( pkg+':dtype=uint32', 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( pkg+':dtype=uint16', 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( pkg+':dtype=uint8', 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( pkg+':dtype=uint8c', 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 8400d42..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'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 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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..7aa0322 --- /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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 9e55a1a..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.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "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", - "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", @@ -82,4 +26,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 18cae356ba79aaefed8434ebe740aae255450067 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 21 Apr 2026 00:38:39 +0000 Subject: [PATCH 129/140] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 26bbd1c..907a31a 100644 --- a/package.json +++ b/package.json @@ -48,7 +48,7 @@ "@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", + "@stdlib/error-tools-fmtprodmsg": "^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", From db143fbb46d4e605c9960ccfd84bcd364b056918 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 21 Apr 2026 01:00:10 +0000 Subject: [PATCH 130/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7aa0322..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -var n={float64:function(n,t,i){n[t]=i},float32: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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 3b9c9e56448f39e6ac87ef4390e5b8fc02f4363d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 21 Apr 2026 01:00:27 +0000 Subject: [PATCH 131/140] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 207 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 332 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 60 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 43 files changed, 4866 insertions(+), 5095 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 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 a353c00..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){return t||n((t={exports:{}}).exports,t),t.exports}};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 8400d42..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'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 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": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,CACb,QAAWC,EACX,QAAWC,EACX,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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..7aa0322 --- /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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 907a31a..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.4.3" - }, - "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/error-tools-fmtprodmsg": "^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..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 5c21748d4ae8f84892ec1e821046cec25e8ba7ec Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 14 Jun 2026 03:33:08 +0000 Subject: [PATCH 132/140] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index b588099..7a45f32 100644 --- a/package.json +++ b/package.json @@ -48,7 +48,7 @@ "@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", + "@stdlib/error-tools-fmtprodmsg": "^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", From 7e6e9cff12cadc70d0e11fbbf2e01d1adbc8cc05 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 14 Jun 2026 03:51:02 +0000 Subject: [PATCH 133/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7aa0322..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -var n={float64:function(n,t,i){n[t]=i},float32: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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 85322b3573ba088d001003a069ded6913fd287ae Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 14 Jun 2026 03:51:20 +0000 Subject: [PATCH 134/140] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 207 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 332 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 309 -- package.json | 60 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 44 files changed, 4866 insertions(+), 5114 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 07c1a9f..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-06-14T03:27:57.500Z 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 99054a0..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(n,t){return function(){try{return t||n((t={exports:{}}).exports,t),t.exports}catch(i){throw (t=0, i)}};};var f=o(function(S,u){ -var e={float64:c,float32:r,int32:s,int16:a,int8:l,uint32:U,uint16:p,uint8:v,uint8c:I,generic:d,default:x};function c(n,t,i){n[t]=i}function r(n,t,i){n[t]=i}function s(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 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=f();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 2dc2102..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'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 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,MAASC,EACT,MAASC,EACT,KAAQC,EACR,OAAUC,EACV,OAAUC,EACV,MAASC,EACT,OAAUC,EACV,QAAWC,EACX,QAAWC,CACZ,EAuBA,SAASV,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,EAAIjB,EAASgB,CAAM,EACvB,OAAK,OAAOC,GAAM,WACVA,EAEDjB,EAAQ,OAChB,CAKAD,EAAO,QAAUgB,IC5QjB,IAAIG,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "SETTERS", "setFloat64", "setFloat32", "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..7aa0322 --- /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},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..7db4979 --- /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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,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 b50fdec..0000000 --- a/lib/main.js +++ /dev/null @@ -1,309 +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, - '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 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 7a45f32..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/error-tools-fmtprodmsg": "^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..47a722a --- /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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From 8531da6401f6ae75a92a976f54dfb838d8a34833 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 22 Jun 2026 22:28:36 +0000 Subject: [PATCH 135/140] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index b588099..7a45f32 100644 --- a/package.json +++ b/package.json @@ -48,7 +48,7 @@ "@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", + "@stdlib/error-tools-fmtprodmsg": "^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", From c6d28785c3f90e4426bbf5422e0dbdc2fd131742 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 22 Jun 2026 22:28:58 +0000 Subject: [PATCH 136/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7aa0322..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -var n={float64:function(n,t,i){n[t]=i},float32: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 deleted file mode 100644 index 7db4979..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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'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 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","int32","int16","int8","uint32","uint16","uint8","uint8c","generic","default","setter","dtype","f"],"mappings":";;AAsBA,IAAIA,EAAU,CACbC,QAkCD,SAAqBC,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAnCCC,QAuDD,SAAqBH,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EAxDCE,MA4ED,SAAmBJ,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EA7ECG,MAiGD,SAAmBL,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAlGCI,KAsHD,SAAkBN,EAAKC,EAAKC,GAC3BF,EAAKC,GAAQC,CACd,EAvHCK,OA2ID,SAAoBP,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA5ICM,OAgKD,SAAoBR,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EAjKCO,MAqLD,SAAmBT,EAAKC,EAAKC,GAC5BF,EAAKC,GAAQC,CACd,EAtLCQ,OA0MD,SAAoBV,EAAKC,EAAKC,GAC7BF,EAAKC,GAAQC,CACd,EA3MCS,QA6ND,SAAqBX,EAAKC,EAAKC,GAC9BF,EAAKC,GAAQC,CACd,EA9NCU,QAgPD,SAAuBZ,EAAKC,EAAKC,GAChCF,EAAKC,GAAQC,CACd,GAsBA,SAASW,EAAQC,GAChB,IAAIC,EAAIjB,EAASgB,GACjB,MAAkB,mBAANC,EACJA,EAEDjB,EAAQc,OAChB"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 47a722a..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 3dc31457a9f95818684b45f631eaeb58fe3c96cb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 22 Jun 2026 22:29:21 +0000 Subject: [PATCH 137/140] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 219 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 332 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 332 -- package.json | 60 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 109 - 43 files changed, 4866 insertions(+), 5148 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 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 7a45f32..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/error-tools-fmtprodmsg": "^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 cc5b101..0000000 --- a/test/test.js +++ /dev/null @@ -1,109 +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 ]; - if ( dt === 'generic' ) { - t.strictEqual( v, i+1, 'returns expected value for dtype: '+dt ); - } else { - t.strictEqual( v, void 0, 'returns expected value for dtype: '+dt ); - } - } - t.end(); -}); - -tape( 'the returned function does not perform bounds checks (unrecognized dtype)', function test( t ) { - var arr; - var 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(); -}); From cc55732c49e1a6e064feb3088d3e241a131f5854 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 22 Jun 2026 22:42:17 +0000 Subject: [PATCH 138/140] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index b588099..7a45f32 100644 --- a/package.json +++ b/package.json @@ -48,7 +48,7 @@ "@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", + "@stdlib/error-tools-fmtprodmsg": "^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", From 5d96cbcdd0a46dc2d7b33223508c124b5b93b4b7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 22 Jun 2026 22:42:39 +0000 Subject: [PATCH 139/140] Remove files --- index.d.ts | 334 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5181 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f6c72c9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,334 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2022 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { Collection } from '@stdlib/types/array'; - -/** -* Sets an element in a `Float64Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat64 = ( arr: Float64Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Float32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetFloat32 = ( arr: Float32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt32 = ( arr: Int32Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt16 = ( arr: Int16Array, idx: number, value: number ) => void; - -/** -* Sets an element in an `Int8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetInt8 = ( arr: Int8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint32Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint32 = ( arr: Uint32Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint16Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint16 = ( arr: Uint16Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8 = ( arr: Uint8Array, idx: number, value: number ) => void; - -/** -* Sets an element in a `Uint8ClampedArray`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetUint8c = ( arr: Uint8ClampedArray, idx: number, value: number ) => void; - -/** -* Sets an element in a generic `Array`. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetGeneric = ( arr: Array, idx: number, value: T ) => void; - -/** -* Sets an element in an indexed array-like object. -* -* @param arr - input array -* @param idx - element index -* @param value - value to set -*/ -type SetArrayLike = ( arr: Collection, idx: number, value: T ) => void; - -/** -* Returns an accessor function for setting an element in a `Float64Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var arr = new Float64Array( 4 ); -* -* var get = setter( 'float64' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float64' ): SetFloat64; - -/** -* Returns an accessor function for setting an element in a `Float32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var arr = new Float32Array( 4 ); -* -* var set = setter( 'float32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3.0 -*/ -declare function setter( dtype: 'float32' ): SetFloat32; - -/** -* Returns an accessor function for setting an element in an `Int32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var arr = new Int32Array( 4 ); -* -* var set = setter( 'int32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int32' ): SetInt32; - -/** -* Returns an accessor function for setting an element in an `Int16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var arr = new Int16Array( 4 ); -* -* var set = setter( 'int16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int16' ): SetInt16; - -/** -* Returns an accessor function for setting an element in an `Int8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var arr = new Int8Array( 4 ); -* -* var set = setter( 'int8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'int8' ): SetInt8; - -/** -* Returns an accessor function for setting an element in a `Uint32Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var arr = new Uint32Array( 4 ); -* -* var set = setter( 'uint32' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint32' ): SetUint32; - -/** -* Returns an accessor function for setting an element in a `Uint16Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var arr = new Uint16Array( 4 ); -* -* var set = setter( 'uint16' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint16' ): SetUint16; - -/** -* Returns an accessor function for setting an element in a `Uint8Array`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var arr = new Uint8Array( 4 ); -* -* var set = setter( 'uint8' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8' ): SetUint8; - -/** -* Returns an accessor function for setting an element in a `Uint8ClampedArray`. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var arr = new Uint8ClampedArray( 4 ); -* -* var set = setter( 'uint8c' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'uint8c' ): SetUint8c; - -/** -* Returns an accessor function for setting an element in a "generic" array. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( 'generic' ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: 'generic' ): SetGeneric; - -/** -* Returns an accessor function for setting an element in an indexed array-like object. -* -* @param dtype - data type -* @returns accessor function -* -* @example -* var dtype = require( '@stdlib/array-dtype' ); -* -* var arr = [ 0, 0, 0, 0 ]; -* -* var set = setter( dtype( arr ) ); -* set( arr, 2, 3 ); -* -* var v = arr[ 2 ]; -* // returns 3 -*/ -declare function setter( dtype: string ): SetArrayLike; - - -// EXPORTS // - -export = setter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 90d5bd0..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -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 deleted file mode 100644 index 96cf1d6..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 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/stats.html b/stats.html deleted file mode 100644 index b49ede8..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 05e6fd8cca9163f193a161a2df2291c069b84120 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 22 Jun 2026 22:43:06 +0000 Subject: [PATCH 140/140] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 220 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 332 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 52 - docs/types/test.ts | 396 -- examples/index.js | 59 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 332 -- package.json | 60 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 105 - 43 files changed, 4866 insertions(+), 5145 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 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 7a45f32..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/error-tools-fmtprodmsg": "^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(); -});